en-US/about_RedditThing.help.txt
|
TOPIC
about_redditthing SHORT DESCRIPTION Describes the RedditThing Class LONG DESCRIPTION This is a meta-class used for objects returned from the reddit API. "Reddit Things" describe what the returned object is, such as a listing, a comment, a submission, a subreddit, a user, etc. The `RedditThing` Class is imported automatically when you import the PSRAW module. CONSTRUCTORS RedditThing() Creates an empty `RedditThing` [RedditThing]::new() PROPERTIES AccessToken The `RedditAccessToken` used to retrieve the reddit thing. Name: AccessToken Type: RedditOAuthToken Hidden: False Static: False Data The "Thing" being returned such as a listing, a comment, a submission, a subreddit, a user, etc. Name: Data Type: System.Management.Automation.PSObject Hidden: False Static: False Id The ID for the object may also be returned with the Reddit Thing meta-data. For Things without ID's (such as a listing), this will be empty. Name: Id Type: String Hidden: False Static: False Kind The `RedditThingKind` that identifies what kind of Reddit Thing this is. Name: Kind Type: RedditThingKind Hidden: False Static: False Name The Reddit Name for the object may also be returned with the Reddit Thing meta-data. For Things without Reddit Names (such as a listing), this will be empty. Name: Name Type: String Hidden: False Static: False Parent If A Reddit Thing was a child of something like a listing, the `Parent` may contain the parent object. Name: Parent Type: System.Management.Automation.PSObject Hidden: False Static: False METHODS EXAMPLES Example 1 [RedditThing]@{ AccessToken = $Token Kind = 'Listing' Data = $Object } SEE ALSO about_RedditThing Invoke-RedditRequest https://github.com/reddit/reddit/wiki/JSON https://www.reddit.com/wiki/api https://psraw.readthedocs.io/ |