Documentation/detritus-client/Structures

GuildScheduledEventclass

Guild Scheduled Event Structure

On this page

Overview
Constructor1
Properties19
Accessors7
Methods16

Guild Scheduled Event Structure

import { Structures } from 'detritus-client';

Structures.GuildScheduledEvent;

Hierarchy

StructureBaseStructureGuildScheduledEvent

23 properties4 methods15 inheritedsrc/structures/guildscheduledevent.ts:51

Constructor

new GuildScheduledEvent

src/structures/guildscheduledevent.ts:73

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

Properties

channelId

string | null

Default null

client

ShardClient

readonly

Inherited from BaseStructure.client

creator?

User

optional

creatorId?

string

optional

deleted

boolean

Default false

description?

string | null

optional

entityId

string | null

Default null

entityMetadata

any

entityType

GuildScheduledEventEntityTypes

Default GuildScheduledEventEntityTypes.STAGE_INSTANCE

guildId

string

Default ''

string

Default ''

image?

string | null

optional

name

string

Default ''

privacyLevel

GuildScheduledEventPrivacyLevels

Default GuildScheduledEventPrivacyLevels.GUILD_ONLY

recurrenceRule

GuildScheduledEventRecurrenceRule | null

Default null

scheduledEndTimeUnix?

number

optional

scheduledStartTimeUnix

number

Default 0

status

GuildScheduledEventStatusTypes

Default GuildScheduledEventStatusTypes.SCHEDULED

userCount?

number

optional

Accessors

createdAt

Date | null

get

createdAtUnix

number | null

get

guild

Guild | null

get

isClone

boolean

get

Inherited from BaseStructure.isClone

scheduledEndTime

Date | null

get

scheduledStartTime

Date

get

shardId

number

get

Inherited from BaseStructure.shardId

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/guildscheduledevent.ts:111

delete(options?: DeleteGuildScheduledEvent): 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/guildscheduledevent.ts:115

edit(options?: EditGuildScheduledEvent): Promise<GuildScheduledEvent>

fetchUsers()

async src/structures/guildscheduledevent.ts:119

fetchUsers(
  options?: FetchGuildScheduledEventUsers,
): Promise<BaseCollection<string, GuildScheduledEventUser>>

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/guildscheduledevent.ts:123

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/basestructure.ts:357

toJSON(): object

Inherited from BaseStructure.toJSON