Controller class for flairs. More...

Inheritance diagram for Reddit.Controllers.Flairs:

Public Member Functions

Flairs (Dispatch dispatch, string subreddit)

Create a new instance of the flairs controller. More...

void ClearLinkFlairTemplates ()

Clear link flair templates. More...

async Task ClearLinkFlairTemplatesAsync ()

Clear link flair templates asynchronously. More...

void ClearUserFlairTemplates ()

Clear user flair templates. More...

async Task ClearUserFlairTemplatesAsync ()

Clear user flair templates asynchronously. More...

void DeleteFlair (string username)

Delete flair. More...

async Task DeleteFlairAsync (string username)

Delete flair asynchronously. More...

void DeleteFlairTemplate (string flairTemplateId)

Delete flair template. More...

async Task DeleteFlairTemplateAsync (string flairTemplateId)

Delete flair template asynchronously.

Parameters

flairTemplateId The ID of the flair template being deleted (e.g. "0778d5ec-db43-11e8-9258-0e3a02270976")

More...

void CreateLinkFlair (FlairSelectFlairInput flairSelectFlairInput)

Create a new link flair. More...

async Task CreateLinkFlairAsync (FlairSelectFlairInput flairSelectFlairInput)

Create a new link flair asynchronously. More...

void CreateUserFlair (string username, string text, string cssClass="")

Create a new user flair. More...

async Task CreateUserFlairAsync (string username, string text, string cssClass="")

Create a new user flair asynchronously. More...

void CreateUserFlair (FlairCreateInput flairCreateInput)

Create a new user flair. More...

async Task CreateUserFlairAsync (FlairCreateInput flairCreateInput)

Create a new user flair asynchronously. More...

void FlairConfig (FlairConfigInput flairConfigInput)

Update the flair configuration settings for this subreddit. More...

async Task FlairConfigAsync (FlairConfigInput flairConfigInput)

Update the flair configuration settings for this subreddit asynchronously. More...

List< ActionResult > FlairCSV (string flairCsv)

Change the flair of multiple users in the same subreddit with a single API call. Requires a string 'flair_csv' which has up to 100 lines of the form 'user,flairtext,cssclass' (Lines beyond the 100th are ignored). If both cssclass and flairtext are the empty string for a given user, instead clears that user's flair. Returns an array of objects indicating if each flair setting was applied, or a reason for the failure. More...

async Task< List< ActionResult > > FlairCSVAsync (string flairCsv)

Asynchronously change the flair of multiple users in the same subreddit with a single API call. Requires a string 'flair_csv' which has up to 100 lines of the form 'user,flairtext,cssclass' (Lines beyond the 100th are ignored). If both cssclass and flairtext are the empty string for a given user, instead clears that user's flair. Returns an array of objects indicating if each flair setting was applied, or a reason for the failure. More...

List< ActionResult > FlairCSV (FlairListResultContainer flairCsv)

Change the flair of multiple users in the same subreddit with a single API call. If both cssclass and flairtext are the empty string for a given user, instead clears that user's flair. Returns an array of objects indicating if each flair setting was applied, or a reason for the failure. More...

async Task< List< ActionResult > > FlairCSVAsync (FlairListResultContainer flairCsv)

Asynchronously change the flair of multiple users in the same subreddit with a single API call. If both cssclass and flairtext are the empty string for a given user, instead clears that user's flair. Returns an array of objects indicating if each flair setting was applied, or a reason for the failure. More...

List< ActionResult > FlairCSV (List< FlairListResult > flairCsv)

Change the flair of multiple users in the same subreddit with a single API call. If both cssclass and flairtext are the empty string for a given user, instead clears that user's flair. Returns an array of objects indicating if each flair setting was applied, or a reason for the failure. More...

async Task< List< ActionResult > > FlairCSVAsync (List< FlairListResult > flairCsv)

Asynchronously change the flair of multiple users in the same subreddit with a single API call. If both cssclass and flairtext are the empty string for a given user, instead clears that user's flair. Returns an array of objects indicating if each flair setting was applied, or a reason for the failure. More...

List< FlairListResult > GetFlairList (string username="", int limit=25, string after="", string before="", int count=0, string show="all", bool srDetail=false)

List of flairs. More...

List< FlairListResult > GetFlairList (FlairNameListingInput flairNameListingInput)

List of flairs. More...

FlairSelectorResultContainer FlairSelector (string username=null, string link=null)

Return information about a user's or link's flair options. More...

void CreateLinkFlairTemplate (string text, bool textEditable=false, string cssClass="")

Create a new link flair template. More...

async Task CreateLinkFlairTemplateAsync (string text, bool textEditable=false, string cssClass="")

Create a new link flair template asynchronously. More...

void CreateLinkFlairTemplate (FlairTemplateInput flairTemplateInput)

Create a new link flair template. More...

async Task CreateLinkFlairTemplateAsync (FlairTemplateInput flairTemplateInput)

Create a new link flair template asynchronously. More...

void CreateUserFlairTemplate (string text, bool textEditable=false, string cssClass="")

Create a new user flair template. More...

async Task CreateUserFlairTemplateAsync (string text, bool textEditable=false, string cssClass="")

Create a new user flair template asynchronously. More...

void CreateUserFlairTemplate (FlairTemplateInput flairTemplateInput)

Create a new user flair template. More...

async Task CreateUserFlairTemplateAsync (FlairTemplateInput flairTemplateInput)

Create a new user flair template asynchronously. More...

void UpdateLinkFlairTemplate (string flairTemplateId, string text=null, bool? textEditable=null, string cssClass=null)

