Documentation/detritus-client/Structures

SoundboardSoundclass

Soundboard Sound Structure default sounds have no guildId

On this page

Overview
Constructor1
Properties9
Accessors8
Methods16

Soundboard Sound Structure default sounds have no guildId

import { Structures } from 'detritus-client';

Structures.SoundboardSound;

Hierarchy

StructureBaseStructureSoundboardSound

14 properties4 methods15 inheritedsrc/structures/soundboardsound.ts:33

Constructor

new SoundboardSound

src/structures/soundboardsound.ts:45

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

Properties

available

boolean

Default true

client

ShardClient

readonly

Inherited from BaseStructure.client

emojiId

string | null

Default null

emojiName

string | null

Default null

guildId?

string

optional

name

string

Default ''

soundId

string

Default ''

user?

User

optional

volume

number

Default 1

Accessors

createdAt

Date

get

createdAtUnix

number

get

guild

Guild | null

get

string

get

isClone

boolean

get

Inherited from BaseStructure.isClone

isDefault

boolean

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/soundboardsound.ts:77

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

difference()

src/structures/basestructure.ts:146

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

Inherited from 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/soundboardsound.ts:84

edit(options?: EditGuildSoundboardSound): Promise<SoundboardSound>

hasDifference()

src/structures/basestructure.ts:218

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

Inherited from 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/soundboardsound.ts:97

merge(data?: BaseStructureData): void

Overrides BaseStructure.merge

mergeValue()

src/structures/basestructure.ts:351

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

Inherited from BaseStructure.mergeValue

send()

async src/structures/soundboardsound.ts:91

send(channelId: string): Promise<any>

toJSON()

src/structures/basestructure.ts:357

toJSON(): object

Inherited from BaseStructure.toJSON