Class SocketGuildUser
Represents a WebSocket-based guild user.
Inheritance
SocketGuildUser
Assembly: Discord.Net.WebSocket.dll
Syntax
public class SocketGuildUser : SocketUser, IEntity<ulong>, IGuildUser, IUser, ISnowflakeEntity, IEntity<ulong>, IMentionable, IPresence, IVoiceState
Properties
|
Improve this Doc
View Source
AudioStream
Declaration
public AudioInStream AudioStream { get; }
Property Value
|
Improve this Doc
View Source
AvatarId
Declaration
public override string AvatarId { get; }
Property Value
Overrides
|
Improve this Doc
View Source
DiscriminatorValue
Declaration
public override ushort DiscriminatorValue { get; }
Property Value
Overrides
|
Improve this Doc
View Source
DisplayAvatarId
Declaration
public string DisplayAvatarId { get; }
Property Value
|
Improve this Doc
View Source
DisplayName
Gets the displayed name for this user.
Declaration
public string DisplayName { get; }
Property Value
Type |
Description |
String |
A string representing the display name of the user; If the nickname is null, this will be the username.
|
|
Improve this Doc
View Source
Flags
Gets the public flags for this guild member.
Declaration
public GuildUserFlags Flags { get; }
Property Value
|
Improve this Doc
View Source
GlobalName
Declaration
public override string GlobalName { get; }
Property Value
Overrides
|
Improve this Doc
View Source
Guild
Gets the guild the user is in.
Declaration
public SocketGuild Guild { get; }
Property Value
|
Improve this Doc
View Source
GuildAvatarId
Declaration
public string GuildAvatarId { get; }
Property Value
|
Improve this Doc
View Source
GuildPermissions
Gets the guild-level permissions for this user.
Declaration
public GuildPermissions GuildPermissions { get; }
Property Value
|
Improve this Doc
View Source
Hierarchy
Returns the position of the user within the role hierarchy.
Declaration
public int Hierarchy { get; }
Property Value
|
Improve this Doc
View Source
IsBot
Declaration
public override bool IsBot { get; }
Property Value
Overrides
|
Improve this Doc
View Source
IsDeafened
Declaration
public bool IsDeafened { get; }
Property Value
|
Improve this Doc
View Source
IsMuted
Declaration
public bool IsMuted { get; }
Property Value
|
Improve this Doc
View Source
IsPending
Declaration
public bool? IsPending { get; }
Property Value
|
Improve this Doc
View Source
IsSelfDeafened
Declaration
public bool IsSelfDeafened { get; }
Property Value
|
Improve this Doc
View Source
IsSelfMuted
Declaration
public bool IsSelfMuted { get; }
Property Value
|
Improve this Doc
View Source
IsStreaming
Declaration
public bool IsStreaming { get; }
Property Value
|
Improve this Doc
View Source
IsSuppressed
Declaration
public bool IsSuppressed { get; }
Property Value
|
Improve this Doc
View Source
IsVideoing
Declaration
public bool IsVideoing { get; }
Property Value
|
Improve this Doc
View Source
IsWebhook
Declaration
public override bool IsWebhook { get; }
Property Value
Overrides
|
Improve this Doc
View Source
JoinedAt
Declaration
public DateTimeOffset? JoinedAt { get; }
Property Value
Type |
Description |
Nullable<DateTimeOffset> |
|
|
Improve this Doc
View Source
Nickname
Declaration
public string Nickname { get; }
Property Value
|
Improve this Doc
View Source
PremiumSince
Declaration
public DateTimeOffset? PremiumSince { get; }
Property Value
Type |
Description |
Nullable<DateTimeOffset> |
|
|
Improve this Doc
View Source
RequestToSpeakTimestamp
Declaration
public DateTimeOffset? RequestToSpeakTimestamp { get; }
Property Value
Type |
Description |
Nullable<DateTimeOffset> |
|
|
Improve this Doc
View Source
Roles
Returns a collection of roles that the user possesses.
Declaration
public IReadOnlyCollection<SocketRole> Roles { get; }
Property Value
|
Improve this Doc
View Source
TimedOutUntil
Declaration
public DateTimeOffset? TimedOutUntil { get; }
Property Value
Type |
Description |
Nullable<DateTimeOffset> |
|
|
Improve this Doc
View Source
Username
Declaration
public override string Username { get; }
Property Value
Overrides
|
Improve this Doc
View Source
VoiceChannel
Returns the voice channel the user is in, or null if none.
Declaration
public SocketVoiceChannel VoiceChannel { get; }
Property Value
|
Improve this Doc
View Source
VoiceSessionId
Declaration
public string VoiceSessionId { get; }
Property Value
|
Improve this Doc
View Source
VoiceState
Gets the voice connection status of the user if any.
Declaration
public SocketVoiceState? VoiceState { get; }
Property Value
Methods
|
Improve this Doc
View Source
AddRoleAsync(IRole, RequestOptions)
Declaration
public Task AddRoleAsync(IRole role, RequestOptions options = null)
Parameters
Returns
|
Improve this Doc
View Source
AddRoleAsync(UInt64, RequestOptions)
Declaration
public Task AddRoleAsync(ulong roleId, RequestOptions options = null)
Parameters
Returns
|
Improve this Doc
View Source
AddRolesAsync(IEnumerable<IRole>, RequestOptions)
Declaration
public Task AddRolesAsync(IEnumerable<IRole> roles, RequestOptions options = null)
Parameters
Returns
|
Improve this Doc
View Source
AddRolesAsync(IEnumerable<UInt64>, RequestOptions)
Declaration
public Task AddRolesAsync(IEnumerable<ulong> roleIds, RequestOptions options = null)
Parameters
Returns
|
Improve this Doc
View Source
Declaration
public string GetDisplayAvatarUrl(ImageFormat format = ImageFormat.Auto, ushort size = null)
Parameters
Returns
|
Improve this Doc
View Source
Declaration
public string GetGuildAvatarUrl(ImageFormat format = ImageFormat.Auto, ushort size = null)
Parameters
Returns
|
Improve this Doc
View Source
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
|
Improve this Doc
View Source
KickAsync(String, RequestOptions)
Declaration
public Task KickAsync(string reason = null, RequestOptions options = null)
Parameters
Returns
|
Improve this Doc
View Source
ModifyAsync(Action<GuildUserProperties>, RequestOptions)
Declaration
public Task ModifyAsync(Action<GuildUserProperties> func, RequestOptions options = null)
Parameters
Returns
|
Improve this Doc
View Source
RemoveRoleAsync(IRole, RequestOptions)
Declaration
public Task RemoveRoleAsync(IRole role, RequestOptions options = null)
Parameters
Returns
|
Improve this Doc
View Source
RemoveRoleAsync(UInt64, RequestOptions)
Declaration
public Task RemoveRoleAsync(ulong roleId, RequestOptions options = null)
Parameters
Returns
|
Improve this Doc
View Source
RemoveRolesAsync(IEnumerable<IRole>, RequestOptions)
Declaration
public Task RemoveRolesAsync(IEnumerable<IRole> roles, RequestOptions options = null)
Parameters
Returns
|
Improve this Doc
View Source
RemoveRolesAsync(IEnumerable<UInt64>, RequestOptions)
Declaration
public Task RemoveRolesAsync(IEnumerable<ulong> roleIds, RequestOptions options = null)
Parameters
Returns
|
Improve this Doc
View Source
RemoveTimeOutAsync(RequestOptions)
Declaration
public Task RemoveTimeOutAsync(RequestOptions options = null)
Parameters
Returns
|
Improve this Doc
View Source
SetTimeOutAsync(TimeSpan, RequestOptions)
Declaration
public Task SetTimeOutAsync(TimeSpan span, RequestOptions options = null)
Parameters
Returns
Explicit Interface Implementations
|
Improve this Doc
View Source
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.
|
|
Improve this Doc
View Source
IVoiceState.VoiceChannel
Gets the voice channel this user is currently in.
Declaration
IVoiceChannel IVoiceState.VoiceChannel { get; }
Returns
Type |
Description |
IVoiceChannel |
A generic voice channel object representing the voice channel that the user is currently in; null
if none.
|
Implements