Enum Scope

#[non_exhaustive]
pub enum Scope {
    Bot,
    ApplicationsCommands,
    ApplicationsCommandsUpdate,
    ApplicationsCommandsPermissionsUpdate,
    Identify,
    Email,
    Connections,
    Guilds,
    GuildsJoin,
    GuildsMembersRead,
    GdmJoin,
    Rpc,
    RpcNotificationsRead,
    RpcVoiceRead,
    RpcVoiceWrite,
    RpcActivitiesWrite,
    WebhookIncoming,
    MessagesRead,
    ApplicationsBuildsUpload,
    ApplicationsBuildsRead,
    ApplicationsStoreUpdate,
    ApplicationsEntitlements,
    ActivitiesRead,
    ActivitiesWrite,
    RelationshipsRead,
    DmChannelsRead,
    Voice,
    RoleConnectionsWrite,
}

The available OAuth2 Scopes.

Discord docs.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Bot

For oauth2 bots, this puts the bot in the user’s selected guild by default.

ApplicationsCommands

Allows your app to use Slash Commands in a guild.

ApplicationsCommandsUpdate

Allows your app to update its Slash Commands via this bearer token - client credentials grant only.

ApplicationsCommandsPermissionsUpdate

Allows your app to update permissions for its commands in a guild a user has permissions to.

Identify

Allows /users/@me without Self::Email.

Email

Enables /users/@me to return an email field.

Connections

Allows /users/@me/connections to return linked third-party accounts.

Guilds

Allows /users/@me/guilds to return basic information about all of a user’s guilds.

GuildsJoin

Allows /guilds/{guild.id}/members/{user.id} to be used for joining users to a guild.

GuildsMembersRead

Allows /users/@me/guilds/{guild.id}/member to return a user’s member information in a guild.

GdmJoin

Allows your app to join users to a group dm.

Rpc

For local rpc server access, this allows you to control a user’s local Discord client - requires Discord approval.

RpcNotificationsRead

For local rpc server api access, this allows you to receive notifications pushed out to the user - requires Discord approval.

RpcVoiceRead

RpcVoiceWrite

RpcActivitiesWrite

WebhookIncoming

This generates a webhook that is returned in the oauth token response for authorization code grants.

MessagesRead

For local rpc server api access, this allows you to read messages from all client channels (otherwise restricted to channels/guilds your app creates).

ApplicationsBuildsUpload

Allows your app to upload/update builds for a user’s applications - requires Discord approval.

ApplicationsBuildsRead

Allows your app to read build data for a user’s applications.

ApplicationsStoreUpdate

Allows your app to read and update store data (SKUs, store listings, achievements, etc.) for a user’s applications.

ApplicationsEntitlements

Allows your app to read entitlements for a user’s applications.

ActivitiesRead

Allows your app to fetch data from a user’s “Now Playing/Recently Played” list - requires Discord approval.

ActivitiesWrite

Allows your app to update a user’s activity - requires Discord approval (Not required for gamesdk activity manager!).

RelationshipsRead

Allows your app to know a user’s friends and implicit relationships - requires Discord approval.

DmChannelsRead

Allows your app to see information about the user’s DMs and group DMs - requires Discord approval.

Voice

Allows your app to connect to voice on user’s behalf and see all the voice members - requires Discord approval.

RoleConnectionsWrite

Allows your app to update a user’s connection and metadata for the app.

Trait Implementations

impl Clone for Scope

fn clone(&self) -> Scope

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Scope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Scope

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Scope

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

Formats the value using the given formatter.

impl Hash for Scope

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Scope

fn cmp(&self, other: &Scope) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Scope

fn eq(&self, other: &Scope) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Scope

fn partial_cmp(&self, other: &Scope) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Scope

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Scope

impl Eq for Scope

impl StructuralPartialEq for Scope