StageVoiceGuildChannel class

Inheritance

• Object
• SnowflakeEntity
• IChannel
• MinimalGuildChannel
• GuildChannel
• VoiceGuildChannel
• StageVoiceGuildChannel

Properties

bitrate ↔ int?

The channel's bitrate.

late, final, inherited

channelType ↔ ChannelType

Type of this channel

late, final, inherited

client → INyxx

Reference to client

final, inherited

createdAt → DateTime

Gets creation timestamp included in Snowflake

no setter, inherited

guild ↔ Cacheable<Snowflake, Guild>

Id of Guild that the channel is in.

late, final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

id → Snowflake

ID of entity as Snowflake

final, inherited

isNsfw ↔ bool

Indicates if channel is nsfw

late, final, inherited

name ↔ String

The channel's name.

late, final, inherited

parentChannel ↔ Cacheable<Snowflake, GuildChannel>?

Id of parent channel

late, final, inherited

permissionOverrides ↔ List<PermissionsOverrides>

Permission override for channel

late, final, inherited

position ↔ int

Relative position of channel in context of channel list

late, final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

userLimit ↔ int?

The channel's user limit.

late, final, inherited

Methods

connect({bool selfMute = false, bool selfDeafen = false}) → void

Connects client to channel

inherited

createActivityInvite(VoiceActivityType type, {int? maxAge, int? maxUses}) → Future<Invite>

inherited

createInvite({int? maxAge, int? maxUses, bool? temporary, bool? unique, String? auditReason}) → Future<Invite>

Creates new Invite for IChannel and returns it"s instance

inherited

createStageChannelInstance(String topic, {StageChannelInstancePrivacyLevel? privacyLevel}) → Future<StageChannelInstance>

Creates a new Stage instance associated to a Stage channel.

delete() → Future<void>

Deletes channel if guild channel or closes DM if DM channel

inherited

deleteChannelPermission(SnowflakeEntity entity, {String? auditReason}) → Future<void>

Deletes permission overwrite for given User or Role entity Throws if entity isn't User or Role

inherited

deleteStageChannelInstance() → Future<void>

Deletes the Stage instance.

disconnect() → void

Disconnects use from channel.

inherited

dispose() → Future<void>

Perform cleanup

inherited

edit<T extends GuildChannel>(ChannelBuilder builder, {String? auditReason}) → Future<T>

Edits channel

inherited

editChannelPermissionOverrides(PermissionOverrideBuilder permissionBuilder, {String? auditReason}) → Future<void>

Allows to edit or set channel permission overrides.

inherited

editChannelPermissions(PermissionsBuilder perms, SnowflakeEntity entity, {String? auditReason}) → Future<void>

Allows to set or edit permissions for channel. id can be either User or Role Throws if id isn't User or Role

inherited

effectivePermissionForRole(Role role) → Future<Permissions>

Returns effective permissions for role to this channel including channel overrides.

inherited

effectivePermissions(Member member) → Future<Permissions>

Returns effective permissions for member to this channel including channel overrides.

inherited

fetchChannelInvites() → Stream<InviteWithMeta>

Fetches and returns all channel"s Invites

inherited

getStageChannelInstance() → Future<StageChannelInstance>

Gets the stage instance associated with the Stage channel, if it exists.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

updateStageChannelInstance(String topic, {StageChannelInstancePrivacyLevel? privacyLevel}) → Future<StageChannelInstance>

Updates fields of an existing Stage instance.

Operators

operator ==(dynamic other) → bool

The equality operator.

inherited