Clear-GSTasklist¶
SYNOPSIS¶
Clears all completed tasks from the specified task list. The affected tasks will be marked as 'hidden' and no longer be returned by default when retrieving all tasks for a task list
SYNTAX¶
Clear-GSTasklist [-Tasklist] <String[]> [[-User] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION¶
Clears all completed tasks from the specified task list. The affected tasks will be marked as 'hidden' and no longer be returned by default when retrieving all tasks for a task list
EXAMPLES¶
EXAMPLE 1¶
Clear-GSTasklist -Tasklist 'MTA3NjIwMjA1NTEzOTk0MjQ0OTk6NTMyNDY5NDk1NDM5MzMxO' -Confirm:$false
Clears the specified Tasklist owned by the AdminEmail user and skips the confirmation check
PARAMETERS¶
-Tasklist¶
The unique Id of the Tasklist to clear
Type: String[] Parameter Sets: (All) Aliases: Id Required: True Position: 1 Default value: None Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False
-User¶
The User who owns the Tasklist.
Defaults to the AdminUser's email.
Type: String Parameter Sets: (All) Aliases: PrimaryEmail, UserKey, Mail, Email Required: False Position: 2 Default value: $Script:PSGSuite.AdminEmail Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False
-Confirm¶
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter Parameter Sets: (All) Aliases: cf Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False
-WhatIf¶
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter Parameter Sets: (All) Aliases: wi Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False
CommonParameters¶
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.