Class Session

Nested Relationships

Nested Types

Inheritance Relationships

Base Type

Class Documentation

class Session : public axr::sdk::EntityBase

Public Functions

inline Session()
inline Session(const Session &value)
inline Session(Session &&value)
inline virtual ~Session()
inline virtual Session &SetProperties(const std::map<utility::string_t, Variant> &value) override

Sets the object’s underlying map of stored values.

inline virtual Session &SetProperties(std::map<utility::string_t, Variant> &&value) override

Sets the underlying map of stored values for the object.

inline virtual Session &SetProperty(const utility::char_t *name, const Variant &value) override

Sets the property of the given name to the provided value.

inline virtual Session &SetProperty(const utility::string_t &name, const Variant &value) override

Sets the property of the given name to the provided value.

inline virtual Session &SetRemoteUrl(const utility::string_t &url) override

Returns the URL of the remote server endpoint where the object is managed.

inline virtual Session &SetUid(const utility::string_t &value) override

Sets the value of the Uid property.

Parameters

value – The value to set.

inline virtual Session &SetDateCreated(const datetime &value) override

Sets the value of the DateCreated property.

Parameters

value – The value to set.

inline virtual Session &SetDateModified(const datetime &value) override

Sets the value of the DateModified property.

Parameters

value – The value to set.

inline virtual Session &SetVersion(const uint64_t value) override

Sets the value of the Version property.

Parameters

value – The value to set.

virtual void Validate() override
std::shared_ptr<Object> GetData() const

Returns the value of the Data property.

Session &SetData(std::shared_ptr<Object> value)

Sets the value of the Data property.

Parameters

value – The value to set.

utility::string_t GetHostUid() const

Returns the value of the HostUid property as a utility::string_t.

Session &SetHostUid(const utility::string_t &value)

Sets the value of the HostUid property.

Parameters

value – The value to set.

std::vector<utility::string_t> GetInvited() const

Returns the value of the Invited property.

Session &SetInvited(std::vector<utility::string_t> value)

Sets the value of the Invited property.

Parameters

value – The value to set.

int64_t GetNumTeams() const

Returns the value of the NumTeams property.

Session &SetNumTeams(const int64_t value)

Sets the value of the NumTeams property.

Parameters

value – The value to set.

utility::string_t GetPassword() const

Returns the value of the Password property as a utility::string_t.

Session &SetPassword(const utility::string_t &value)

Sets the value of the Password property.

Parameters

value – The value to set.

utility::string_t GetProductUid() const

The uid of the product that the zone is associated with.

Session &SetProductUid(const utility::string_t &value)

The uid of the product that the zone is associated with.

Parameters

value – The value to set.

utility::string_t GetServerUrl() const

Returns the value of the ServerUrl property as a utility::string_t.

Session &SetServerUrl(const utility::string_t &value)

Sets the value of the ServerUrl property.

Parameters

value – The value to set.

const Status *GetStatus() const

Returns the value of the Status property.

Session &SetStatus(const Status *value)

Sets the value of the Status property.

Parameters

value – The value to set.

std::vector<std::shared_ptr<Team>> GetTeams() const

Returns the value of the Teams property.

Session &SetTeams(const std::vector<std::shared_ptr<Team>> value)

Sets the value of the Teams property.

Parameters

value – The value to set.

int64_t GetTeamSize() const

Returns the value of the TeamSize property.

Session &SetTeamSize(const int64_t value)

Sets the value of the TeamSize property.

Parameters

value – The value to set.

const Type *GetType() const

Returns the type of session.

Session &SetType(const Type *value)

Sets the type of session.

std::vector<utility::string_t> GetUsers() const

Returns the value of the Users property.

Session &SetUsers(const std::vector<utility::string_t> value)

Sets the value of the Users property.

Parameters

value – The value to set.

const Visibility *GetVisibility() const

Returns the value of the Visibility property.

Session &SetVisibility(const Visibility *value)

Sets the value of the Visibility property.

Parameters

value – The value to set.

Public Static Functions

static inline const utility::char_t *ClassName()

Returns the fully qualified name of the class.

class Status : public axr::sdk::StringEnum<Status>

Public Static Attributes

static const Status *WAITING_FOR_PLAYERS
static const Status *IDLE
static const Status *IN_PROGRESS
static const Status *ENDED
class Type : public axr::sdk::StringEnum<Status>

Public Static Attributes

static const Type *GAME
static const Type *LOBBY
static const Type *PARTY
class Visibility : public axr::sdk::StringEnum<Status>

Public Static Attributes

static const Visibility *PUBLIC
static const Visibility *FRIENDS_EXTENDED
static const Visibility *FRIENDS_ONLY
static const Visibility *INVITE_ONLY
static const Visibility *LOCKED