IStageVoiceGuildChannel class abstract

Implemented types

Constructors

IStageVoiceGuildChannel()

Properties

bitrate int?
The channel's bitrate.
no setterinherited
channelType ChannelType
Type of this channel
no setterinherited
client INyxx
Reference to client
no setterinherited
createdAt DateTime
Gets creation timestamp included in Snowflake
no setterinherited
guild Cacheable<Snowflake, IGuild>
Id of Guild that the channel is in.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
id Snowflake
ID of entity as Snowflake
finalinherited
isNsfw bool
Indicates if channel is nsfw
no setterinherited
name String
The channel's name.
no setterinherited
parentChannel Cacheable<Snowflake, GuildChannel>?
Id of parent channel
no setterinherited
permissionOverrides List<IPermissionsOverrides>
Permission override for channel
no setterinherited
position int
Relative position of channel in context of channel list
no setterinherited
rtcRegion String?
Channel voice region id, automatic when set to null
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
userLimit int?
The channel's user limit.
no setterinherited

Methods

connect({bool selfMute = false, bool selfDeafen = false}) → void
Connects client to channel
inherited
createActivityInvite(VoiceActivityType type, {int? maxAge, int? maxUses}) Future<IInvite>
Creates activity invite. Currently in beta
inherited
createInvite({int? maxAge, int? maxUses, bool? temporary, bool? unique, String? auditReason}) Future<IInvite>
Creates new IInvite for IChannel and returns it"s instance
inherited
createStageChannelInstance(String topic, {StageChannelInstancePrivacyLevel? privacyLevel}) Future<IStageChannelInstance>
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(IRole role) Future<IPermissions>
Returns effective permissions for role to this channel including channel overrides.
inherited
effectivePermissions(IMember member) Future<IPermissions>
Returns effective permissions for member to this channel including channel overrides.
inherited
fetchChannelInvites() Stream<IInviteWithMeta>
Fetches and returns all channel"s Invites
inherited
getStageChannelInstance() Future<IStageChannelInstance>
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<IStageChannelInstance>
Updates fields of an existing Stage instance.

Operators

operator ==(dynamic other) bool
The equality operator.
inherited