Skip to main content
Version: 0.11

Class: FlairTemplate

models.FlairTemplate

Table of contents​

Accessors​

Methods​

Accessors​

allowUserEdits​

• get allowUserEdits(): boolean

Does the flair template allow users to edit their flair?

Returns​

boolean

allowableContent​

• get allowableContent(): AllowableFlairContent

The flair template's allowable content. Either 'all', 'emoji', or 'text'.

Returns​

AllowableFlairContent

backgroundColor​

• get backgroundColor(): FlairBackgroundColor

The flair template's background color. Either 'transparent' or a hex color code. e.g. #FFC0CB

Returns​

FlairBackgroundColor

id​

• get id(): string

The flair template's ID

Returns​

string

maxEmojis​

• get maxEmojis(): number

The flair template's maximum number of emojis.

Returns​

number

modOnly​

• get modOnly(): boolean

Is the flair template only available to moderators?

Returns​

boolean

text​

• get text(): string

The flair template's text

Returns​

string

textColor​

• get textColor(): FlairTextColor

The flair template's text color. Either 'dark' or 'light'.

Returns​

FlairTextColor

Methods​

delete​

▸ delete(): Promise<void>

Delete this flair template

Returns​

Promise<void>

edit​

▸ edit(options): Promise<FlairTemplate>

Edit this flair template

Parameters​

NameType
optionsPartial<Omit<EditFlairTemplateOptions, "subredditName" | "id">>

Returns​

Promise<FlairTemplate>