Update an existing link flair template. More...

async Task UpdateLinkFlairTemplateAsync (string flairTemplateId, string text, bool textEditable=false, string cssClass="")

Update an existing link flair template asynchronously. More...

void UpdateLinkFlairTemplate (FlairTemplateInput flairTemplateInput)

Update an existing link flair template. More...

async Task UpdateLinkFlairTemplateAsync (FlairTemplateInput flairTemplateInput)

Update an existing link flair template asynchronously. More...

void UpdateUserFlairTemplate (string flairTemplateId, string text=null, bool? textEditable=null, string cssClass=null)

Update an existing user flair template. More...

async Task UpdateUserFlairTemplateAsync (string flairTemplateId, string text, bool textEditable=false, string cssClass="")

Update an existing user flair template asynchronously. More...

void UpdateUserFlairTemplate (FlairTemplateInput flairTemplateInput)

Update an existing user flair template. More...

async Task UpdateUserFlairTemplateAsync (FlairTemplateInput flairTemplateInput)

Update an existing user flair template asynchronously. More...

FlairV2 CreateLinkFlairTemplateV2 (string text, bool textEditable=false, string textColor="dark", string backgroundColor="#EEEEFF", bool modOnly=false)

Create a new link flair template. This new endpoint is primarily used for the redesign. More...

async Task< FlairV2 > CreateLinkFlairTemplateV2Async (string text, bool textEditable=false, string textColor="dark", string backgroundColor="#EEEEFF", bool modOnly=false)

Create a new link flair template asynchronously. This new endpoint is primarily used for the redesign. More...

FlairV2 CreateLinkFlairTemplateV2 (FlairTemplateV2Input flairTemplateV2Input)

Create a new link flair template. This new endpoint is primarily used for the redesign. More...

async Task< FlairV2 > CreateLinkFlairTemplateV2Async (FlairTemplateV2Input flairTemplateV2Input)

Create a new link flair template asynchronously. This new endpoint is primarily used for the redesign. More...

FlairV2 CreateUserFlairTemplateV2 (string text, bool textEditable=false, string textColor="dark", string backgroundColor="#EEEEFF", bool modOnly=false)

Create a new user flair template. This new endpoint is primarily used for the redesign. More...

async Task< FlairV2 > CreateUserFlairTemplateV2Async (string text, bool textEditable=false, string textColor="dark", string backgroundColor="#EEEEFF", bool modOnly=false)

Create a new user flair template asynchronously. This new endpoint is primarily used for the redesign. More...

FlairV2 CreateUserFlairTemplateV2 (FlairTemplateV2Input flairTemplateV2Input)

Create a new user flair template asynchronously. This new endpoint is primarily used for the redesign. More...

async Task< FlairV2 > CreateUserFlairTemplateV2Async (FlairTemplateV2Input flairTemplateV2Input)

Create a new user flair template asynchronously. This new endpoint is primarily used for the redesign. More...

FlairV2 UpdateLinkFlairTemplateV2 (string flairTemplateId, string text=null, bool? textEditable=null, string textColor=null, string backgroundColor=null, bool? modOnly=null)

Update an existing link flair template. This new endpoint is primarily used for the redesign. More...

async Task< FlairV2 > UpdateLinkFlairTemplateV2Async (string flairTemplateId, string text=null, bool? textEditable=null, string textColor=null, string backgroundColor=null, bool? modOnly=null)

Update an existing link flair template asynchronously. This new endpoint is primarily used for the redesign. More...

FlairV2 UpdateLinkFlairTemplateV2 (FlairTemplateV2Input flairTemplateV2Input)

Update an existing link flair template. This new endpoint is primarily used for the redesign. More...

async Task< FlairV2 > UpdateLinkFlairTemplateV2Async (FlairTemplateV2Input flairTemplateV2Input)

Update an existing link flair template asynchronously. This new endpoint is primarily used for the redesign. More...

FlairV2 UpdateUserFlairTemplateV2 (string flairTemplateId, string text=null, bool? textEditable=null, string textColor=null, string backgroundColor=null, bool? modOnly=null)

Update an existing user flair template. This new endpoint is primarily used for the redesign. More...

async Task< FlairV2 > UpdateUserFlairTemplateV2Async (string flairTemplateId, string text=null, bool? textEditable=null, string textColor=null, string backgroundColor=null, bool? modOnly=null)

Update an existing user flair template asynchronously. This new endpoint is primarily used for the redesign. More...

FlairV2 UpdateUserFlairTemplateV2 (FlairTemplateV2Input flairTemplateV2Input)

Update an existing user flair template. This new endpoint is primarily used for the redesign. More...

async Task< FlairV2 > UpdateUserFlairTemplateV2Async (FlairTemplateV2Input flairTemplateV2Input)

Update an existing user flair template asynchronously. This new endpoint is primarily used for the redesign. More...

void SetFlairEnabled (bool flairEnabled=true)

Set flair enabled. More...

async Task SetFlairEnabledAsync (bool flairEnabled=true)

Set flair enabled asynchronously. More...

List< Flair > GetLinkFlair ()

Return list of available link flair for the current subreddit. Will not return flair if the user cannot set their own link flair and they are not a moderator that can set flair. More...

List< FlairV2 > GetLinkFlairV2 ()

Return list of available link flair for the current subreddit. Will not return flair if the user cannot set their own link flair and they are not a moderator that can set flair. More...

List< Flair > GetUserFlair ()

Return list of available user flair for the current subreddit. Will not return flair if flair is disabled on the subreddit, the user cannot set their own flair, or they are not a moderator that can set flair. More...

