Discord Social SDK
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
discordpp::ActivityParty Class Reference

Detailed Description

See also
Activity

Public Member Functions

 ActivityParty (ActivityParty &&other) noexcept
 Move constructor for ActivityParty.
 
ActivityPartyoperator= (ActivityParty &&other) noexcept
 Move assignment operator for ActivityParty.
 
 operator bool () const
 Returns true if the instance contains a valid object.
 
 ActivityParty (const ActivityParty &arg0)
 Copy constructor for ActivityParty.
 
ActivityPartyoperator= (const ActivityParty &arg0)
 Copy assignment operator for ActivityParty.
 
std::string Id () const
 Specifies the id of the party. "Party" is used colloquially to refer to a group of players in a shared context. This could be a lobby id, server id, team id, etc.
 
void SetId (std::string Id)
 Setter for ActivityParty::Id.
 
int32_t CurrentSize () const
 The number of people currently in the party, must be at least 1.
 
void SetCurrentSize (int32_t CurrentSize)
 Setter for ActivityParty::CurrentSize.
 
int32_t MaxSize () const
 The maximum number of people that can be in the party, must be at least 0. When 0, the UI will not display a maximum.
 
void SetMaxSize (int32_t MaxSize)
 Setter for ActivityParty::MaxSize.
 
discordpp::ActivityPartyPrivacy Privacy () const
 The privacy of the party.
 
void SetPrivacy (discordpp::ActivityPartyPrivacy Privacy)
 Setter for ActivityParty::Privacy.
 

Static Public Attributes

static const ActivityParty nullobj
 Uninitialized instance of ActivityParty.
 

Constructor & Destructor Documentation

◆ ActivityParty() [1/2]

discordpp::ActivityParty::ActivityParty ( ActivityParty && other)
noexcept

Move constructor for ActivityParty.

◆ ActivityParty() [2/2]

discordpp::ActivityParty::ActivityParty ( const ActivityParty & arg0)

Copy constructor for ActivityParty.

Member Function Documentation

◆ CurrentSize()

int32_t discordpp::ActivityParty::CurrentSize ( ) const

The number of people currently in the party, must be at least 1.

◆ Id()

std::string discordpp::ActivityParty::Id ( ) const

Specifies the id of the party. "Party" is used colloquially to refer to a group of players in a shared context. This could be a lobby id, server id, team id, etc.

All party members should specify a RichPresence update using the same party id so that the Discord client knows how to group them together. If specified, must be a string between 2 and 128 characters.

◆ MaxSize()

int32_t discordpp::ActivityParty::MaxSize ( ) const

The maximum number of people that can be in the party, must be at least 0. When 0, the UI will not display a maximum.

◆ operator bool()

discordpp::ActivityParty::operator bool ( ) const
inline

Returns true if the instance contains a valid object.

◆ operator=() [1/2]

ActivityParty & discordpp::ActivityParty::operator= ( ActivityParty && other)
noexcept

Move assignment operator for ActivityParty.

◆ operator=() [2/2]

ActivityParty & discordpp::ActivityParty::operator= ( const ActivityParty & arg0)

Copy assignment operator for ActivityParty.

◆ Privacy()

discordpp::ActivityPartyPrivacy discordpp::ActivityParty::Privacy ( ) const

The privacy of the party.

◆ SetCurrentSize()

void discordpp::ActivityParty::SetCurrentSize ( int32_t CurrentSize)

◆ SetId()

void discordpp::ActivityParty::SetId ( std::string Id)

Setter for ActivityParty::Id.

◆ SetMaxSize()

void discordpp::ActivityParty::SetMaxSize ( int32_t MaxSize)

◆ SetPrivacy()

void discordpp::ActivityParty::SetPrivacy ( discordpp::ActivityPartyPrivacy Privacy)

Member Data Documentation

◆ nullobj

const ActivityParty discordpp::ActivityParty::nullobj
static

Uninitialized instance of ActivityParty.