ICategoryGuildChannel class abstract
- Implemented types
Constructors
Properties
- channelType → ChannelType
-
Type of this channel
read-onlyinherited
- client → INyxx
-
Reference to client
read-onlyinherited
- createdAt → DateTime
-
Gets creation timestamp included in Snowflake
read-onlyinherited
-
guild
→ Cacheable<
Snowflake, IGuild> -
Id of
Guild
that the channel is in.read-onlyinherited - hashCode → int
-
The hash code for this object.
read-onlyinherited
- id → Snowflake
-
ID of entity as Snowflake
finalinherited
- isNsfw → bool
-
Indicates if channel is nsfw
read-onlyinherited
- name → String
-
The channel's name.
read-onlyinherited
-
parentChannel
→ Cacheable<
Snowflake, GuildChannel> ? -
Id of parent channel
read-onlyinherited
-
permissionOverrides
→ List<
IPermissionsOverrides> -
Permission override for channel
read-onlyinherited
- position → int
-
Relative position of channel in context of channel list
read-onlyinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-onlyinherited
Methods
-
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 ifentity
isn'tUser
orRole
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
orRole
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
sinherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
dynamic other) → bool -
The equality operator.
inherited