gluon
    Preparing search index...

    Class VoiceState

    Represents a voice state.

    Implements

    • VoiceState
    Index

    Constructors

    constructor

    Accessors

    channel channelId deaf guild guildId joined member memberId mute requestToSpeakTimestamp selfDeaf selfMute selfStream selfVideo suppress

    Methods

    [custom] toJSON toString shouldCache

    Constructors

    • Creates the structure for a voice state.

      Parameters

      • client: Client

        The client instance.

      • data:
            | APIVoiceState
            | VoiceStateCacheJSON
            | VoiceStateDiscordJSON
            | VoiceStateStorageJSON

        The raw voice state data from Discord.

      • options: { guildId: string; nocache?: boolean }

        The additional options for this structure.

        • guildId: string

          The id of the guild that the voice state belongs to.

        • Optionalnocache?: boolean

          Whether this voice state should be cached.

      Returns VoiceState

    Accessors

    • get channel(): null | VoiceChannel

      The channel involved.

      Returns null | VoiceChannel

    • get guild(): null | Guild

      The guild that this voice state belongs to.

      Returns null | Guild

    • get guildId(): string

      The id of the guild that this voice state belongs to.

      Returns string

    • get joined(): number

      The UNIX time the user joined the voice channel.

      Returns number

    • get memberId(): string

      The id of the user the voice state is about.

      Returns string

    • get requestToSpeakTimestamp(): null | number

      The UNIX timestamp of when the user requested to speak.

      Returns null | number

    Methods

    • Returns the JSON representation of this structure.

      Parameters

      • Optionalformat: JsonTypes

        The format to return the data in.

      Returns VoiceStateCacheJSON | VoiceStateDiscordJSON | VoiceStateStorageJSON

    • Determines whether the voice state should be cached.

      Parameters

      • gluonCacheOptions: GluonCacheOptions

        The cache options for the client.

      • guildCacheOptions: GuildCacheOptions

        The cache options for the guild.

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods