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

Clear-GCalendar

SYNOPSIS

Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.

SYNTAX

Clear-GCalendar [-CalendarId] <String> [-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>]
 [-WhatIf] [-Confirm]

DESCRIPTION

Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.

EXAMPLES

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

PS C:\> Clear-GCalendar -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.

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

-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.

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