Skip to content
Spencer Varney edited this page Dec 27, 2016 · 3 revisions

Set-GCalendarList

SYNOPSIS

Updates an entry on the user's calendar list. This method supports patch semantics.

SYNTAX

Set-GCalendarList [-CalendarId] <String> [[-CalendarListEntryBody] <CalendarListEntry>]
 [[-ColorRgbFormat] <Boolean>] [-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf]
 [-Confirm]

DESCRIPTION

Updates an entry on the user's calendar list. This method supports patch semantics.

EXAMPLES

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

PS C:\> Set-GCalendarList -CalendarId $SomeCalendarIdString -CalendarListEntryBody $SomeCalendarListEntryObj

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

-CalendarId

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

Type: String
Parameter Sets: (All)
Aliases: 

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

-CalendarListEntryBody

A CalendarListEntryBody object

Type: CalendarListEntry
Parameter Sets: (All)
Aliases: 

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

-ColorRgbFormat

Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.

Type: Boolean
Parameter Sets: (All)
Aliases: 

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

-StandardQueryParams

A Standard Query Parameters Object.

Type: StandardQueryParameters
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: 
Accept pipeline input: False
Accept wildcard characters: False

-GAuthId

The GAuthId representing the gShell auth credentials this cmdlet should use to run.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: 
Accept pipeline input: False
Accept wildcard characters: False

INPUTS

System.String

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

Google.Apis.Calendar.v3.Data.CalendarListEntry

A CalendarListEntryBody object

System.Boolean

Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.

OUTPUTS

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