ttv::social::PresenceSettings Struct Reference

#include <socialtypes.h>

Public Types
enum	AvailabilityOverride { AvailabilityOverride::None, AvailabilityOverride::Offline, AvailabilityOverride::Away, AvailabilityOverride::Busy }

Public Member Functions
	PresenceSettings ()
bool	operator== (const PresenceSettings &rhs)
bool	operator!= (const PresenceSettings &rhs)

Public Attributes
AvailabilityOverride	availabilityOverride
bool	shareActivity: 1

Detailed Description

Settings that describe the client's desired presence posting behavior. The server exposes and synchronizes these settings between clients so that the clients know how they should post presence.

Member Enumeration Documentation

AvailabilityOverride

enum ttv::social::PresenceSettings::AvailabilityOverride

strong

Represents possible values a user can override their availability with through PresenceSettings

Enumerator
None
Offline
Away
Busy

Constructor & Destructor Documentation

PresenceSettings()

ttv::social::PresenceSettings::PresenceSettings

(

)

Member Function Documentation

operator!=()

bool ttv::social::PresenceSettings::operator!=

(

const PresenceSettings &

rhs

)

operator==()

bool ttv::social::PresenceSettings::operator==

(

const PresenceSettings &

rhs

)

Member Data Documentation

availabilityOverride

AvailabilityOverride ttv::social::PresenceSettings::availabilityOverride

A user can explicitly set how they want their availability to appear to their friends, ignoring the state of their sessions. If a user sets their presence as AvailabilityOverride::None, that is considered to be no override, causing their sessions to determine their availability.

shareActivity

bool ttv::social::PresenceSettings::shareActivity

Whether the client should include their current activity when posting presence.

---

The documentation for this struct was generated from the following file:

• modules/social/social_common/include/twitchsdk/social/socialtypes.h