Skip to content

New GCalendarListEntryObj

Spencer Varney edited this page Dec 14, 2016 · 3 revisions

New-GCalendarListEntryObj

SYNOPSIS

Creates a new Calendar API CalendarListEntry object.

SYNTAX

New-GCalendarListEntryObj [[-AccessRole] <String>] [[-BackgroundColor] <String>] [[-ColorId] <String>]
 [[-DefaultReminders] <EventReminder[]>] [[-Deleted] <Boolean>] [[-Description] <String>]
 [[-ForegroundColor] <String>] [[-Hidden] <Boolean>] [[-Id] <String>] [[-Location] <String>]
 [[-NotificationSettings] <NotificationSettingsData>] [[-Primary] <Boolean>] [[-Selected] <Boolean>]
 [[-Summary] <String>] [[-SummaryOverride] <String>] [[-TimeZone] <String>] [-WhatIf] [-Confirm]

DESCRIPTION

This provides a Cmdlet-Based approach to creating a CalendarListEntry object which may be required as a parameter for some other Cmdlets in the Calendar API category.

You could alternately create this object by calling New-Object -TypeName Google.Apis.Calendar.v3.Data.CalendarListEntry

EXAMPLES

---------- EXAMPLE 1 ----------

PS C:\> New-GCalendarListEntryObj

This automatically generated example serves to show the bare minimum required to call this Cmdlet.

Additional examples may be added, viewed and edited by users on the community wiki at the URL found in the related links.

PARAMETERS

-AccessRole

The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:- "freeBusyReader" - Provides read access to free/busy information.- "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.- "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.- "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 0
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-BackgroundColor

The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 1
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ColorId

The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 2
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-DefaultReminders

The default reminders that the authenticated user has for this calendar.

Type: EventReminder[]
Parameter Sets: (All)
Aliases: 

Required: False
Position: 3
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Deleted

Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: 4
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Description

Description of the calendar. Optional. Read-only.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 5
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ForegroundColor

The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 6
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Hidden

Whether the calendar has been hidden from the list. Optional. The default is False.

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: 7
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Id

Identifier of the calendar.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 8
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Location

Geographic location of the calendar as free-form text. Optional. Read-only.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 9
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-NotificationSettings

The notifications that the authenticated user is receiving for this calendar.

Type: NotificationSettingsData
Parameter Sets: (All)
Aliases: 

Required: False
Position: 10
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Primary

Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: 11
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Selected

Whether the calendar content shows up in the calendar UI. Optional. The default is False.

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: 12
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Summary

Title of the calendar. Read-only.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 13
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SummaryOverride

The summary that the authenticated user has set for this calendar. Optional.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 14
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TimeZone

The time zone of the calendar. Optional. Read-only.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 15
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

INPUTS

System.String

The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:- "freeBusyReader" - Provides read access to free/busy information.- "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.- "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.- "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

System.String

The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.

System.String

The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.

Google.Apis.Calendar.v3.Data.EventReminder[]

The default reminders that the authenticated user has for this calendar.

System.Boolean

Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.

System.String

Description of the calendar. Optional. Read-only.

System.String

The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.

System.Boolean

Whether the calendar has been hidden from the list. Optional. The default is False.

System.String

Identifier of the calendar.

System.String

Geographic location of the calendar as free-form text. Optional. Read-only.

Google.Apis.Calendar.v3.Data.CalendarListEntry+NotificationSettingsData

The notifications that the authenticated user is receiving for this calendar.

System.Boolean

Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.

System.Boolean

Whether the calendar content shows up in the calendar UI. Optional. The default is False.

System.String

Title of the calendar. Read-only.

System.String

The summary that the authenticated user has set for this calendar. Optional.

System.String

The time zone of the calendar. Optional. Read-only.

OUTPUTS

Google.Apis.Calendar.v3.Data.CalendarListEntry

NOTES

Part of the gShell Project, relating to the Google Calendar API; see Related Links or use the -Online parameter.

RELATED LINKS

[Wiki page for this Cmdlet]

[Getting started with gShell]

Clone this wiki locally