external help file: PSRAW-help.xml Module Name: psraw online version: https://psraw.readthedocs.io/en/latest/Module/Import-RedditOAuthToken schema: 2.0.0
Import-RedditOAuthToken
SYNOPSIS
Imports a RedditOAuthToken object from an XML file and sets it as the session default OAuth Token
SYNTAX
Path (Default)
Import-RedditOAuthToken -Path <String[]> [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
LiteralPath
Import-RedditOAuthToken -LiteralPath <String[]> [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Allows you to import a RedditOAuthToken object from an XML file that was previously exported via Export-RedditOAuthToken sets it as the session default OAuth Token. This allows you to share the same Reddit application between multiple scripts. This function is a wrapper for Import-Clixml.
User Password, Client Secret, Access Token, and Refresh Token stored in the RedditOAuthToken object are stored as secure strings and are not visible as plaintext in the export file. This also means that a RedditOAuthToken object exported by one user cannot be imported by another user on the same computer nor can it be imported by the same user on a different computer. It can only be imported by the same user on the same computer.
The maximum depth will be set on Export-Clixml.
New RedditOAuthToken objects can be created manually or with Request-RedditOAuthToken.
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
Import-RedditOAuthToken -Path 'c:\PSRAW\RedditOAuthToken.xml'
-------------------------- EXAMPLE 3 --------------------------
Import-RedditOAuthToken -LiteralPath 'c:\PSRAW\RedditOAuthToken.xml'
-------------------------- EXAMPLE 4 --------------------------
$Token = Import-RedditOAuthToken -LiteralPath 'c:\PSRAW\RedditOAuthToken.xml' -PassThru
PARAMETERS
-LiteralPath
Specifies the XML files. Unlike Path, the value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell Windows PowerShell not to interpret any characters as escape sequences.
Type: String[]
Parameter Sets: LiteralPath
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PassThru
By default this command does not return any data. When -PassThru is used, the RedditOAuthToken that is imported is passed to the pipeline.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Path
Specifies the XML files.
Type: String[]
Parameter Sets: Path
Aliases:
Required: True
Position: Named
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
System.String[]
OUTPUTS
RedditOAuthToken
NOTES
For complete documentation visit https://psraw.readthedocs.io/
For more information about registering Reddit Apps, Reddit's API, or Reddit OAuth see:
- https://github.com/reddit/reddit/wiki/API
- https://github.com/reddit/reddit/wiki/OAuth2
- https://www.reddit.com/prefs/apps
- https://www.reddit.com/wiki/api
RELATED LINKS
https://psraw.readthedocs.io/en/latest/Module/Import-RedditOAuthToken