List< FlairV2 > GetUserFlairV2 ()

Return list of available user flair for the current subreddit. Will not return flair if flair is disabled on the subreddit, the user cannot set their own flair, or they are not a moderator that can set flair. More...

Public Member Functions inherited from Reddit.Controllers.BaseController

BaseController ()

Create a new Controller instance. More...

Public Member Functions inherited from Reddit.Controllers.Internal.Validators

Exception BuildException (Exception ex, List< List< string >> errors)

dynamic Validate (dynamic obj)

GenericContainer Validate (GenericContainer genericContainer)

Generic Validate (Generic generic)

DynamicShortListingContainer Validate (DynamicShortListingContainer dynamicShortListingContainer)

DynamicShortListingData Validate (DynamicShortListingData dynamicShortListingData)

ImageUploadResult Validate (ImageUploadResult imageUploadResult)

LiveUpdateEventContainer Validate (LiveUpdateEventContainer liveUpdateEventContainer)

LiveThreadCreateResultContainer Validate (LiveThreadCreateResultContainer liveThreadCreateResultContainer)

LiveUpdateContainer Validate (LiveUpdateContainer liveUpdateContainer, int? minChildren=null)

SubredditSettingsContainer Validate (SubredditSettingsContainer subredditSettingsContainer)

SubredditSettings Validate (SubredditSettings subredditSettings)

List< ActionResult > Validate (List< ActionResult > actionResults)

ActionResult Validate (ActionResult actionResult)

FlairListResultContainer Validate (FlairListResultContainer flairListResultContainer)

Flair Validate (Flair flair)

FlairV2 Validate (FlairV2 flairV2)

ModActionContainer Validate (ModActionContainer modActionContainer)

ModActionData Validate (ModActionData modActionData)

WikiPageRevisionContainer Validate (WikiPageRevisionContainer wikiPageRevisionContainer)

WikiPageRevisionData Validate (WikiPageRevisionData wikiPageRevisionData)

WikiPageSettingsContainer Validate (WikiPageSettingsContainer wikiPageSettingsContainer)

WikiPageSettings Validate (WikiPageSettings wikiPageSettings)

List< UserPrefsContainer > Validate (List< UserPrefsContainer > userPrefsContainers)

UserPrefsContainer Validate (UserPrefsContainer userPrefsContainer)

UserPrefsData Validate (UserPrefsData userPrefsData)

PostResultShortContainer Validate (PostResultShortContainer postResultShortContainer)

PostResultShort Validate (PostResultShort postResultShort)

PostResultContainer Validate (PostResultContainer postResultContainer)

PostResult Validate (PostResult postResult)

JQueryReturn Validate (JQueryReturn jQueryReturn)

List<(PostContainer, CommentContainer)> Validate (List<(PostContainer, CommentContainer)> ps)

CommentResultContainer Validate (CommentResultContainer commentResultContainer)

SubredditContainer Validate (SubredditContainer subredditContainer)

Properties
List< FlairListResult >?	FlairList `[get, set]`
	List of flairs. More...

string	FlairListNext `[get]`
	Fullname of the next page of flair list results. More...

string	FlairListPrev `[get]`
	Fullname of the previous page of flair list results. More...

List< Flair >?	LinkFlair `[get, set]`
	List of link flairs. More...

List< FlairV2 >?	LinkFlairV2 `[get, set]`
	List of link flairs. More...

List< Flair >?	UserFlair `[get, set]`
	List of user flairs. More...

List< FlairV2 >?	UserFlairV2 `[get, set]`
	List of user flairs. More...

Properties inherited from Reddit.Controllers.BaseController
Lists	Lists `[get, set]`
	List-handling. More...

Additional Inherited Members
Protected Member Functions inherited from Reddit.Controllers.Internal.Validators
void	CheckErrors (List< List< string >> errors)

void	CheckErrors (List< string > errors)

void	CheckNull (object res, string msg="Reddit API returned null response.")

Detailed Description

Controller class for flairs.

Constructor & Destructor Documentation

◆ Flairs()

Reddit.Controllers.Flairs.Flairs	(	Dispatch	dispatch,
		string	subreddit
	)

Create a new instance of the flairs controller.

Parameters

subreddit	The name of the subreddit with the flairs
dispatch

Member Function Documentation

◆ ClearLinkFlairTemplates()

void Reddit.Controllers.Flairs.ClearLinkFlairTemplates ( )

Clear link flair templates.

◆ ClearLinkFlairTemplatesAsync()

async Task Reddit.Controllers.Flairs.ClearLinkFlairTemplatesAsync ( )

Clear link flair templates asynchronously.

◆ ClearUserFlairTemplates()

void Reddit.Controllers.Flairs.ClearUserFlairTemplates ( )

Clear user flair templates.

◆ ClearUserFlairTemplatesAsync()

async Task Reddit.Controllers.Flairs.ClearUserFlairTemplatesAsync ( )

Clear user flair templates asynchronously.

◆ CreateLinkFlair()

void Reddit.Controllers.Flairs.CreateLinkFlair ( FlairSelectFlairInput flairSelectFlairInput )

Create a new link flair.

Parameters

flairSelectFlairInput a valid FlairSelectFlairInput instance

◆ CreateLinkFlairAsync()

async Task Reddit.Controllers.Flairs.CreateLinkFlairAsync ( FlairSelectFlairInput flairSelectFlairInput )

Create a new link flair asynchronously.

Parameters

flairSelectFlairInput a valid FlairSelectFlairInput instance

◆ CreateLinkFlairTemplate() [1/2]

