external help file: PSRAW-help.xml Module Name: psraw online version: https://psraw.readthedocs.io/en/latest/Module/Update-RedditOAuthToken schema: 2.0.0

Update-RedditOAuthToken

SYNOPSIS

Refresh a RedditOAuthToken

SYNTAX

Update-RedditOAuthToken [-AccessToken <RedditOAuthToken[]>] [-Force] [-PassThru] [-SetDefault] [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION

When a RedditOAuthToken Token has expired, Update-RedditOAuthTokencan be used to refresh the Access Token. Depending on the grant method used to request the RedditOAuthToken with Request-RedditOAuthToken, either a refresh will be performed or a new grant flow will be initiated.

EXAMPLES

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

Update-RedditOAuthToken

Updates the session default OAuth Token

-------------------------- EXAMPLE 12--------------------------

$Token | Update-RedditOAuthToken

Updates the passed OAuth Token.

-------------------------- EXAMPLE 3 --------------------------

$Token | Update-RedditOAuthToken -Force

This example demonstrates using the -Force parameter for initiate a token refresh on a token that has not yet expired.

-------------------------- EXAMPLE 2 --------------------------

$NewExpireDate = $Token | Update-RedditOAuthToken -PassThru | Select-Object -Expand ExpireDate

This example demonstrates using the -PassThru parameter to send the updated RedditOAuthToken to the pipeline. The ExpireDate property is then expanded and stored in $NewExpireDate.

PARAMETERS

-AccessToken

The RedditOAuthToken containing the Access Token to refresh. Multiple RedditOAuthToken objects can be supplied.

Type: RedditOAuthToken[]
Parameter Sets: (All)
Aliases: Token

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

-Force

By default, this function will ignore any RedditOAuthToken which is not yet expired. -Force will override that behavior and perform a refresh request.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-PassThru

By default, this function does not return any data. The -PassThru parameter will place the updated RedditOAuthToken into the output stream to either be stored in another variable or placed in the pipeline and consumed by other functions.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-SetDefault

If set, the updated token will be set as the session default OAuth Token

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
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 (http://go.microsoft.com/fwlink/?LinkID=113216).