ScheduledEvent

ScheduledEvent

Represents an scheduled event.

Constructor

new ScheduledEvent(client, data, options)

Description:
  • Creates the structure for a scheduled event.

Source:
See:
Parameters:
Name Type Description
client Client

The client instance.

data Object

Scheduled event data from Discord.

options Object

Additional options for this structure.

Properties
Name Type Attributes Description
guildId String

The ID of the guild that this event belongs to.

nocache Boolean <nullable>

Whether this event should be cached or not.

Members

(readonly, nullable) creator :User

Description:
  • The user who created the event.

Source:

The user who created the event.

Type:

(readonly, nullable) creatorId :String

Description:
  • The ID of the user who created the event.

Source:

The ID of the user who created the event.

Type:
  • String

(readonly) description :String

Description:
  • The description of the event.

Source:

The description of the event.

Type:
  • String

(readonly, nullable) displayImageURL :String

Description:
  • The url of the events's image.

Source:

The url of the events's image.

Type:
  • String

(readonly) entityType :String

Description:
  • Where the event is scheduled to take place.

Source:

Where the event is scheduled to take place.

Type:
  • String

(readonly, nullable) guild :Guild

Description:
  • The guild that this event belongs to.

Source:

The guild that this event belongs to.

Type:

(readonly) guildId :String

Description:
  • The guild ID of the event.

Source:

The guild ID of the event.

Type:
  • String

(readonly) id :String

Description:
  • The ID of the event.

Source:

The ID of the event.

Type:
  • String

(readonly, nullable) location :String

Description:
  • The location of the event.

Source:

The location of the event.

Type:
  • String

(readonly) name :String

Description:
  • The name of the event.

Source:

The name of the event.

Type:
  • String

(readonly, nullable) scheduledEndTime :Number

Description:
  • The UNIX timestamp of the end time for the event.

Source:

The UNIX timestamp of the end time for the event.

Type:
  • Number

(readonly) scheduledStartTime :Number

Description:
  • The UNIX timestamp of the start time for the event.

Source:

The UNIX timestamp of the start time for the event.

Type:
  • Number

(readonly) status :String

Description:
  • The status of the event.

Source:

The status of the event.

Type:
  • String

(readonly) userCount :Number

Description:
  • The number of users who have signed up for the event.

Source:

The number of users who have signed up for the event.

Type:
  • Number

Methods

(static) getImageUrl(id, hashnullable) → {String}

Description:
  • Returns the URL of the event's image.

Source:
Parameters:
Name Type Attributes Description
id String

The id of the event.

hash String <nullable>

The hash of the event's image.

Returns:
Type
String

(static) shouldCache(gluonCacheOptions, guildCacheOptions) → {Boolean}

Description:
  • Determines whether the scheduled event should be cached.

Source:
Parameters:
Name Type Description
gluonCacheOptions GluonCacheOptions

The cache options for the client.

guildCacheOptions GuildCacheOptions

The cache options for the guild.

Returns:
Type
Boolean

toJSON(format) → {Object}

Description:
  • Returns the JSON representation of this structure.

Source:
Parameters:
Name Type Description
format Number

The format to return the data in.

Returns:
Type
Object

toString()

Source: