Table of Contents

Interface IUser

Namespace
Discord
Assembly
Discord.Net.Core.dll

Represents a generic user.

public interface IUser : ISnowflakeEntity, IEntity<ulong>, IMentionable, IPresence
Inherited Members
Extension Methods

Properties

AvatarDecorationHash

Gets the hash of the avatar decoration.

string AvatarDecorationHash { get; }

Property Value

string

Remarks

null if the user has no avatar decoration set.

AvatarDecorationSkuId

Gets the id of the avatar decoration's SKU.

ulong? AvatarDecorationSkuId { get; }

Property Value

ulong?

Remarks

null if the user has no avatar decoration set.

AvatarId

Gets the identifier of this user's avatar.

string AvatarId { get; }

Property Value

string

Discriminator

Gets the per-username unique ID for this user. This will return "0000" for users who have migrated to new username system.

string Discriminator { get; }

Property Value

string

DiscriminatorValue

Gets the per-username unique ID for this user. This will return 0 for users who have migrated to new username system.

ushort DiscriminatorValue { get; }

Property Value

ushort

GlobalName

Gets the user's display name, if it is set. For bots, this will get the application name.

string GlobalName { get; }

Property Value

string

Remarks

This property will be null if user has no display name set.

IsBot

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

bool IsBot { get; }

Property Value

bool

true if the user is a bot application; otherwise false.

Remarks

This property retrieves a value that indicates whether this user is a registered bot application (indicated by the blue BOT tag within the official chat client).

IsWebhook

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

bool IsWebhook { get; }

Property Value

bool

true if the user is a webhook; otherwise false.

PublicFlags

Gets the public flags that are applied to this user's account.

UserProperties? PublicFlags { get; }

Property Value

UserProperties?

The value of public flags for this user.

Remarks

This value is determined by bitwise OR-ing UserProperties values together.

Username

Gets the username for this user.

string Username { get; }

Property Value

string

Methods

CreateDMChannelAsync(RequestOptions)

Creates the direct message channel of this user.

Task<IDMChannel> CreateDMChannelAsync(RequestOptions options = null)

Parameters

options RequestOptions

The options to be used when sending the request.

Returns

Task<IDMChannel>

A task that represents the asynchronous operation for getting or creating a DM channel. The task result contains the DM channel associated with this user.

Examples

The following example attempts to send a direct message to the target user and logs the incident should it fail.

public async Task MessageUserAsync(IUser user)
{
    var channel = await user.CreateDMChannelAsync();
    try
    {
        await channel.SendMessageAsync("Awesome stuff!");
    }
    catch (Discord.Net.HttpException ex) when (ex.HttpCode == HttpStatusCode.Forbidden)
    {
        Console.WriteLine($"Boo, I cannot message {user}.");
    }
}

Remarks

This method is used to obtain or create a channel used to send a direct message.

warning

In event that the current user cannot send a message to the target user, a channel can and will still be created by Discord. However, attempting to send a message will yield a HttpException with a 403 as its HttpCode. There are currently no official workarounds by Discord.

GetAvatarDecorationUrl()

Gets the URL for user's avatar decoration.

string GetAvatarDecorationUrl()

Returns

string

Remarks

null if the user has no avatar decoration set.

GetAvatarUrl(ImageFormat, ushort)

Gets the avatar URL for this user, if it is set.

string GetAvatarUrl(ImageFormat format = ImageFormat.Auto, ushort size = 128)

Parameters

format ImageFormat

The format of the image.

size ushort

The size of the image that matches any power of two, ranging from 16 to 2048.

Returns

string

A string representing the user's avatar URL; null if the user has no avatar set.

Examples

The following example attempts to retrieve the user's current avatar and send it to a channel; if one is not set, a default avatar for this user will be returned instead.

Remarks

tip

If you wish to retrieve the display avatar for this user, consider using GetDisplayAvatarUrl(ImageFormat, ushort).

GetDefaultAvatarUrl()

Gets the default avatar URL for this user.

string GetDefaultAvatarUrl()

Returns

string

A string representing the user's default avatar URL.

Remarks

This avatar is auto-generated by Discord and consists of their logo combined with a random background color.

note

The calculation is always done by taking the remainder of this user's DiscriminatorValue divided by 5.

GetDisplayAvatarUrl(ImageFormat, ushort)

Gets the display avatar URL for this user.

string GetDisplayAvatarUrl(ImageFormat format = ImageFormat.Auto, ushort size = 128)

Parameters

format ImageFormat

The format of the image.

size ushort

The size of the image that matches any power of two, ranging from 16 to 2048.

Returns

string

A string representing the user's display avatar URL.

Remarks

This method will return GetDefaultAvatarUrl() if the user has no avatar set.

Edit this page