Class SocketGuildUser

Represents a WebSocket-based guild user.

Inheritance

Object

SocketEntity<UInt64>

SocketUser

SocketGuildUser

Implements

IGuildUser

IUser

ISnowflakeEntity

IEntity<UInt64>

IMentionable

IPresence

IVoiceState

Inherited Members

SocketUser.CreatedAt

SocketUser.Discriminator

SocketUser.Mention

SocketUser.Activity

SocketUser.Status

SocketUser.MutualGuilds

SocketUser.GetOrCreateDMChannelAsync(RequestOptions)

SocketUser.GetAvatarUrl(ImageFormat, UInt16)

SocketUser.GetDefaultAvatarUrl()

SocketUser.ToString()

SocketEntity<UInt64>.Id

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Namespace: Discord.WebSocket

Assembly: Discord.Net.WebSocket.dll

Syntax

public class SocketGuildUser : SocketUser, IGuildUser, IUser, ISnowflakeEntity, IEntity<ulong>, IMentionable, IPresence, IVoiceState

Properties

AudioStream

Declaration

public AudioInStream AudioStream { get; }

Property Value

Type	Description
AudioInStream

AvatarId

Gets the ID of this user's avatar.

Declaration

public override string AvatarId { get; }

Property Value

Type	Description
String

Overrides

SocketUser.AvatarId

DiscriminatorValue

Gets the per-username unique ID for this user.

Declaration

public override ushort DiscriminatorValue { get; }

Property Value

Type	Description
UInt16

Overrides

SocketUser.DiscriminatorValue

Guild

Gets the guild the user is in.

Declaration

public SocketGuild Guild { get; }

Property Value

Type	Description
SocketGuild

GuildPermissions

Gets the guild-level permissions for this user.

Declaration

public GuildPermissions GuildPermissions { get; }

Property Value

Type	Description
GuildPermissions	A GuildPermissions structure for this user, representing what permissions this user has in the guild.

Hierarchy

Returns the position of the user within the role hierarchy.

Declaration

public int Hierarchy { get; }

Property Value

Type	Description
Int32

Remarks

The returned value equal to the position of the highest role the user has, or MaxValue if user is the server owner.

IsBot

Gets a value that indicates whether this user is a bot user.

Declaration

public override bool IsBot { get; }

Property Value

Type	Description
Boolean	true if the user is a bot; otherwise false.

Overrides

SocketUser.IsBot

IsDeafened

Returns true if the guild has deafened this user.

Declaration

public bool IsDeafened { get; }

Property Value

Type	Description
Boolean

IsMuted

Returns true if the guild has muted this user.

Declaration

public bool IsMuted { get; }

Property Value

Type	Description
Boolean

IsSelfDeafened

Returns true if this user has marked themselves as deafened.

Declaration

public bool IsSelfDeafened { get; }

Property Value

Type	Description
Boolean

IsSelfMuted

Returns true if this user has marked themselves as muted.

Declaration

public bool IsSelfMuted { get; }

Property Value

Type	Description
Boolean

IsSuppressed

Returns true if the guild is temporarily blocking audio to/from this user.

Declaration

public bool IsSuppressed { get; }

Property Value

Type	Description
Boolean

IsWebhook

Gets a value that indicates whether this user is a webhook user.

Declaration

public override bool IsWebhook { get; }

Property Value

Type	Description
Boolean	true if the user is a webhook; otherwise false.

Overrides

SocketUser.IsWebhook

JoinedAt

Gets when this user joined the guild.

Declaration

public DateTimeOffset? JoinedAt { get; }

Property Value

Type	Description
Nullable<DateTimeOffset>	A DateTimeOffset representing the time of which the user has joined the guild; null when it cannot be obtained.

Nickname

Gets the nickname for this user.

Declaration

public string Nickname { get; }

Property Value

Type	Description
String	A string representing the nickname of the user; null if none is set.

Roles

Returns a collection of roles that the user possesses.

Declaration

public IReadOnlyCollection<SocketRole> Roles { get; }

Property Value

Type	Description
IReadOnlyCollection<SocketRole>

Username

Gets the username for this user.

Declaration

public override string Username { get; }

Property Value

Type	Description
String

Overrides

SocketUser.Username

VoiceChannel

Returns the voice channel the user is in, or null if none.

Declaration

public SocketVoiceChannel VoiceChannel { get; }

Property Value

Type	Description
SocketVoiceChannel

VoiceSessionId

Gets the unique identifier for this user's voice session.

