Class Zone

Inheritance Relationships

Base Type

Class Documentation

class Zone : public axr::sdk::EntityBase

Public Functions

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

Sets the object’s underlying map of stored values.

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

Sets the underlying map of stored values for the object.

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

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

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

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

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

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

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

Sets the value of the Uid property.

Parameters

value – The value to set.

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

Sets the value of the DateCreated property.

Parameters

value – The value to set.

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

Sets the value of the DateModified property.

Parameters

value – The value to set.

inline virtual Zone &SetVersion(const uint64_t value) override

Sets the value of the Version property.

Parameters

value – The value to set.

virtual void Validate() override
std::vector<utility::string_t> GetAdjacent() const

The list of other zone id’s that are adjacent and directly reachable from this zone.

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

The list of user id’s and role names that have permission to join this zone. Supports regex patterns.

bool GetAutoCreateShards() const

Set to true to have the service automatically create shards based on population demand, otherwise set to false.

std::shared_ptr<Object> GetData() const

A map of arbitrary data.

utility::string_t GetDescription() const

The textual description of the zone.

int64_t GetMaxShardUsers() const

The maximum number of users that can join any given shard for this zone.

utility::string_t GetName() const

The unique name of the zone.

utility::string_t GetProductUid() const

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

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

A list of descriptive labels that describes the shard, as inherited from the Zone.

utility::string_t GetTitle() const

The textual name of the zone to display to users.

Public Static Functions

static inline const utility::char_t *ClassName()

Returns the fully qualified name of the class.