void Reddit.Controllers.Flairs.CreateLinkFlairTemplate ( FlairTemplateInput flairTemplateInput )

Create a new link flair template.

Parameters

flairTemplateInput A valid FlairTemplateInput instance

◆ CreateLinkFlairTemplate() [2/2]

void Reddit.Controllers.Flairs.CreateLinkFlairTemplate	(	string	text,
		bool	textEditable = `false`,
		string	cssClass = `""`
	)

Create a new link flair template.

Parameters

text	a string no longer than 64 characters
textEditable	boolean value
cssClass	a valid subreddit image name

◆ CreateLinkFlairTemplateAsync() [1/2]

async Task Reddit.Controllers.Flairs.CreateLinkFlairTemplateAsync ( FlairTemplateInput flairTemplateInput )

Create a new link flair template asynchronously.

Parameters

flairTemplateInput A valid FlairTemplateInput instance

◆ CreateLinkFlairTemplateAsync() [2/2]

async Task Reddit.Controllers.Flairs.CreateLinkFlairTemplateAsync	(	string	text,
		bool	textEditable = `false`,
		string	cssClass = `""`
	)

Create a new link flair template asynchronously.

Parameters

text	a string no longer than 64 characters
textEditable	boolean value
cssClass	a valid subreddit image name

◆ CreateLinkFlairTemplateV2() [1/2]

FlairV2 Reddit.Controllers.Flairs.CreateLinkFlairTemplateV2 ( FlairTemplateV2Input flairTemplateV2Input )

Create a new link flair template. This new endpoint is primarily used for the redesign.

Parameters

flairTemplateV2Input A valid FlairTemplateV2Input instance

Returns: The created flair object.

◆ CreateLinkFlairTemplateV2() [2/2]

FlairV2 Reddit.Controllers.Flairs.CreateLinkFlairTemplateV2	(	string	text,
		bool	textEditable = `false`,
		string	textColor = `"dark"`,
		string	backgroundColor = `"#EEEEFF"`,
		bool	modOnly = `false`
	)

Create a new link flair template. This new endpoint is primarily used for the redesign.

Parameters

text	a string no longer than 64 characters
textEditable	boolean value
textColor	one of (light, dark)
backgroundColor	a 6-digit rgb hex color, e.g. #AABBCC
modOnly	boolean value

Returns: The created flair object.

◆ CreateLinkFlairTemplateV2Async() [1/2]

async Task<FlairV2> Reddit.Controllers.Flairs.CreateLinkFlairTemplateV2Async ( FlairTemplateV2Input flairTemplateV2Input )

Create a new link flair template asynchronously. This new endpoint is primarily used for the redesign.

Parameters

flairTemplateV2Input A valid FlairTemplateV2Input instance

◆ CreateLinkFlairTemplateV2Async() [2/2]

async Task<FlairV2> Reddit.Controllers.Flairs.CreateLinkFlairTemplateV2Async	(	string	text,
		bool	textEditable = `false`,
		string	textColor = `"dark"`,
		string	backgroundColor = `"#EEEEFF"`,
		bool	modOnly = `false`
	)

Create a new link flair template asynchronously. This new endpoint is primarily used for the redesign.

Parameters

text	a string no longer than 64 characters
textEditable	boolean value
textColor	one of (light, dark)
backgroundColor	a 6-digit rgb hex color, e.g. #AABBCC
modOnly	boolean value

◆ CreateUserFlair() [1/2]

void Reddit.Controllers.Flairs.CreateUserFlair ( FlairCreateInput flairCreateInput )

Create a new user flair.

Parameters

flairCreateInput A valid FlairCreateInput instance

◆ CreateUserFlair() [2/2]

void Reddit.Controllers.Flairs.CreateUserFlair	(	string	username,
		string	text,
		string	cssClass = `""`
	)

Create a new user flair.

Parameters

username	The user who's getting the new flair
text	The flair text
cssClass	a valid subreddit image name

◆ CreateUserFlairAsync() [1/2]

async Task Reddit.Controllers.Flairs.CreateUserFlairAsync ( FlairCreateInput flairCreateInput )

Create a new user flair asynchronously.

Parameters

flairCreateInput A valid FlairCreateInput instance

◆ CreateUserFlairAsync() [2/2]

async Task Reddit.Controllers.Flairs.CreateUserFlairAsync	(	string	username,
		string	text,
		string	cssClass = `""`
	)

Create a new user flair asynchronously.

Parameters

username	The user who's getting the new flair
text	The flair text
cssClass	a valid subreddit image name

◆ CreateUserFlairTemplate() [1/2]

void Reddit.Controllers.Flairs.CreateUserFlairTemplate ( FlairTemplateInput flairTemplateInput )

Create a new user flair template.

Parameters

flairTemplateInput A valid FlairTemplateInput instance

◆ CreateUserFlairTemplate() [2/2]

void Reddit.Controllers.Flairs.CreateUserFlairTemplate	(	string	text,
		bool	textEditable = `false`,
		string	cssClass = `""`
	)

Create a new user flair template.

Parameters

text	a string no longer than 64 characters
textEditable	boolean value
cssClass	a valid subreddit image name

◆ CreateUserFlairTemplateAsync() [1/2]

async Task Reddit.Controllers.Flairs.CreateUserFlairTemplateAsync ( FlairTemplateInput flairTemplateInput )

Create a new user flair template asynchronously.

Parameters

flairTemplateInput A valid FlairTemplateInput instance

◆ CreateUserFlairTemplateAsync() [2/2]

async Task Reddit.Controllers.Flairs.CreateUserFlairTemplateAsync	(	string	text,
		bool	textEditable = `false`,
		string	cssClass = `""`
	)

