Class SocketUserMessage

Represents a WebSocket-based message sent by a user.

Inheritance
System.Object
SocketEntity<System.UInt64>
SocketMessage
SocketUserMessage
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Discord.WebSocket
Assembly: Discord.Net.WebSocket.dll
Syntax
public class SocketUserMessage : SocketMessage, IUserMessage, IMessage, ISnowflakeEntity, IEntity<ulong>, IDeletable

Properties

| Improve this Doc View Source

Attachments

Declaration
public override IReadOnlyCollection<Attachment> Attachments { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyCollection<Attachment>
Overrides
| Improve this Doc View Source

EditedTimestamp

Declaration
public override DateTimeOffset? EditedTimestamp { get; }
Property Value
Type Description
System.Nullable<System.DateTimeOffset>
Overrides
| Improve this Doc View Source

Embeds

Declaration
public override IReadOnlyCollection<Embed> Embeds { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyCollection<Embed>
Overrides
| Improve this Doc View Source

IsPinned

Declaration
public override bool IsPinned { get; }
Property Value
Type Description
System.Boolean
Overrides
| Improve this Doc View Source

IsSuppressed

Declaration
public override bool IsSuppressed { get; }
Property Value
Type Description
System.Boolean
Overrides
| Improve this Doc View Source

IsTTS

Declaration
public override bool IsTTS { get; }
Property Value
Type Description
System.Boolean
Overrides
| Improve this Doc View Source

MentionedChannels

Declaration
public override IReadOnlyCollection<SocketGuildChannel> MentionedChannels { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyCollection<SocketGuildChannel>
Overrides
| Improve this Doc View Source

MentionedRoles

Declaration
public override IReadOnlyCollection<SocketRole> MentionedRoles { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyCollection<SocketRole>
Overrides
| Improve this Doc View Source

MentionedUsers

Declaration
public override IReadOnlyCollection<SocketUser> MentionedUsers { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyCollection<SocketUser>
Overrides
| Improve this Doc View Source

Tags

Declaration
public override IReadOnlyCollection<ITag> Tags { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyCollection<ITag>
Overrides

Methods

| Improve this Doc View Source

ModifyAsync(Action<MessageProperties>, RequestOptions)

Declaration
public Task ModifyAsync(Action<MessageProperties> func, RequestOptions options = null)
Parameters
Type Name Description
System.Action<MessageProperties> func
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task
Exceptions
Type Condition
System.InvalidOperationException

Only the author of a message may modify the message.
System.ArgumentOutOfRangeException

Message content is too long, length must be less or equal to MaxMessageSize.
| Improve this Doc View Source

ModifySuppressionAsync(Boolean, RequestOptions)

Declaration
public Task ModifySuppressionAsync(bool suppressEmbeds, RequestOptions options = null)
Parameters
Type Name Description
System.Boolean suppressEmbeds
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

PinAsync(RequestOptions)

Declaration
public Task PinAsync(RequestOptions options = null)
Parameters
Type Name Description
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

Resolve(TagHandling, TagHandling, TagHandling, TagHandling, TagHandling)

Declaration
public string Resolve(TagHandling userHandling = TagHandling.Name, TagHandling channelHandling = TagHandling.Name, TagHandling roleHandling = TagHandling.Name, TagHandling everyoneHandling = TagHandling.Ignore, TagHandling emojiHandling = TagHandling.Name)
Parameters
Type Name Description
TagHandling userHandling
TagHandling channelHandling
TagHandling roleHandling
TagHandling everyoneHandling
TagHandling emojiHandling
Returns
Type Description
System.String
| Improve this Doc View Source

Resolve(Int32, TagHandling, TagHandling, TagHandling, TagHandling, TagHandling)

Declaration
public string Resolve(int startIndex, TagHandling userHandling = TagHandling.Name, TagHandling channelHandling = TagHandling.Name, TagHandling roleHandling = TagHandling.Name, TagHandling everyoneHandling = TagHandling.Ignore, TagHandling emojiHandling = TagHandling.Name)
Parameters
Type Name Description
System.Int32 startIndex
TagHandling userHandling
TagHandling channelHandling
TagHandling roleHandling
TagHandling everyoneHandling
TagHandling emojiHandling
Returns
Type Description
System.String
| Improve this Doc View Source

UnpinAsync(RequestOptions)

Declaration
public Task UnpinAsync(RequestOptions options = null)
Parameters
Type Name Description
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task

Implements