- nyxx
- nyxx
- IVoiceGuildChannel abstract class
IVoiceGuildChannel
- Implemented types
-
- Implementers
Properties
-
bitrate
→ int?
-
The channel's bitrate.
read-only
-
channelType
→ ChannelType
-
Type of this channel
read-only, inherited
-
client
→ INyxx
-
Reference to client
read-only, inherited
-
createdAt
→ DateTime
-
Gets creation timestamp included in Snowflake
read-only, inherited
-
guild
→ Cacheable<Snowflake, IGuild>
-
Id of
Guild
that the channel is in.
read-only, inherited
-
hashCode
→ int
-
The hash code for this object.
read-only, inherited
-
id
→ Snowflake
-
ID of entity as Snowflake
final, inherited
-
isNsfw
→ bool
-
Indicates if channel is nsfw
read-only, inherited
-
name
→ String
-
The channel's name.
read-only, inherited
-
parentChannel
→ Cacheable<Snowflake, GuildChannel>?
-
Id of parent channel
read-only, inherited
-
permissionOverrides
→ List<IPermissionsOverrides>
-
Permission override for channel
read-only, inherited
-
position
→ int
-
Relative position of channel in context of channel list
read-only, inherited
-
rtcRegion
→ String?
-
Channel voice region id, automatic when set to null
read-only
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
read-only, inherited
-
userLimit
→ int?
-
The channel's user limit.
read-only
Methods
-
connect({bool selfMute = false, bool selfDeafen = false})
→ void
-
Connects client to channel
-
createActivityInvite(VoiceActivityType type, {int? maxAge, int? maxUses})
→ Future<IInvite>
-
Creates activity invite. Currently in beta
-
createInvite({int? maxAge, int? maxUses, bool? temporary, bool? unique, String? auditReason})
→ Future<IInvite>
-
Creates new
IInvite
for IChannel and returns it"s instance
inherited
-
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
-
disconnect()
→ void
-
Disconnects use from channel.
-
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
Invite
s
inherited
-
noSuchMethod(Invocation invocation)
→ dynamic
-
Invoked when a non-existent method or property is accessed.
inherited
-
toString()
→ String
-
A string representation of this object.
inherited
Operators
-
operator ==(dynamic other)
→ bool
-
The equality operator.
inherited