Class RestWebhookUser
Assembly: Discord.Net.Rest.dll​
View Source​
public class RestWebhookUser : RestUser, IUpdateable, IWebhookUser, IGuildUser, IUser, ISnowflakeEntity, IEntity<ulong>, IMentionable, IPresence, IVoiceState
Properties​
WebhookId​
Gets the ID of a webhook.
View Source​
public ulong WebhookId { get; }
PremiumSince​
Gets the date and time for when this user's guild boost began.
View Source​
public DateTimeOffset? PremiumSince { get; }
IsWebhook​
Gets a value that indicates whether this user is a webhook user.
View Source​
public override bool IsWebhook { get; }
GuildId​
Gets the ID of the guild for this user.
View Source​
public ulong GuildId { get; }
IGuildUser.Guild​
Gets the guild for this user.
View Source​
IGuild IGuildUser.Guild { get; }
IGuildUser.RoleIds​
Gets a collection of IDs for the roles that this user currently possesses in the guild.
View Source​
IReadOnlyCollection<ulong> IGuildUser.RoleIds { get; }
IGuildUser.JoinedAt​
Gets when this user joined the guild.
View Source​
DateTimeOffset? IGuildUser.JoinedAt { get; }
IGuildUser.Nickname​
Gets the nickname for this user.
View Source​
string IGuildUser.Nickname { get; }
IGuildUser.GuildAvatarId​
Gets the guild specific avatar for this users.
View Source​
string IGuildUser.GuildAvatarId { get; }
IGuildUser.IsPending​
Whether the user has passed the guild's Membership Screening requirements.
View Source​
bool? IGuildUser.IsPending { get; }
IGuildUser.Hierarchy​
Gets the users position within the role hierarchy.
View Source​
int IGuildUser.Hierarchy { get; }
IGuildUser.GuildPermissions​
Gets the guild-level permissions for this user.
View Source​
GuildPermissions IGuildUser.GuildPermissions { get; }
IVoiceState.IsDeafened​
Gets a value that indicates whether this user is deafened by the guild.
View Source​
bool IVoiceState.IsDeafened { get; }
IVoiceState.IsMuted​
Gets a value that indicates whether this user is muted (i.e. not permitted to speak via voice) by the guild.
View Source​
bool IVoiceState.IsMuted { get; }
IVoiceState.IsSelfDeafened​
Gets a value that indicates whether this user has marked themselves as deafened.
View Source​
bool IVoiceState.IsSelfDeafened { get; }
IVoiceState.IsSelfMuted​
Gets a value that indicates whether this user has marked themselves as muted (i.e. not permitted to speak via voice).
View Source​
bool IVoiceState.IsSelfMuted { get; }
IVoiceState.IsSuppressed​
Gets a value that indicates whether the user is muted by the current user.
View Source​
bool IVoiceState.IsSuppressed { get; }
IVoiceState.VoiceChannel​
Gets the voice channel this user is currently in.
View Source​
IVoiceChannel IVoiceState.VoiceChannel { get; }
IVoiceState.VoiceSessionId​
Gets the unique identifier for this user's voice session.
View Source​
string IVoiceState.VoiceSessionId { get; }
IVoiceState.IsStreaming​
Gets a value that indicates if this user is streaming in a voice channel.
View Source​
bool IVoiceState.IsStreaming { get; }
IVoiceState.RequestToSpeakTimestamp​
Gets the time on which the user requested to speak.
View Source​
DateTimeOffset? IVoiceState.RequestToSpeakTimestamp { get; }
Methods​
IGuildUser.GetGuildAvatarUrl(ImageFormat, UInt16)​
Gets the guild avatar URL for this user.
View Source​
string IGuildUser.GetGuildAvatarUrl(ImageFormat format, ushort size)
Returns​
System.String:
A string representing the user's avatar URL; null if the user does not have an avatar in place.
Parameters​
| Type | Name | Description |
|---|---|---|
| Discord.ImageFormat | format | The format to return. |
System.UInt16 | size | The size of the image to return in. This can be any power of two between 16 and 2048. |
IGuildUser.GetPermissions(IGuildChannel)​
Gets the level permissions granted to this user to a given channel.
View Source​
ChannelPermissions IGuildUser.GetPermissions(IGuildChannel channel)
Returns​
Discord.ChannelPermissions: A Discord.ChannelPermissions structure representing the permissions that a user has in the specified channel.
Parameters​
| Type | Name | Description |
|---|---|---|
| Discord.IGuildChannel | channel | The channel to get the permission from. |
IGuildUser.KickAsync(String, RequestOptions)​
Kicks this user from this guild.
View Source​
Task IGuildUser.KickAsync(string reason, RequestOptions options)
Returns​
System.Threading.Tasks.Task:
A task that represents the asynchronous kick operation.
Parameters​
| Type | Name | Description |
|---|---|---|
System.String | reason | The reason for the kick which will be recorded in the audit log. |
| Discord.RequestOptions | options | The options to be used when sending the request. |
IGuildUser.ModifyAsync(Action<GuildUserProperties>, RequestOptions)​
Modifies this user's properties in this guild.
View Source​
Task IGuildUser.ModifyAsync(Action<GuildUserProperties> func, RequestOptions options)
Returns​
System.Threading.Tasks.Task:
A task that represents the asynchronous modification operation.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Action<Discord.GuildUserProperties> | func | The delegate containing the properties to modify the user with. |
| Discord.RequestOptions | options | The options to be used when sending the request. |
IGuildUser.AddRoleAsync(UInt64, RequestOptions)​
Adds the specified role to this user in the guild.
View Source​
Task IGuildUser.AddRoleAsync(ulong role, RequestOptions options)
Returns​
System.Threading.Tasks.Task:
A task that represents the asynchronous role addition operation.
Parameters​
| Type | Name | Description |
|---|---|---|
System.UInt64 | role | |
| Discord.RequestOptions | options | The options to be used when sending the request. |
IGuildUser.AddRoleAsync(IRole, RequestOptions)​
Adds the specified role to this user in the guild.
View Source​
Task IGuildUser.AddRoleAsync(IRole role, RequestOptions options)
Returns​
System.Threading.Tasks.Task:
A task that represents the asynchronous role addition operation.
Parameters​
| Type | Name | Description |
|---|---|---|
| Discord.IRole | role | The role to be added to the user. |
| Discord.RequestOptions | options | The options to be used when sending the request. |
IGuildUser.AddRolesAsync(IEnumerable<UInt64>, RequestOptions)​
Adds the specified <code data-dev-comment-type="paramref" class="paramref">roleIds</code> to this user in the guild.
View Source​
Task IGuildUser.AddRolesAsync(IEnumerable<ulong> roles, RequestOptions options)
Returns​
System.Threading.Tasks.Task:
A task that represents the asynchronous role addition operation.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Collections.Generic.IEnumerable<System.UInt64> | roles | |
| Discord.RequestOptions | options | The options to be used when sending the request. |
IGuildUser.AddRolesAsync(IEnumerable<IRole>, RequestOptions)​
Adds the specified <code data-dev-comment-type="paramref" class="paramref">roles</code> to this user in the guild.
View Source​
Task IGuildUser.AddRolesAsync(IEnumerable<IRole> roles, RequestOptions options)
Returns​
System.Threading.Tasks.Task:
A task that represents the asynchronous role addition operation.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Collections.Generic.IEnumerable<Discord.IRole> | roles | The roles to be added to the user. |
| Discord.RequestOptions | options | The options to be used when sending the request. |
IGuildUser.RemoveRoleAsync(UInt64, RequestOptions)​
Removes the specified <code data-dev-comment-type="paramref" class="paramref">roleId</code> from this user in the guild.
View Source​
Task IGuildUser.RemoveRoleAsync(ulong role, RequestOptions options)
Returns​
System.Threading.Tasks.Task:
A task that represents the asynchronous role removal operation.
Parameters​
| Type | Name | Description |
|---|---|---|
System.UInt64 | role | |
| Discord.RequestOptions | options | The options to be used when sending the request. |
IGuildUser.RemoveRoleAsync(IRole, RequestOptions)​
Removes the specified <code data-dev-comment-type="paramref" class="paramref">role</code> from this user in the guild.
View Source​
Task IGuildUser.RemoveRoleAsync(IRole role, RequestOptions options)
Returns​
System.Threading.Tasks.Task:
A task that represents the asynchronous role removal operation.
Parameters​
| Type | Name | Description |
|---|---|---|
| Discord.IRole | role | The role to be removed from the user. |
| Discord.RequestOptions | options | The options to be used when sending the request. |
IGuildUser.RemoveRolesAsync(IEnumerable<UInt64>, RequestOptions)​
Removes the specified <code data-dev-comment-type="paramref" class="paramref">roleIds</code> from this user in the guild.
View Source​
Task IGuildUser.RemoveRolesAsync(IEnumerable<ulong> roles, RequestOptions options)
Returns​
System.Threading.Tasks.Task:
A task that represents the asynchronous role removal operation.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Collections.Generic.IEnumerable<System.UInt64> | roles | |
| Discord.RequestOptions | options | The options to be used when sending the request. |
IGuildUser.RemoveRolesAsync(IEnumerable<IRole>, RequestOptions)​
Removes the specified <code data-dev-comment-type="paramref" class="paramref">roles</code> from this user in the guild.
View Source​
Task IGuildUser.RemoveRolesAsync(IEnumerable<IRole> roles, RequestOptions options)
Returns​
System.Threading.Tasks.Task:
A task that represents the asynchronous role removal operation.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Collections.Generic.IEnumerable<Discord.IRole> | roles | The roles to be removed from the user. |
| Discord.RequestOptions | options | The options to be used when sending the request. |