Create a new user flair template asynchronously.

Parameters

text	a string no longer than 64 characters
textEditable	boolean value
cssClass	a valid subreddit image name

◆ CreateUserFlairTemplateV2() [1/2]

FlairV2 Reddit.Controllers.Flairs.CreateUserFlairTemplateV2 ( FlairTemplateV2Input flairTemplateV2Input )

Create a new user flair template asynchronously. This new endpoint is primarily used for the redesign.

Parameters

flairTemplateV2Input A valid FlairTemplateV2Input instance

Returns: The created flair object.

◆ CreateUserFlairTemplateV2() [2/2]

FlairV2 Reddit.Controllers.Flairs.CreateUserFlairTemplateV2	(	string	text,
		bool	textEditable = `false`,
		string	textColor = `"dark"`,
		string	backgroundColor = `"#EEEEFF"`,
		bool	modOnly = `false`
	)

Create a new user flair template. This new endpoint is primarily used for the redesign.

Parameters

text	a string no longer than 64 characters
textEditable	boolean value
textColor	one of (light, dark)
backgroundColor	a 6-digit rgb hex color, e.g. #AABBCC
modOnly	boolean value

Returns: The created flair object.

◆ CreateUserFlairTemplateV2Async() [1/2]

async Task<FlairV2> Reddit.Controllers.Flairs.CreateUserFlairTemplateV2Async ( FlairTemplateV2Input flairTemplateV2Input )

Create a new user flair template asynchronously. This new endpoint is primarily used for the redesign.

Parameters

flairTemplateV2Input A valid FlairTemplateV2Input instance

◆ CreateUserFlairTemplateV2Async() [2/2]

async Task<FlairV2> Reddit.Controllers.Flairs.CreateUserFlairTemplateV2Async	(	string	text,
		bool	textEditable = `false`,
		string	textColor = `"dark"`,
		string	backgroundColor = `"#EEEEFF"`,
		bool	modOnly = `false`
	)

Create a new user flair template asynchronously. This new endpoint is primarily used for the redesign.

Parameters

text	a string no longer than 64 characters
textEditable	boolean value
textColor	one of (light, dark)
backgroundColor	a 6-digit rgb hex color, e.g. #AABBCC
modOnly	boolean value

◆ DeleteFlair()

void Reddit.Controllers.Flairs.DeleteFlair ( string username )

Delete flair.

Parameters

username The user whose flair we're removing

◆ DeleteFlairAsync()

async Task Reddit.Controllers.Flairs.DeleteFlairAsync ( string username )

Delete flair asynchronously.

Parameters

username The user whose flair we're removing

◆ DeleteFlairTemplate()

void Reddit.Controllers.Flairs.DeleteFlairTemplate ( string flairTemplateId )

Delete flair template.

Parameters

flairTemplateId The ID of the flair template being deleted (e.g. "0778d5ec-db43-11e8-9258-0e3a02270976")

◆ DeleteFlairTemplateAsync()

async Task Reddit.Controllers.Flairs.DeleteFlairTemplateAsync ( string flairTemplateId )

Delete flair template asynchronously.

Parameters

flairTemplateId The ID of the flair template being deleted (e.g. "0778d5ec-db43-11e8-9258-0e3a02270976")

◆ FlairConfig()

void Reddit.Controllers.Flairs.FlairConfig ( FlairConfigInput flairConfigInput )

Update the flair configuration settings for this subreddit.

Parameters

flairConfigInput A valid FlairConfigInput instance

◆ FlairConfigAsync()

async Task Reddit.Controllers.Flairs.FlairConfigAsync ( FlairConfigInput flairConfigInput )

Update the flair configuration settings for this subreddit asynchronously.

Parameters

flairConfigInput A valid FlairConfigInput instance

◆ FlairCSV() [1/3]

List<ActionResult> Reddit.Controllers.Flairs.FlairCSV ( FlairListResultContainer flairCsv )

Change the flair of multiple users in the same subreddit with a single API call. If both cssclass and flairtext are the empty string for a given user, instead clears that user's flair. Returns an array of objects indicating if each flair setting was applied, or a reason for the failure.

Parameters

flairCsv A valid FlairListResultContainer object

Returns: Action results.

◆ FlairCSV() [2/3]

List<ActionResult> Reddit.Controllers.Flairs.FlairCSV ( List< FlairListResult > flairCsv )

Change the flair of multiple users in the same subreddit with a single API call. If both cssclass and flairtext are the empty string for a given user, instead clears that user's flair. Returns an array of objects indicating if each flair setting was applied, or a reason for the failure.

Parameters

flairCsv A list of valid FlairListResult objects

Returns: Action results.

◆ FlairCSV() [3/3]

List<ActionResult> Reddit.Controllers.Flairs.FlairCSV ( string flairCsv )

Change the flair of multiple users in the same subreddit with a single API call. Requires a string 'flair_csv' which has up to 100 lines of the form 'user,flairtext,cssclass' (Lines beyond the 100th are ignored). If both cssclass and flairtext are the empty string for a given user, instead clears that user's flair. Returns an array of objects indicating if each flair setting was applied, or a reason for the failure.

Parameters

flairCsv comma-seperated flair information

Returns: Action results.

◆ FlairCSVAsync() [1/3]

async Task<List<ActionResult> > Reddit.Controllers.Flairs.FlairCSVAsync ( FlairListResultContainer flairCsv )

Asynchronously change the flair of multiple users in the same subreddit with a single API call. If both cssclass and flairtext are the empty string for a given user, instead clears that user's flair. Returns an array of objects indicating if each flair setting was applied, or a reason for the failure.

