DMChannel class
Represents channel with another user.
- Inheritance
- Object
- SnowflakeEntity
- Channel
- DMChannel
- Implemented types
- Mixed in types
Properties
- client → Nyxx
-
Reference to client instance
final, inherited
- createdAt → DateTime
-
Gets creation timestamp included in Snowflake
read-only, inherited
- fileUploadLimit → int
-
File upload limit for channel in bytes. If channel is CachelessGuildChannel returns default value.
read-only, inherited
- hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- id → Snowflake
-
ID of entity as Snowflake
final, inherited
-
iterator
→ Iterator<
Message> -
Returns iterator for messages cache
read-only, inherited
- messages → MessageCache
-
A collection of messages sent to this channel.
final, late, inherited
-
onMessage
→ Stream<
MessageReceivedEvent> -
Sent when a new message is received.
final, late, inherited
-
onTyping
→ Stream<
TypingEvent> -
Emitted when user starts typing.
final, late, inherited
-
pinsUpdated
→ Stream<
ChannelPinsUpdateEvent> -
Emitted when channel pins are updated.
final, late, inherited
- recipient ↔ User
-
The recipient.
read / write
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
- type → ChannelType
-
The channel's type.
https://discordapp.com/developers/docs/resources/channel#channel-object-channel-types
final, inherited
Methods
-
bulkRemoveMessages(
Iterable< Message> messagesIds) → Future< void> -
Bulk removes many messages by its ids.
messagesIdsis list of messages ids to delete. [...]inherited -
delete(
{String auditReason} ) → Future< void> -
Deletes the channel.
Throws if bot cannot perform operation
inherited
-
dispose(
) → Future< void> -
Perform cleanup
inherited
-
getMessage(
Snowflake id, {bool ignoreCache: false} ) → Future< Message> -
Returns message with given
id. Allows to force fetch message from api withignoreCacheproperty. By default it checks if message is in cache and fetches from api if not.inherited -
getMessages(
{int limit: 50, Snowflake after, Snowflake before, Snowflake around} ) → Stream< Message> -
Gets several Message objects from API. Only one of
after,before,aroundcan be specified, otherwise, it will throw. [...]inherited -
noSuchMethod(
Invocation invocation ) → dynamic -
Invoked when a non-existent method or property is accessed. [...]
inherited
-
send(
{dynamic content, List< AttachmentBuilder> files,EmbedBuilder embed, bool tts, AllowedMentions allowedMentions, MessageBuilder builder} ) → Future< Message> -
Sends message to channel. Performs
toString()on thing passed tocontent. Allows to send embeds withembedfield. [...]inherited -
startTyping(
) → Future< void> -
Starts typing.
inherited
-
startTypingLoop(
) → void -
Loops
startTypinguntilstopTypingLoopis called.inherited -
stopTypingLoop(
) → void -
Stops a typing loop if one is running.
inherited
-
toString(
) → String -
Returns a string representation of this object.
inherited
Operators
-
operator ==(
Object other ) → bool -
The equality operator. [...]
inherited