Interface LocalChannel

A channel/net visible to the local user.

interface LocalChannel {
    active: boolean;
    assigned: boolean;
    canReceive: boolean;
    canTransmit: boolean;
    guildId: string;
    guildName: string;
    id: number;
    isGlobalAlert: boolean;
    isPublicNet: boolean;
    memberCount: number;
    members: LocalChannelMember[];
    muted: boolean;
    name: string;
    orgLink: boolean;
    readOnlyAssignment: boolean;
    shardOnly: boolean;
    uid: string;
    volume: number;
}

Properties

active assigned canReceive canTransmit guildId guildName id isGlobalAlert isPublicNet memberCount members muted name orgLink readOnlyAssignment shardOnly uid volume

Properties

active

active: boolean

Whether the channel is currently active.

assigned

assigned: boolean

Whether the user is assigned to this channel.

canReceive

canReceive: boolean

Whether the user may receive on this channel.

canTransmit

canTransmit: boolean

Whether the user may transmit on this channel.

guildId

guildId: string

Identifier of the channel's guild.

guildName

guildName: string

Display name of the channel's guild.

id

id: number

Numeric identifier of the channel.

isGlobalAlert

isGlobalAlert: boolean

Whether this is a global alert channel.

isPublicNet

isPublicNet: boolean

Whether this is a public net.

memberCount

memberCount: number

Number of members in the channel.

members

members: LocalChannelMember[]

Members currently in the channel.

muted

muted: boolean

Whether the channel is muted.

name

name: string

Display name of the channel.

orgLink

orgLink: boolean

Whether this channel is linked to an org.

readOnlyAssignment

readOnlyAssignment: boolean

Whether the assignment to this channel is read-only.

shardOnly

shardOnly: boolean

Whether this channel is restricted to the current shard.

uid

uid: string

Unique string identifier of the channel.

volume

volume: number

Playback volume level for the channel.

Settings

Member Visibility

On This Page

Properties