Parameters

flairCsv A valid FlairListResultContainer object

◆ FlairCSVAsync() [2/3]

async Task<List<ActionResult> > Reddit.Controllers.Flairs.FlairCSVAsync ( List< FlairListResult > flairCsv )

Asynchronously change the flair of multiple users in the same subreddit with a single API call. If both cssclass and flairtext are the empty string for a given user, instead clears that user's flair. Returns an array of objects indicating if each flair setting was applied, or a reason for the failure.

Parameters

flairCsv A list of valid FlairListResult objects

◆ FlairCSVAsync() [3/3]

async Task<List<ActionResult> > Reddit.Controllers.Flairs.FlairCSVAsync ( string flairCsv )

Asynchronously change the flair of multiple users in the same subreddit with a single API call. Requires a string 'flair_csv' which has up to 100 lines of the form 'user,flairtext,cssclass' (Lines beyond the 100th are ignored). If both cssclass and flairtext are the empty string for a given user, instead clears that user's flair. Returns an array of objects indicating if each flair setting was applied, or a reason for the failure.

Parameters

flairCsv comma-seperated flair information

◆ FlairSelector()

FlairSelectorResultContainer Reddit.Controllers.Flairs.FlairSelector	(	string	username = `null`,
		string	link = `null`
	)

Return information about a user's or link's flair options.

Parameters

username A valid Reddit username

///

Parameters

link	a fullname of a link

Returns: Flair results.

◆ GetFlairList() [1/2]

List<FlairListResult> Reddit.Controllers.Flairs.GetFlairList ( FlairNameListingInput flairNameListingInput )

List of flairs.

Parameters

flairNameListingInput A valid FlairNameListingInput instance

Returns: Flair list results.

◆ GetFlairList() [2/2]

List<FlairListResult> Reddit.Controllers.Flairs.GetFlairList	(	string	username = `""`,
		int	limit = `25`,
		string	after = `""`,
		string	before = `""`,
		int	count = `0`,
		string	show = `"all"`,
		bool	srDetail = `false`
	)

List of flairs.

Parameters

username	a user by name
limit	the maximum number of items desired (default: 25, maximum: 1000)
after	fullname of a thing
before	fullname of a thing
count	a positive integer (default: 0)
show	(optional) the string all
srDetail	(optional) expand subreddits

Returns: Flair list results.

◆ GetLinkFlair()

List<Flair> Reddit.Controllers.Flairs.GetLinkFlair ( )

Return list of available link flair for the current subreddit. Will not return flair if the user cannot set their own link flair and they are not a moderator that can set flair.

Returns: List of available link flairs.

◆ GetLinkFlairV2()

List<FlairV2> Reddit.Controllers.Flairs.GetLinkFlairV2 ( )

Return list of available link flair for the current subreddit. Will not return flair if the user cannot set their own link flair and they are not a moderator that can set flair.

Returns: List of available link flairs.

◆ GetUserFlair()

List<Flair> Reddit.Controllers.Flairs.GetUserFlair ( )

Return list of available user flair for the current subreddit. Will not return flair if flair is disabled on the subreddit, the user cannot set their own flair, or they are not a moderator that can set flair.

Returns: List of available user flairs.

◆ GetUserFlairV2()

List<FlairV2> Reddit.Controllers.Flairs.GetUserFlairV2 ( )

Return list of available user flair for the current subreddit. Will not return flair if flair is disabled on the subreddit, the user cannot set their own flair, or they are not a moderator that can set flair.

Returns: List of available user flairs.

◆ SetFlairEnabled()

void Reddit.Controllers.Flairs.SetFlairEnabled ( bool flairEnabled = true )

Set flair enabled.

Parameters

flairEnabled boolean value

◆ SetFlairEnabledAsync()

async Task Reddit.Controllers.Flairs.SetFlairEnabledAsync ( bool flairEnabled = true )

Set flair enabled asynchronously.

Parameters

flairEnabled boolean value

◆ UpdateLinkFlairTemplate() [1/2]

void Reddit.Controllers.Flairs.UpdateLinkFlairTemplate ( FlairTemplateInput flairTemplateInput )

Update an existing link flair template.

Parameters

flairTemplateInput A valid FlairTemplateInput instance

◆ UpdateLinkFlairTemplate() [2/2]

void Reddit.Controllers.Flairs.UpdateLinkFlairTemplate	(	string	flairTemplateId,
		string	text = `null`,
		bool?	textEditable = `null`,
		string	cssClass = `null`
	)

Update an existing link flair template.

Parameters

flairTemplateId	The ID of the flair template being updated (e.g. "0778d5ec-db43-11e8-9258-0e3a02270976")
text	a string no longer than 64 characters
textEditable	boolean value
cssClass	a valid subreddit image name

◆ UpdateLinkFlairTemplateAsync() [1/2]

async Task Reddit.Controllers.Flairs.UpdateLinkFlairTemplateAsync ( FlairTemplateInput flairTemplateInput )

Update an existing link flair template asynchronously.

Parameters

flairTemplateInput A valid FlairTemplateInput instance

◆ UpdateLinkFlairTemplateAsync() [2/2]

async Task Reddit.Controllers.Flairs.UpdateLinkFlairTemplateAsync	(	string	flairTemplateId,
		string	text,
		bool	textEditable = `false`,
		string	cssClass = `""`
	)

Update an existing link flair template asynchronously.

Parameters

flairTemplateId	The ID of the flair template being updated (e.g. "0778d5ec-db43-11e8-9258-0e3a02270976")
text	a string no longer than 64 characters
textEditable	boolean value
cssClass	a valid subreddit image name

◆ UpdateLinkFlairTemplateV2() [1/2]

FlairV2 Reddit.Controllers.Flairs.UpdateLinkFlairTemplateV2 ( FlairTemplateV2Input flairTemplateV2Input )

Update an existing link flair template. This new endpoint is primarily used for the redesign.

Parameters

flairTemplateV2Input A valid FlairTemplateV2Input instance

Returns: The updated flair object.

◆ UpdateLinkFlairTemplateV2() [2/2]

FlairV2 Reddit.Controllers.Flairs.UpdateLinkFlairTemplateV2	(	string	flairTemplateId,
		string	text = `null`,
		bool?	textEditable = `null`,
		string	textColor = `null`,
		string	backgroundColor = `null`,
		bool?	modOnly = `null`
	)

Update an existing link flair template. This new endpoint is primarily used for the redesign.

Parameters

flairTemplateId	The ID of the flair template being updated (e.g. "0778d5ec-db43-11e8-9258-0e3a02270976")
text	a string no longer than 64 characters
textEditable	boolean value
textColor	one of (light, dark)
backgroundColor	a 6-digit rgb hex color, e.g. #AABBCC
modOnly	boolean value

Returns: The updated flair object.

◆ UpdateLinkFlairTemplateV2Async() [1/2]

async Task<FlairV2> Reddit.Controllers.Flairs.UpdateLinkFlairTemplateV2Async ( FlairTemplateV2Input flairTemplateV2Input )

Update an existing link flair template asynchronously. This new endpoint is primarily used for the redesign.

Parameters

flairTemplateV2Input A valid FlairTemplateV2Input instance

◆ UpdateLinkFlairTemplateV2Async() [2/2]

async Task<FlairV2> Reddit.Controllers.Flairs.UpdateLinkFlairTemplateV2Async	(	string	flairTemplateId,
		string	text = `null`,
		bool?	textEditable = `null`,
		string	textColor = `null`,
		string	backgroundColor = `null`,
		bool?	modOnly = `null`
	)

Update an existing link flair template asynchronously. This new endpoint is primarily used for the redesign.

Parameters

flairTemplateId	The ID of the flair template being updated (e.g. "0778d5ec-db43-11e8-9258-0e3a02270976")
text	a string no longer than 64 characters
textEditable	boolean value
textColor	one of (light, dark)
backgroundColor	a 6-digit rgb hex color, e.g. #AABBCC
modOnly	boolean value

◆ UpdateUserFlairTemplate() [1/2]

void Reddit.Controllers.Flairs.UpdateUserFlairTemplate ( FlairTemplateInput flairTemplateInput )

Update an existing user flair template.

Parameters

flairTemplateInput A valid FlairTemplateInput instance

◆ UpdateUserFlairTemplate() [2/2]

void Reddit.Controllers.Flairs.UpdateUserFlairTemplate	(	string	flairTemplateId,
		string	text = `null`,
		bool?	textEditable = `null`,
		string	cssClass = `null`
	)

Update an existing user flair template.

Parameters

flairTemplateId	The ID of the flair template being updated (e.g. "0778d5ec-db43-11e8-9258-0e3a02270976")
text	a string no longer than 64 characters
textEditable	boolean value
cssClass	a valid subreddit image name

◆ UpdateUserFlairTemplateAsync() [1/2]

async Task Reddit.Controllers.Flairs.UpdateUserFlairTemplateAsync ( FlairTemplateInput flairTemplateInput )

Update an existing user flair template asynchronously.

Parameters

flairTemplateInput A valid FlairTemplateInput instance

◆ UpdateUserFlairTemplateAsync() [2/2]

async Task Reddit.Controllers.Flairs.UpdateUserFlairTemplateAsync	(	string	flairTemplateId,
		string	text,
		bool	textEditable = `false`,
		string	cssClass = `""`
	)

Update an existing user flair template asynchronously.

Parameters

flairTemplateId	The ID of the flair template being updated (e.g. "0778d5ec-db43-11e8-9258-0e3a02270976")
text	a string no longer than 64 characters
textEditable	boolean value
cssClass	a valid subreddit image name

◆ UpdateUserFlairTemplateV2() [1/2]

FlairV2 Reddit.Controllers.Flairs.UpdateUserFlairTemplateV2 ( FlairTemplateV2Input flairTemplateV2Input )

Update an existing user flair template. This new endpoint is primarily used for the redesign.

Parameters

flairTemplateV2Input A valid FlairTemplateV2Input instance

Returns: The updated flair object.

◆ UpdateUserFlairTemplateV2() [2/2]

FlairV2 Reddit.Controllers.Flairs.UpdateUserFlairTemplateV2	(	string	flairTemplateId,
		string	text = `null`,
		bool?	textEditable = `null`,
		string	textColor = `null`,
		string	backgroundColor = `null`,
		bool?	modOnly = `null`
	)

Update an existing user flair template. This new endpoint is primarily used for the redesign.

Parameters

flairTemplateId	The ID of the flair template being updated (e.g. "0778d5ec-db43-11e8-9258-0e3a02270976")
text	a string no longer than 64 characters
textEditable	boolean value
textColor	one of (light, dark)
backgroundColor	a 6-digit rgb hex color, e.g. #AABBCC
modOnly	boolean value

Returns: The updated flair object.

◆ UpdateUserFlairTemplateV2Async() [1/2]

async Task<FlairV2> Reddit.Controllers.Flairs.UpdateUserFlairTemplateV2Async ( FlairTemplateV2Input flairTemplateV2Input )

Update an existing user flair template asynchronously. This new endpoint is primarily used for the redesign.

Parameters

flairTemplateV2Input A valid FlairTemplateV2Input instance

◆ UpdateUserFlairTemplateV2Async() [2/2]

async Task<FlairV2> Reddit.Controllers.Flairs.UpdateUserFlairTemplateV2Async	(	string	flairTemplateId,
		string	text = `null`,
		bool?	textEditable = `null`,
		string	textColor = `null`,
		string	backgroundColor = `null`,
		bool?	modOnly = `null`
	)

Update an existing user flair template asynchronously. This new endpoint is primarily used for the redesign.

Parameters

flairTemplateId	The ID of the flair template being updated (e.g. "0778d5ec-db43-11e8-9258-0e3a02270976")
text	a string no longer than 64 characters
textEditable	boolean value
textColor	one of (light, dark)
backgroundColor	a 6-digit rgb hex color, e.g. #AABBCC
modOnly	boolean value

Property Documentation

◆ FlairList

List<FlairListResult>? Reddit.Controllers.Flairs.FlairList

getset

List of flairs.

◆ FlairListNext

string Reddit.Controllers.Flairs.FlairListNext

get

Fullname of the next page of flair list results.

◆ FlairListPrev

string Reddit.Controllers.Flairs.FlairListPrev

get

Fullname of the previous page of flair list results.

◆ LinkFlair

List<Flair>? Reddit.Controllers.Flairs.LinkFlair

getset

List of link flairs.

◆ LinkFlairV2

List<FlairV2>? Reddit.Controllers.Flairs.LinkFlairV2

getset

List of link flairs.

◆ UserFlair

List<Flair>? Reddit.Controllers.Flairs.UserFlair

getset

List of user flairs.

◆ UserFlairV2

List<FlairV2>? Reddit.Controllers.Flairs.UserFlairV2

getset

List of user flairs.

The documentation for this class was generated from the following file:

E:/repos/Reddit.NET/src/Reddit.NET/Controllers/Flairs.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Flairs()

Member Function Documentation

◆ ClearLinkFlairTemplates()

◆ ClearLinkFlairTemplatesAsync()

◆ ClearUserFlairTemplates()

◆ ClearUserFlairTemplatesAsync()

◆ CreateLinkFlair()

◆ CreateLinkFlairAsync()

◆ CreateLinkFlairTemplate() [1/2]

◆ CreateLinkFlairTemplate() [2/2]

◆ CreateLinkFlairTemplateAsync() [1/2]

◆ CreateLinkFlairTemplateAsync() [2/2]

◆ CreateLinkFlairTemplateV2() [1/2]

◆ CreateLinkFlairTemplateV2() [2/2]

◆ CreateLinkFlairTemplateV2Async() [1/2]

◆ CreateLinkFlairTemplateV2Async() [2/2]

◆ CreateUserFlair() [1/2]

◆ CreateUserFlair() [2/2]

◆ CreateUserFlairAsync() [1/2]

◆ CreateUserFlairAsync() [2/2]

◆ CreateUserFlairTemplate() [1/2]

◆ CreateUserFlairTemplate() [2/2]

◆ CreateUserFlairTemplateAsync() [1/2]

◆ CreateUserFlairTemplateAsync() [2/2]

◆ CreateUserFlairTemplateV2() [1/2]

◆ CreateUserFlairTemplateV2() [2/2]

◆ CreateUserFlairTemplateV2Async() [1/2]

◆ CreateUserFlairTemplateV2Async() [2/2]

◆ DeleteFlair()

◆ DeleteFlairAsync()

◆ DeleteFlairTemplate()

◆ DeleteFlairTemplateAsync()

◆ FlairConfig()

◆ FlairConfigAsync()

◆ FlairCSV() [1/3]

◆ FlairCSV() [2/3]

◆ FlairCSV() [3/3]

◆ FlairCSVAsync() [1/3]

◆ FlairCSVAsync() [2/3]

◆ FlairCSVAsync() [3/3]

◆ FlairSelector()

◆ GetFlairList() [1/2]

◆ GetFlairList() [2/2]

◆ GetLinkFlair()

◆ GetLinkFlairV2()

◆ GetUserFlair()

◆ GetUserFlairV2()

◆ SetFlairEnabled()

◆ SetFlairEnabledAsync()

◆ UpdateLinkFlairTemplate() [1/2]

◆ UpdateLinkFlairTemplate() [2/2]

◆ UpdateLinkFlairTemplateAsync() [1/2]

◆ UpdateLinkFlairTemplateAsync() [2/2]

◆ UpdateLinkFlairTemplateV2() [1/2]

◆ UpdateLinkFlairTemplateV2() [2/2]

◆ UpdateLinkFlairTemplateV2Async() [1/2]

◆ UpdateLinkFlairTemplateV2Async() [2/2]

◆ UpdateUserFlairTemplate() [1/2]

◆ UpdateUserFlairTemplate() [2/2]

◆ UpdateUserFlairTemplateAsync() [1/2]

◆ UpdateUserFlairTemplateAsync() [2/2]

◆ UpdateUserFlairTemplateV2() [1/2]

◆ UpdateUserFlairTemplateV2() [2/2]

◆ UpdateUserFlairTemplateV2Async() [1/2]

◆ UpdateUserFlairTemplateV2Async() [2/2]

Property Documentation

◆ FlairList

◆ FlairListNext

◆ FlairListPrev

◆ LinkFlair

◆ LinkFlairV2

◆ UserFlair

◆ UserFlairV2