-
Notifications
You must be signed in to change notification settings - Fork 10
Get GCalendarList
Returns an entry on the user's calendar list.
Get-GCalendarList [-CalendarId] <String> [-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>]
[-WhatIf] [-Confirm]
Get-GCalendarList [-All] [[-MaxResults] <Int32>] [[-MinAccessRole] <MinAccessRoleEnum>]
[[-ShowDeleted] <Boolean>] [[-ShowHidden] <Boolean>] [[-SyncToken] <String>]
[-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf] [-Confirm]
Returns an entry on the user's calendar list.
PS C:\> Get-GCalendarList -CalendarId $SomeCalendarIdString
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.
PS C:\> Get-GCalendarList -All
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.
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: one
Aliases:
Required: True
Position: 0
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseA switch to list all results
Type: SwitchParameter
Parameter Sets: list
Aliases:
Required: True
Position: 0
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseMaximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
Type: Int32
Parameter Sets: list
Aliases:
Required: False
Position: 1
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe minimum access role for the user in the returned entries. Optional. The default is no restriction.
Possible values: FreeBusyReader, Owner, Reader, Writer
Type: MinAccessRoleEnum
Parameter Sets: list
Aliases:
Accepted values: FreeBusyReader, Owner, Reader, Writer
Required: False
Position: 2
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseWhether to include deleted calendar list entries in the result. Optional. The default is False.
Type: Boolean
Parameter Sets: list
Aliases:
Required: False
Position: 3
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseWhether to show hidden entries. Optional. The default is False.
Type: Boolean
Parameter Sets: list
Aliases:
Required: False
Position: 4
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseToken obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False.To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken.If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.Learn more about incremental synchronization.Optional. The default is to return all entries.
Type: String
Parameter Sets: list
Aliases:
Required: False
Position: 5
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseA Standard Query Parameters Object.
Type: StandardQueryParameters
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value:
Accept pipeline input: False
Accept wildcard characters: FalseThe 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: FalseCalendar 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.
Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
The minimum access role for the user in the returned entries. Optional. The default is no restriction.
Whether to include deleted calendar list entries in the result. Optional. The default is False.
Whether to show hidden entries. Optional. The default is False.
Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False.To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken.If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.Learn more about incremental synchronization.Optional. The default is to return all entries.
Part of the gShell Project, relating to the Google Calendar API; see Related Links or use the -Online parameter.
News - Get Started - Cmdlet Index - FAQ - Discussion - Downloads