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


Set-RedditDefaultOAuthToken

SYNOPSIS

Sets the session default OAuth Token

SYNTAX

Set-RedditDefaultOAuthToken [-AccessToken] <RedditOAuthToken> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

A session default OAuth Token is set by Set-RedditDefaultOAuthToken, Connect-Reddit, Import-RedditOAuthToken, Request-RedditOAuthToken, and Update-RedditOAuthToken (with the -SetDefault parameter) all set the default session OAuth Token. The Get-RedditDefaultOAuthToken can be used to retrieve the current default OAuth Token. Many PSRAW commands require a RedditOAuthToken to authenticate with the Reddit API. The session default OAuth Token is used by those commands so that one does not need to be manually supplied each time.

EXAMPLES

Example 1

PS C:\> $Token | Set-RedditDefaultOAuthToken

Sets $Token as the session default OAuth Token.

PARAMETERS

-AccessToken

The RedditOAuthToken to set as the session default OAuth Token

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

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
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).

INPUTS

RedditOAuthToken

OUTPUTS

System.Void

NOTES

https://psraw.readthedocs.io/en/latest/Module/Set-RedditDefaultOAuthToken

Get-RedditDefaultOAuthToken

Connect-Reddit

Import-RedditOAuthToken

Request-RedditOAuthToken

Update-RedditOAuthToken

https://psraw.readthedocs.io/