Class: FlairTemplate
Table of contents
Accessors
Methods
- delete
- edit
- createPostFlairTemplate
- createUserFlairTemplate
- deleteFlairTemplate
- editFlairTemplate
- getPostFlairTemplates
- getUserFlairTemplates
Accessors
allowUserEdits
• get allowUserEdits(): boolean
Whether or not the flair template allows users to edit their flair.
Returns
boolean
allowableContent
• get allowableContent(): AllowableFlairContent
The flair template's allowable content. Either 'all', 'emoji', or 'text'.
Returns
backgroundColor
• get backgroundColor(): FlairBackgroundColor
The flair template's background color. Either 'transparent' or a hex color code. e.g. #FFC0CB
Returns
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
Whether or not the flair template is 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
Methods
delete
▸ delete(): Promise<void>
Delete this flair template
Returns
Promise<void>
edit
▸ edit(options): Promise<FlairTemplate>
Edit this flair template
Parameters
| Name | Type |
|---|---|
options | Partial<Omit<EditFlairTemplateOptions, "id" | "subredditName">> |
Returns
Promise<FlairTemplate>
createPostFlairTemplate
▸ Static createPostFlairTemplate(options, metadata?): Promise<FlairTemplate>
Parameters
| Name | Type |
|---|---|
options | CreateFlairTemplateOptions |
metadata? | Metadata |
Returns
Promise<FlairTemplate>
createUserFlairTemplate
▸ Static createUserFlairTemplate(options, metadata?): Promise<FlairTemplate>
Parameters
| Name | Type |
|---|---|
options | CreateFlairTemplateOptions |
metadata? | Metadata |
Returns
Promise<FlairTemplate>
deleteFlairTemplate
▸ Static deleteFlairTemplate(subredditName, flairTemplateId, metadata?): Promise<void>
Parameters
| Name | Type |
|---|---|
subredditName | string |
flairTemplateId | string |
metadata? | Metadata |
Returns
Promise<void>
editFlairTemplate
▸ Static editFlairTemplate(editOptions, metadata?): Promise<FlairTemplate>
Parameters
| Name | Type |
|---|---|
editOptions | EditFlairTemplateOptions |
metadata? | Metadata |
Returns
Promise<FlairTemplate>
getPostFlairTemplates
▸ Static getPostFlairTemplates(subredditName, metadata?): Promise<FlairTemplate[]>
Parameters
| Name | Type |
|---|---|
subredditName | string |
metadata? | Metadata |
Returns
Promise<FlairTemplate[]>
getUserFlairTemplates
▸ Static getUserFlairTemplates(subredditName, metadata?): Promise<FlairTemplate[]>
Parameters
| Name | Type |
|---|---|
subredditName | string |
metadata? | Metadata |
Returns
Promise<FlairTemplate[]>