-
Notifications
You must be signed in to change notification settings - Fork 144
GuildVoiceChannel
SinisterRectus edited this page Mar 4, 2017
·
21 revisions
Objects Accessible via Caches
- Members
- PermissionOverwrites
Properties Inherited From Channel
| Name | Type | Mutable | Description |
|---|---|---|---|
| isPrivate | boolean | Whether the channel is private | |
| type | string | The channel type (text or voice) |
Properties Inherited From Container
| Name | Type | Mutable | Description |
|---|---|---|---|
| client | Client | Client object to which the Discord object is known | |
| parent | * | Parent Discord object |
Properties Inherited From GuildChannel
| Name | Type | Mutable | Description |
|---|---|---|---|
| guild | Guild | The guild in which the channel exists | |
| invites | function | Returns an iterator for the channel's invites (not cached) | |
| name | string | X | The name of the guild channel |
| permissionOverwriteCount | number | How many PermissionOverwrites are cached for the channel. | |
| permissionOverwrites | function | Iterator for the channel's cached PermissionOverwrites. | |
| position | number | X | The position of the channel in the guild's list of channels |
Properties Inherited From Snowflake
| Name | Type | Mutable | Description |
|---|---|---|---|
| createdAt | number | Unix time in seconds at which the object was created by Discord | |
| id | string | Snowflake ID for the object | |
| timestamp | string | ISO 8601 date and time at which the object was created by Discord |
| Name | Type | Mutable | Description |
|---|---|---|---|
| bitrate | [number] | X | Channel bitrate in bits per seconds (8000 to 96000 or 128000 for VIP guilds, default: 64000) |
| connection | VoiceConnection? | The handle for this channel's voice connection, if one exists | |
| memberCount | number | How many Members are cached for the channel. | |
| members | function | Iterator for the channel's cached Members. | |
| userLimit | [number] | X | Limit to the number of users allowed in the channel (use 0 for infinite, default: 0) |
Methods Inherited From Channel
| Prototype | Interface | Description |
|---|---|---|
| delete() | HTTP | Deletes the channel. This cannot be undone for guild channels! |
Methods Inherited From GuildChannel
| Prototype | Interface | Description |
|---|---|---|
| createInvite(maxAge, maxUses, temporary, unique) | HTTP | Creates and returns an invite to the channel for users to join. |
| getPermissionOverwriteFor(object) | Local | Returns an overwrite for the provided Role or Member |
| Prototype | Interface | Description |
|---|---|---|
| join() | WS | Joins the voice channel. A connection, either a new or old one, is returned if successful. |
| leave() | WS | Leaves the voice channel. A boolean is returned to indicate success. |