discordpp::DeviceAuthorizationArgs Class Reference

Detailed Description

Arguments to the Client::GetTokenFromDevice function.

Public Member Functions
	DeviceAuthorizationArgs (DeviceAuthorizationArgs &&other) noexcept
	Move constructor for DeviceAuthorizationArgs.
DeviceAuthorizationArgs &	operator= (DeviceAuthorizationArgs &&other) noexcept
	Move assignment operator for DeviceAuthorizationArgs.
	operator bool () const
	Returns true if the instance contains a valid object.
	DeviceAuthorizationArgs (const DeviceAuthorizationArgs &arg0)
	Copy constructor for DeviceAuthorizationArgs.
DeviceAuthorizationArgs &	operator= (const DeviceAuthorizationArgs &arg0)
	Copy assignment operator for DeviceAuthorizationArgs.
uint64_t	ClientId () const
	Optional. The Discord application ID for your game. Defaults to the value set by Client::SetApplicationId.
void	SetClientId (uint64_t ClientId)
	Setter for DeviceAuthorizationArgs::ClientId.
std::string	Scopes () const
	Scopes is a space separated string of the oauth scopes your game is requesting.
void	SetScopes (std::string Scopes)
	Setter for DeviceAuthorizationArgs::Scopes.

Static Public Attributes
static const DeviceAuthorizationArgs	nullobj
	Uninitialized instance of DeviceAuthorizationArgs.

Constructor & Destructor Documentation

DeviceAuthorizationArgs() [1/2]

discordpp::DeviceAuthorizationArgs::DeviceAuthorizationArgs ( DeviceAuthorizationArgs && other )

noexcept

Move constructor for DeviceAuthorizationArgs.

DeviceAuthorizationArgs() [2/2]

discordpp::DeviceAuthorizationArgs::DeviceAuthorizationArgs

(

const DeviceAuthorizationArgs &

arg0

)

Copy constructor for DeviceAuthorizationArgs.

Member Function Documentation

ClientId()

uint64_t discordpp::DeviceAuthorizationArgs::ClientId

(

)

const

Optional. The Discord application ID for your game. Defaults to the value set by Client::SetApplicationId.

operator bool()

discordpp::DeviceAuthorizationArgs::operator bool ( ) const

inline

Returns true if the instance contains a valid object.

operator=() [1/2]

DeviceAuthorizationArgs & discordpp::DeviceAuthorizationArgs::operator=

(

const DeviceAuthorizationArgs &

arg0

)

Copy assignment operator for DeviceAuthorizationArgs.

operator=() [2/2]

DeviceAuthorizationArgs & discordpp::DeviceAuthorizationArgs::operator= ( DeviceAuthorizationArgs && other )

noexcept

Move assignment operator for DeviceAuthorizationArgs.

Scopes()

std::string discordpp::DeviceAuthorizationArgs::Scopes

(

)

const

Scopes is a space separated string of the oauth scopes your game is requesting.

Most games should just pass in Client::GetDefaultCommunicationScopes or Client::GetDefaultPresenceScopes which will include these scopes, respectively: openid sdk.social_layer or openid sdk.social_layer_presence

sdk.social_layer and sdk.social_layer_presence automatically expand to include all the necessary scopes for the integration.

You can pass in additional scopes if you need to, but as a general rule you should only request the scopes you actually need, and the user will need to grant access to those additional scopes as well.

SetClientId()

void discordpp::DeviceAuthorizationArgs::SetClientId

(

uint64_t

ClientId

)

Setter for DeviceAuthorizationArgs::ClientId.

SetScopes()

void discordpp::DeviceAuthorizationArgs::SetScopes

(

std::string

Scopes

)

Setter for DeviceAuthorizationArgs::Scopes.

Member Data Documentation

nullobj

const DeviceAuthorizationArgs discordpp::DeviceAuthorizationArgs::nullobj

static

Uninitialized instance of DeviceAuthorizationArgs.