external help file: PSRAW-help.xml Module Name: PSRAW online version: https://psraw.readthedocs.io/en/latest/Module/Resolve-RedditdataObject schema: 2.0.0
Resolve-RedditDataObject
SYNOPSIS
Resolves a RedditDataObject from another object (experimental)
SYNTAX
RedditAPIResponse
Resolve-RedditDataObject [-RedditApiResponse] <RedditApiResponse> [-WhatIf] [-Confirm] [<CommonParameters>]
RedditThing
Resolve-RedditDataObject [-RedditThing] <RedditThing> [-WhatIf] [-Confirm] [<CommonParameters>]
PSObject
Resolve-RedditDataObject [-PSObject] <PSObject> [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
This function is used to return the appropriate RedditDataObject (i.e. RedditComment) from various objects. This is used to raise a RedditDataObject up from the RedditThing meta-class that Reddit uses to encapsulate all objects such as comments, links, subreddits, lists, and mores. It is made public due to implementation limitations, but is not intended for public consumption. Do not call this function directly.
EXAMPLES
Example 1
$Response = Invoke-RedditRequest -uri $uri
$RedditComment = Resolve-RedditDataObject -RedditAPIResponse $Response
Assuming $uri is a comment endpoint, this will convert the response from Invoke-RedditRequest into a RedditComment object.
Example 2
$Response = Invoke-RedditRequest -uri $uri
$RedditComment = Resolve-RedditDataObject -PSObject $Response.ContentObject
Assuming $uri is a comment endpoint, this will convert the ContentObject from Invoke-RedditRequest into a RedditComment object.
Example 2
$Response = Invoke-RedditRequest -uri $uri
$RedditThing = [RedditThing]$Response.ContentObject
$RedditComment = Resolve-RedditDataObject -RedditThing $RedditThing
Converting a RedditThing into a RedditComment.
PARAMETERS
-PSObject
A PSObject of a Thing returned from the Reddit API and converted from JSON.
Type: PSObject
Parameter Sets: PSObject
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-RedditApiResponse
A RedditApiResponse object returned from Invoke-RedditRequest
Type: RedditApiResponse
Parameter Sets: RedditAPIResponse
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-RedditThing
An existing RedditThing object.
Type: RedditThing
Parameter Sets: RedditThing
Aliases:
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
RedditApiResponse
RedditThing
System.Management.Automation.PSObject
OUTPUTS
RedditDataObject
NOTES
Experimental: This is an experimental feature. Expect radical changes between versions. Do not write production code against this until it has been marked stable.
RELATED LINKS
https://psraw.readthedocs.io/en/latest/Module/Resolve-RedditDataObject