Documentation/detritus-client/Structures

Emojiclass

Emoji Structure

On this page

Overview
Constructor1
Properties10
Accessors9
Methods18

Emoji Structure

import { Structures } from 'detritus-client';

Structures.Emoji;

Hierarchy

StructureBaseStructureEmoji

15 properties9 methods12 inheritedsrc/structures/emoji.ts:48

Constructor

new Emoji

src/structures/emoji.ts:63

new Emoji(client: ShardClient, data: BaseStructureData, isClone?: boolean)

Properties

_roles?

string[]

optional

animated

boolean

Default false

available?

boolean

optional

client

ShardClient

readonly

Inherited from BaseStructure.client

guildId?

string

optional

string | null

Default null

managed?

boolean

optional

name

string | null

Default ''

requireColons?

boolean

optional

user?

User

optional

Accessors

createdAt

Date | null

get

createdAtUnix

number | null

get

endpointFormat

string

get

format

string

get

guild

Guild | null

get

isClone

boolean

get

Inherited from BaseStructure.isClone

roles

BaseCollection<string, Role | null>

get

shardId

number

get

Inherited from BaseStructure.shardId

url

string

get

Methods

_getFromSnake()

src/structures/basestructure.ts:138

_getFromSnake(key: string): any

Inherited from BaseStructure._getFromSnake

_setFromSnake()

src/structures/basestructure.ts:142

_setFromSnake(key: string, value: any): any

Inherited from BaseStructure._setFromSnake

[custom]()

src/structures/basestructure.ts:388

[custom](): object

Inherited from BaseStructure.[custom]

clone()

src/structures/basestructure.ts:431

clone(): this

Inherited from BaseStructure.clone

delete()

async src/structures/emoji.ts:171

delete(options?: DeleteGuildEmoji): Promise<any>

difference()

src/structures/emoji.ts:195

difference(key: string, value: any): [boolean, any]

Overrides BaseStructure.difference

differences()

src/structures/basestructure.ts:178

differences(data?: BaseStructureData): object | null

Inherited from BaseStructure.differences

differencesBetween()

src/structures/basestructure.ts:197

differencesBetween(structure: Structure): object | null

Inherited from BaseStructure.differencesBetween

edit()

async src/structures/emoji.ts:158

edit(options?: EditApplicationEmoji | EditGuildEmoji): Promise<Emoji>

fetchData()

async src/structures/emoji.ts:184

fetchData(options?: { format?: ImageFormats | null; query?: UrlQuery }): Promise<any>

Parameters

options?

{ format?: ImageFormats | null; query?: UrlQuery }

options.format?

ImageFormats | null

options.query?

UrlQuery

hasDifference()

src/structures/emoji.ts:213

hasDifference(key: string, value: any): boolean

Overrides BaseStructure.hasDifference

hasDifferences()

src/structures/basestructure.ts:293

hasDifferences(data?: BaseStructureData): boolean

Inherited from BaseStructure.hasDifferences

hasDifferencesBetween()

src/structures/basestructure.ts:308

hasDifferencesBetween(structure: Structure): boolean

Inherited from BaseStructure.hasDifferencesBetween

merge()

src/structures/emoji.ts:227

merge(data?: BaseStructureData): void

Overrides BaseStructure.merge

mergeValue()

src/structures/basestructure.ts:351

mergeValue(key: string, value: any): void

Inherited from BaseStructure.mergeValue

toJSON()

src/structures/emoji.ts:282

toJSON(withRoles?: boolean): any

Overrides BaseStructure.toJSON

toString()

src/structures/emoji.ts:278

toString(): string

Returns a string representation of an object.

urlFormat()

src/structures/emoji.ts:129

urlFormat(format?: string | number | UrlQuery | null, query?: number | UrlQuery): string