Class SocketEntitlement

Namespace

Discord.WebSocket

Assembly

Discord.Net.WebSocket.dll

public class SocketEntitlement : SocketEntity<ulong>, IEntitlement, ISnowflakeEntity, IEntity<ulong>

Inheritance

object

SocketEntity<ulong>

SocketEntitlement

Implements

IEntitlement

ISnowflakeEntity

IEntity<ulong>

Inherited Members

SocketEntity<ulong>.Id

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ApplicationId

Gets the ID of the parent application.

public ulong ApplicationId { get; }

Property Value

ulong

CreatedAt

Gets when the snowflake was created.

public DateTimeOffset CreatedAt { get; }

Property Value

DateTimeOffset

A DateTimeOffset representing when the entity was first created.

EndsAt

Gets the end date at which the entitlement is no longer valid.

public DateTimeOffset? EndsAt { get; }

Property Value

DateTimeOffset?

Remarks

null when using test entitlements.

Guild

Gets the ID of the guild that is granted access to the entitlement's SKU.

public Cacheable<SocketGuild, RestGuild, IGuild, ulong>? Guild { get; }

Property Value

Cacheable<SocketGuild, RestGuild, IGuild, ulong>?

Remarks

null if the entitlement is for a user.

IsConsumed

Gets whether this entitlement has been consumed.

public bool IsConsumed { get; }

Property Value

bool

Remarks

Not applicable for App Subscriptions.

SkuId

Gets the ID of the SKU this entitlement is for.

public ulong SkuId { get; }

Property Value

ulong

StartsAt

Gets the start date at which the entitlement is valid.

public DateTimeOffset? StartsAt { get; }

Property Value

DateTimeOffset?

Remarks

null when using test entitlements.

Type

Gets the type of the entitlement.

public EntitlementType Type { get; }

Property Value

EntitlementType

User

Gets the ID of the user that is granted access to the entitlement's SKU.

public Cacheable<SocketUser, RestUser, IUser, ulong>? User { get; }

Property Value

Cacheable<SocketUser, RestUser, IUser, ulong>?

Remarks

null if the entitlement is for a guild.