Show / Hide Table of Contents

Class SocketWebhookUser

Represents a WebSocket-based webhook user.

Inheritance
System.Object
SocketEntity<System.UInt64>
SocketUser
SocketWebhookUser
Implements
IWebhookUser
IGuildUser
IUser
ISnowflakeEntity
IEntity<System.UInt64>
IMentionable
IPresence
IVoiceState
Inherited Members
SocketUser.CreatedAt
SocketUser.Discriminator
SocketUser.Mention
SocketUser.Activity
SocketUser.Status
SocketUser.ActiveClients
SocketUser.MutualGuilds
SocketUser.GetOrCreateDMChannelAsync(RequestOptions)
SocketUser.GetAvatarUrl(ImageFormat, UInt16)
SocketUser.GetDefaultAvatarUrl()
SocketUser.ToString()
SocketEntity<UInt64>.Id
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 SocketWebhookUser : SocketUser, IWebhookUser, IGuildUser, IUser, ISnowflakeEntity, IEntity<ulong>, IMentionable, IPresence, IVoiceState

Properties

| Improve this Doc View Source

AvatarId

Declaration
public override string AvatarId { get; }
Property Value
Type Description
System.String
Overrides
SocketUser.AvatarId
| Improve this Doc View Source

DiscriminatorValue

Declaration
public override ushort DiscriminatorValue { get; }
Property Value
Type Description
System.UInt16
Overrides
SocketUser.DiscriminatorValue
| Improve this Doc View Source

Guild

Gets the guild of this webhook.

Declaration
public SocketGuild Guild { get; }
Property Value
Type Description
SocketGuild
| Improve this Doc View Source

IsBot

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

IsWebhook

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

Username

Declaration
public override string Username { get; }
Property Value
Type Description
System.String
Overrides
SocketUser.Username
| Improve this Doc View Source

WebhookId

Declaration
public ulong WebhookId { get; }
Property Value
Type Description
System.UInt64

Explicit Interface Implementations

| Improve this Doc View Source

IGuildUser.AddRoleAsync(IRole, RequestOptions)

Declaration
Task IGuildUser.AddRoleAsync(IRole role, RequestOptions options)
Parameters
Type Name Description
IRole role
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task
Exceptions
Type Condition
System.NotSupportedException

Roles are not supported on webhook users.

| Improve this Doc View Source

IGuildUser.AddRolesAsync(IEnumerable<IRole>, RequestOptions)

Declaration
Task IGuildUser.AddRolesAsync(IEnumerable<IRole> roles, RequestOptions options)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<IRole> roles
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task
Exceptions
Type Condition
System.NotSupportedException

Roles are not supported on webhook users.

| Improve this Doc View Source

IGuildUser.GetPermissions(IGuildChannel)

Declaration
ChannelPermissions IGuildUser.GetPermissions(IGuildChannel channel)
Parameters
Type Name Description
IGuildChannel channel
Returns
Type Description
ChannelPermissions
| Improve this Doc View Source

IGuildUser.Guild

Declaration
IGuild IGuildUser.Guild { get; }
Returns
Type Description
IGuild
| Improve this Doc View Source

IGuildUser.GuildId

Declaration
ulong IGuildUser.GuildId { get; }
Returns
Type Description
System.UInt64
| Improve this Doc View Source

IGuildUser.GuildPermissions

Declaration
GuildPermissions IGuildUser.GuildPermissions { get; }
Returns
Type Description
GuildPermissions
| Improve this Doc View Source

IGuildUser.JoinedAt

Declaration
DateTimeOffset? IGuildUser.JoinedAt { get; }
Returns
Type Description
System.Nullable<System.DateTimeOffset>
| Improve this Doc View Source

IGuildUser.KickAsync(String, RequestOptions)

Declaration
Task IGuildUser.KickAsync(string reason, RequestOptions options)
Parameters
Type Name Description
System.String reason
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task
Exceptions
Type Condition
System.NotSupportedException

Webhook users cannot be kicked.

| Improve this Doc View Source

IGuildUser.ModifyAsync(Action<GuildUserProperties>, RequestOptions)

Declaration
Task IGuildUser.ModifyAsync(Action<GuildUserProperties> func, RequestOptions options)
Parameters
Type Name Description
System.Action<GuildUserProperties> func
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task
Exceptions
Type Condition
System.NotSupportedException

Webhook users cannot be modified.

| Improve this Doc View Source

IGuildUser.Nickname

Declaration
string IGuildUser.Nickname { get; }
Returns
Type Description
System.String
| Improve this Doc View Source

IGuildUser.PremiumSince

Declaration
DateTimeOffset? IGuildUser.PremiumSince { get; }
Returns
Type Description
System.Nullable<System.DateTimeOffset>
| Improve this Doc View Source

IGuildUser.RemoveRoleAsync(IRole, RequestOptions)

Declaration
Task IGuildUser.RemoveRoleAsync(IRole role, RequestOptions options)
Parameters
Type Name Description
IRole role
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task
Exceptions
Type Condition
System.NotSupportedException

Roles are not supported on webhook users.

| Improve this Doc View Source

IGuildUser.RemoveRolesAsync(IEnumerable<IRole>, RequestOptions)

Declaration
Task IGuildUser.RemoveRolesAsync(IEnumerable<IRole> roles, RequestOptions options)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<IRole> roles
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task
Exceptions
Type Condition
System.NotSupportedException

Roles are not supported on webhook users.

| Improve this Doc View Source

IGuildUser.RoleIds

Declaration
IReadOnlyCollection<ulong> IGuildUser.RoleIds { get; }
Returns
Type Description
System.Collections.Generic.IReadOnlyCollection<System.UInt64>
| Improve this Doc View Source

IVoiceState.IsDeafened

Declaration
bool IVoiceState.IsDeafened { get; }
Returns
Type Description
System.Boolean
| Improve this Doc View Source

IVoiceState.IsMuted

Declaration
bool IVoiceState.IsMuted { get; }
Returns
Type Description
System.Boolean
| Improve this Doc View Source

IVoiceState.IsSelfDeafened

Declaration
bool IVoiceState.IsSelfDeafened { get; }
Returns
Type Description
System.Boolean
| Improve this Doc View Source

IVoiceState.IsSelfMuted

Declaration
bool IVoiceState.IsSelfMuted { get; }
Returns
Type Description
System.Boolean
| Improve this Doc View Source

IVoiceState.IsStreaming

Declaration
bool IVoiceState.IsStreaming { get; }
Returns
Type Description
System.Boolean
| Improve this Doc View Source

IVoiceState.IsSuppressed

Declaration
bool IVoiceState.IsSuppressed { get; }
Returns
Type Description
System.Boolean
| Improve this Doc View Source

IVoiceState.VoiceChannel

Declaration
IVoiceChannel IVoiceState.VoiceChannel { get; }
Returns
Type Description
IVoiceChannel
| Improve this Doc View Source

IVoiceState.VoiceSessionId

Declaration
string IVoiceState.VoiceSessionId { get; }
Returns
Type Description
System.String

Implements

IWebhookUser
IGuildUser
IUser
ISnowflakeEntity
IEntity<TId>
IMentionable
IPresence
IVoiceState
  • Improve this Doc
  • View Source
Back to top Generated by DocFX