Class Reaction

Reaction Structure, used in [Message] we don't store the userIds since we only get them on reaction adds

Hierarchy

BaseStructure
- Reaction

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

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

Overrides BaseStructure.constructor
- Defined in src/structures/reaction.ts:46
Parameters
- client: ShardClient
- Optional data: BaseStructureData
- Optional isClone: boolean
Returns Reaction

Properties

Readonly _keys

_keys: BaseSet<string> = ...

Readonly _keysMerge

_keysMerge: BaseSet<string> = ...

channelId

channelId: string = ''

Readonly client

client: ShardClient

count

count: number = 0

emoji

emoji: Emoji

Optional guildId

guildId: string

isPartial

isPartial: boolean = false

me

me: boolean = false

messageId

messageId: string = ''

Accessors

canClear

get canClear(): boolean

- Defined in src/structures/reaction.ts:57
Returns boolean

channel

get channel(): null | Channel

- Defined in src/structures/reaction.ts:62
Returns null | Channel

guild

get guild(): null | Guild

- Defined in src/structures/reaction.ts:66
Returns null | Guild

isClone

get isClone(): boolean

- Defined in src/structures/basestructure.ts:317
Returns boolean

message

get message(): null | Message

- Defined in src/structures/reaction.ts:73
Returns null | Message

shardId

get shardId(): number

- Defined in src/structures/basestructure.ts:321
Returns number

Methods

[custom]

[custom](): object

Inherited from BaseStructure.[custom]
- Defined in src/structures/basestructure.ts:282
Returns object

_getFromSnake

_getFromSnake(key: string): any

Inherited from BaseStructure._getFromSnake
- Defined in src/structures/basestructure.ts:33
Parameters
- key: string
Returns any

_setFromSnake

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

Inherited from BaseStructure._setFromSnake
- Defined in src/structures/basestructure.ts:37
Parameters
- key: string
- value: any
Returns any

add

add(): Promise<any>

- Defined in src/structures/reaction.ts:77
Returns Promise<any>

clear

clear(): Promise<any>

- Defined in src/structures/reaction.ts:81
Returns Promise<any>

clone

clone(): Reaction

Inherited from BaseStructure.clone
- Defined in src/structures/basestructure.ts:325
Returns Reaction

delete

delete(userId?: string): Promise<any>

- Defined in src/structures/reaction.ts:85
Parameters
- userId: string = '@me'
Returns Promise<any>

deleteAll

deleteAll(): Promise<any>

- Defined in src/structures/reaction.ts:89
Returns Promise<any>

difference

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

Inherited from BaseStructure.difference
- Defined in src/structures/basestructure.ts:41
Parameters
- key: string
- value: any
Returns [boolean, any]

differences

differences(data?: BaseStructureData): null | object

Inherited from BaseStructure.differences
- Defined in src/structures/basestructure.ts:67
Parameters
- Optional data: BaseStructureData
Returns null | object

differencesBetween

differencesBetween(structure: Structure): null | object

Inherited from BaseStructure.differencesBetween
- Defined in src/structures/basestructure.ts:86
Parameters
- structure: Structure
Returns null | object

fetchUsers

fetchUsers(options?: FetchReactions): Promise<BaseCollection<string, User>>

- Defined in src/structures/reaction.ts:93
Parameters
- options: FetchReactions = {}
Returns Promise<BaseCollection<string, User>>

hasDifference

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

Inherited from BaseStructure.hasDifference
- Defined in src/structures/basestructure.ts:107
Parameters
- key: string
- value: any
Returns boolean

hasDifferences

hasDifferences(data?: BaseStructureData): boolean

Inherited from BaseStructure.hasDifferences
- Defined in src/structures/basestructure.ts:195
Parameters
- Optional data: BaseStructureData
Returns boolean

hasDifferencesBetween

hasDifferencesBetween(structure: Structure): boolean

Inherited from BaseStructure.hasDifferencesBetween
- Defined in src/structures/basestructure.ts:210
Parameters
- structure: Structure
Returns boolean

merge

merge(data?: BaseStructureData): void

Inherited from BaseStructure.merge
- Defined in src/structures/basestructure.ts:225
Parameters
- Optional data: BaseStructureData
Returns void

mergeValue

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

Overrides BaseStructure.mergeValue
- Defined in src/structures/reaction.ts:97
Parameters
- key: string
- value: any
Returns void

toJSON

toJSON(): object

Inherited from BaseStructure.toJSON
- Defined in src/structures/basestructure.ts:259
Returns object

Generated using TypeDoc