RedditLink
about_RedditLink
SHORT DESCRIPTION
Describes the RedditLink Class (experimental)
LONG DESCRIPTION
Represents a Reddit Link which can be either a Self-Post or a Link posted to a Subreddit.
Constructors
RedditLink()
Creates an Empty RedditLink
object.
[RedditLink]::new()
RedditLink(RedditThing RedditThing)
Creates a RedditLink
from a RedditThing
representing a reddit Link returned from the API.
[RedditLink]::new([RedditThing]$RedditThing)
Properties
ApiEndpointUri
The API endpoint url template used to generate the the API endpoint where the Link can be retrieved.
Name: ApiEndpointUri
Type: String
Hidden: False
Static: True
approved_at_utc
The UTC time the link was approved by a moderator.
Name: approved_at_utc
Type: RedditDate
Hidden: False
Static: False
approved_by
The Moderator who approved the link.
Name: approved_by
Type: String
Hidden: False
Static: False
archived
If true, the link has been archived.
Name: archived
Type: Boolean
Hidden: False
Static: False
author
The Reddit username of the author of the link.
Name: author
Type: String
Hidden: False
Static: False
author_flair_css_class
The flair CSS class for the author
Name: author_flair_css_class
Type: String
Hidden: False
Static: False
author_flair_text
The text for the author's flair.
Name: author_flair_text
Type: String
Hidden: False
Static: False
banned_at_utc
The UTC time the link was banned by a moderator.
Name: banned_at_utc
Type: RedditDate
Hidden: False
Static: False
banned_by
The username of the moderator who banned the link.
Name: banned_by
Type: String
Hidden: False
Static: False
brand_safe
This is true if Reddit has determined the subreddit the Link was posted in is safe for advertising.
Name: brand_safe
Type: Boolean
Hidden: False
Static: False
can_gild
Whether or not this link can be "gilded" by giving the link author Reddit Gold.
Name: can_gild
Type: Boolean
Hidden: False
Static: False
can_mod_post
Unknown
Name: can_mod_post
Type: Boolean
Hidden: False
Static: False
clicked
Whether or not the link has been clicked by the user.
Name: clicked
Type: Boolean
Hidden: False
Static: False
contest_mode
If true, the link has been set to Contest mode. https://www.reddit.com/r/bestof2012/comments/159bww/introducing_contest_mode_a_tool_for_your_voting/
Name: contest_mode
Type: Boolean
Hidden: False
Static: False
created
The localized time the link was created
Name: created
Type: RedditDate
Hidden: False
Static: False
created_utc
The UTC time the link was created
Name: created_utc
Type: RedditDate
Hidden: False
Static: False
distinguished
Whether or not the link has been distinguished by a moderator.
Name: distinguished
Type: String
Hidden: False
Static: False
domain
The domain of the URL the link was submitted for.
Name: domain
Type: String
Hidden: False
Static: False
downs
Number of DownVotes
Name: downs
Type: Int64
Hidden: False
Static: False
edited
The UNIX Time stamp the link has been edited or false
Name: edited
Type: Decimal
Hidden: False
Static: False
gilded
The number of times the link has been gilded.
Name: gilded
Type: Int64
Hidden: False
Static: False
hidden
Whether or not the link has been hidden by the user.
Name: hidden
Type: Boolean
Hidden: False
Static: False
hide_score
Whether or not the score is hidden.
Name: hide_score
Type: Boolean
Hidden: False
Static: False
id
The ID of the link submission.
Name: id
Type: String
Hidden: False
Static: False
is_self
Whether or not the link is a self-post.
Name: is_self
Type: Boolean
Hidden: False
Static: False
is_video
Whether or not the link is a video post.
Name: is_video
Type: Boolean
Hidden: False
Static: False
likes
Whether the user likes (upvoted) the link or not
Name: likes
Type: Boolean
Hidden: False
Static: False
link_flair_css_class
The CSS for the link's flair
Name: link_flair_css_class
Type: String
Hidden: False
Static: False
link_flair_text
The text for the link's flair.
Name: link_flair_text
Type: String
Hidden: False
Static: False
locked
Whether or not the link has been locked.
Name: locked
Type: Boolean
Hidden: False
Static: False
media
An object containing information about the media in media posts.
Name: media
Type: System.Management.Automation.PSObject
Hidden: False
Static: False
media_embed
Object containing information about the embedded media in media posts.
Name: media_embed
Type: System.Management.Automation.PSObject
Hidden: False
Static: False
mod_reports
An array of reports made by Moderators on this link.
Name: mod_reports
Type: RedditModReport[]
Hidden: False
Static: False
name
The reddit Fullname of the link.
Name: name
Type: String
Hidden: False
Static: False
num_comments
The number of comments the link has.
Name: num_comments
Type: Int64
Hidden: False
Static: False
num_reports
The number of reports the link has.
Name: num_reports
Type: Int64
Hidden: False
Static: False
over_18
Whether or not the link is NSFW.
Name: over_18
Type: Boolean
Hidden: False
Static: False
parent_whitelist_status
Unknown
Name: parent_whitelist_status
Type: String
Hidden: False
Static: False
ParentObject
The Parent Object of this Link. It may be a listing or the API response.
Name: ParentObject
Type: System.Management.Automation.PSObject
Hidden: False
Static: False
permalink
The permalink to link.
Name: permalink
Type: String
Hidden: False
Static: False
Prefix
The prefix of the Reddit Thing this should always be t3
Name: Prefix
Type: RedditThingPrefix
Hidden: False
Static: False
quarantine
Whether or not the link has been quarantined.
Name: quarantine
Type: Boolean
Hidden: False
Static: False
RedditThingKind
The Kind of Reddit Thing. this should always be t3
Name: RedditThingKind
Type: RedditThingKind
Hidden: False
Static: True
removal_reason
The reason the link was removed by a moderator.
Name: removal_reason
Type: String
Hidden: False
Static: False
report_reasons
Reasons the link has been reported.
Name: report_reasons
Type: String[]
Hidden: False
Static: False
saved
Whether or not the user has saved the link.
Name: saved
Type: Boolean
Hidden: False
Static: False
score
The score of the link
Name: score
Type: Int64
Hidden: False
Static: False
secure_media
An object containing information about the secure media in a media post.
Name: secure_media
Type: System.Management.Automation.PSObject
Hidden: False
Static: False
secure_media_embed
Object containing information about the secure embedded media in a media post.
Name: secure_media_embed
Type: System.Management.Automation.PSObject
Hidden: False
Static: False
selftext
The text of a self-post.
Name: selftext
Type: String
Hidden: False
Static: False
selftext_html
The HTML version of the text in a self-post.
Name: selftext_html
Type: String
Hidden: False
Static: False
spoiler
Whether or not the link has been marked as a spoiler.
Name: spoiler
Type: Boolean
Hidden: False
Static: False
stickied
Whether or not a mod as stickied the post in the subreddit.
Name: stickied
Type: Boolean
Hidden: False
Static: False
subreddit
The name of the subreddit the link was posted in (without the prefix)
Name: subreddit
Type: String
Hidden: False
Static: False
subreddit_id
The Reddit Fullname of the subreddit
Name: subreddit_id
Type: String
Hidden: False
Static: False
subreddit_name_prefixed
The name of the subreddit prefixed with r/
Name: subreddit_name_prefixed
Type: String
Hidden: False
Static: False
subreddit_type
The type of subreddit (public, restricted, etc)
Name: subreddit_type
Type: String
Hidden: False
Static: False
suggested_sort
The suggested sort order for comments made to the link.
Name: suggested_sort
Type: System.Management.Automation.PSObject
Hidden: False
Static: False
thumbnail
Full url to the thumbnail for the post.
Name: thumbnail
Type: String
Hidden: False
Static: False
title
The title of the link post.
Name: title
Type: String
Hidden: False
Static: False
ups
The number of upvotes
Name: ups
Type: Int64
Hidden: False
Static: False
upvote_ratio
The ratio of upvotes to all votes.
Name: upvote_ratio
Type: Double
Hidden: False
Static: False
url
The url of the link.
Name: url
Type: Uri
Hidden: False
Static: False
user_reports
An array of reports made by users against the link.
Name: user_reports
Type: RedditUserReport[]
Hidden: False
Static: False
view_count
The times the link has been viewed
Name: view_count
Type: int64
Hidden: False
Static: False
visited
Whether or not the user has visited the link.
Name: visited
Type: Boolean
Hidden: False
Static: False
whitelist_status
unknown
Name: whitelist_status
Type: String
Hidden: False
Static: False
Methods
GetApiEndpointUri()
Returns the API endpoint for the current instance.
Name: GetApiEndpointUri
Return Type: String
Hidden: False
Static: False
Definition: String GetApiEndpointUri()
GetFullName()
Returns the Reddit Fullname for the current instance.
Name: GetFullName
Return Type: String
Hidden: False
Static: False
Definition: String GetFullName()
ToString()
Overrides ToString()
to return the subreddit, author, and link title.
Name: ToString
Return Type: String
Hidden: False
Static: False
Definition: String ToString()
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.
DERIVED FROM
SEE ALSO
https://www.reddit.com/wiki/api