Declaration

public string VoiceSessionId { get; }

Property Value

Type	Description
String

VoiceState

Gets the voice connection status of the user if any.

Declaration

public SocketVoiceState? VoiceState { get; }

Property Value

Type	Description
Nullable<SocketVoiceState>	A SocketVoiceState representing the user's voice status; null if the user is not connected to a voice channel.

Methods

AddRoleAsync(IRole, RequestOptions)

Adds the specified role to this user in this guild.

Declaration

public Task AddRoleAsync(IRole role, RequestOptions options = null)

Parameters

Type	Name	Description
IRole	role	The role to be added to the user.
RequestOptions	options	The options to be used when sending the request.

Returns

Type	Description
Task	A task that represents the asynchronous role addition operation.

AddRolesAsync(IEnumerable<IRole>, RequestOptions)

Adds the specified roles to this user in this guild.

Declaration

public Task AddRolesAsync(IEnumerable<IRole> roles, RequestOptions options = null)

Parameters

Type	Name	Description
IEnumerable<IRole>	roles	The roles to be added to the user.
RequestOptions	options	The options to be used when sending the request.

Returns

Type	Description
Task	A task that represents the asynchronous role addition operation.

GetPermissions(IGuildChannel)

Gets the level permissions granted to this user to a given channel.

Declaration

public ChannelPermissions GetPermissions(IGuildChannel channel)

Parameters

Type	Name	Description
IGuildChannel	channel	The channel to get the permission from.

Returns

Type	Description
ChannelPermissions	A ChannelPermissions structure representing the permissions that a user has in the specified channel.

KickAsync(String, RequestOptions)

Kicks this user from this guild.

Declaration

public Task KickAsync(string reason = null, RequestOptions options = null)

Parameters

Type	Name	Description
String	reason	The reason for the kick which will be recorded in the audit log.
RequestOptions	options	The options to be used when sending the request.

Returns

Type	Description
Task	A task that represents the asynchronous kick operation.

ModifyAsync(Action<GuildUserProperties>, RequestOptions)

Modifies this user's properties in this guild.

Declaration

public Task ModifyAsync(Action<GuildUserProperties> func, RequestOptions options = null)

Parameters

Type	Name	Description
Action<GuildUserProperties>	func	The delegate containing the properties to modify the user with.
RequestOptions	options	The options to be used when sending the request.

Returns

Type	Description
Task	A task that represents the asynchronous modification operation.

See Also

GuildUserProperties

RemoveRoleAsync(IRole, RequestOptions)

Removes the specified role from this user in this guild.

Declaration

public Task RemoveRoleAsync(IRole role, RequestOptions options = null)

Parameters

Type	Name	Description
IRole	role	The role to be removed from the user.
RequestOptions	options	The options to be used when sending the request.

Returns

Type	Description
Task	A task that represents the asynchronous role removal operation.

RemoveRolesAsync(IEnumerable<IRole>, RequestOptions)

Removes the specified roles from this user in this guild.

Declaration

public Task RemoveRolesAsync(IEnumerable<IRole> roles, RequestOptions options = null)

Parameters

Type	Name	Description
IEnumerable<IRole>	roles	The roles to be removed from the user.
RequestOptions	options	The options to be used when sending the request.

Returns

Type	Description
Task	A task that represents the asynchronous role removal operation.

Explicit Interface Implementations

IGuildUser.Guild

Gets the guild for this user.

Declaration

IGuild IGuildUser.Guild { get; }

Returns

Type	Description
IGuild	A guild object that this user belongs to.

IGuildUser.GuildId

Gets the ID of the guild for this user.

Declaration

ulong IGuildUser.GuildId { get; }

Returns

Type	Description
UInt64	An UInt64 representing the snowflake identifier of the guild that this user belongs to.

IGuildUser.RoleIds

Gets a collection of IDs for the roles that this user currently possesses in the guild.

Declaration

IReadOnlyCollection<ulong> IGuildUser.RoleIds { get; }

Returns

Type	Description
IReadOnlyCollection<UInt64>	A read-only collection of UInt64, each representing a snowflake identifier for a role that this user posesses.

IVoiceState.VoiceChannel

Gets the voice channel this user is currently in, or null if none.

Declaration

IVoiceChannel IVoiceState.VoiceChannel { get; }

Returns

Type	Description
IVoiceChannel

Implements

IGuildUser

IUser

ISnowflakeEntity

IEntity<TId>

IMentionable

IPresence

IVoiceState