Struct Entitlement 

pub struct Entitlement {
    pub id: EntitlementId,
    pub sku_id: SkuId,
    pub application_id: ApplicationId,
    pub user_id: Option<UserId>,
    pub kind: EntitlementKind,
    pub deleted: bool,
    pub starts_at: Option<Timestamp>,
    pub ends_at: Option<Timestamp>,
    pub guild_id: Option<GuildId>,
    pub consumed: Option<bool>,
}

Represents that a user or guild has access to a premium offering in the application.

Discord docs.

Fields

id: EntitlementId

The ID of the entitlement.

sku_id: SkuId

The ID of the corresponding SKU.

application_id: ApplicationId

The ID of the parent application.

user_id: Option<UserId>

The ID of the user that is granted access to the SKU.

kind: EntitlementKind

The type of the entitlement.

deleted: bool

Whether the entitlement has been deleted or not. Entitlements are not deleted when they expire.

starts_at: Option<Timestamp>

Start date after which the entitlement is valid. Not present when using test entitlements.

ends_at: Option<Timestamp>

End date after which the entitlement is no longer valid. Not present when using test entitlements.

guild_id: Option<GuildId>

The ID of the guild that is granted access to the SKU.

consumed: Option<bool>

For consumable items, whether or not the entitlement has been consumed.

Implementations

impl Entitlement

pub fn sku_url(&self) -> String

Returns a link to the SKU corresponding to this entitlement. See Sku::url for details.

pub async fn consume(&mut self, http: &Http) -> Result<()>

Available on crate feature model only.

For a one-time purchase consumable SKU (of kind Consumable), marks the entitlement as consumed. On success, the consumed field will be set to Some(true).

Errors

Will fail if the corresponding SKU is not of kind Consumable.

pub async fn list( cache_http: impl CacheHttp, builder: GetEntitlements, ) -> Result<Vec<Entitlement>>

Available on crate feature model only.

Returns all entitlements for the current application, active and expired.

Errors

May error due to an invalid response from discord, or network error.

Trait Implementations

impl Clone for Entitlement

fn clone(&self) -> Entitlement

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Entitlement

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Entitlement

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Entitlement

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.