#include <event_definition.h>

Inheritance diagram for google_games_api::EventDefinition:

Public Member Functions
	EventDefinition (const Json::Value &storage)

	EventDefinition (Json::Value *storage)

virtual	~EventDefinition ()

const StringPiece	GetTypeName () const

bool	has_child_events () const

void	clear_child_events ()

const client::JsonCppArray< EventChild >	get_child_events () const

client::JsonCppArray< EventChild >	mutable_childEvents ()

bool	has_description () const

void	clear_description ()

const StringPiece	get_description () const

void	set_description (const StringPiece &value)

bool	has_display_name () const

void	clear_display_name ()

const StringPiece	get_display_name () const

void	set_display_name (const StringPiece &value)

bool	has_id () const

void	clear_id ()

const StringPiece	get_id () const

void	set_id (const StringPiece &value)

bool	has_image_url () const

void	clear_image_url ()

const StringPiece	get_image_url () const

void	set_image_url (const StringPiece &value)

bool	has_is_default_image_url () const

void	clear_is_default_image_url ()

bool	get_is_default_image_url () const

void	set_is_default_image_url (bool value)

bool	has_kind () const

void	clear_kind ()

const StringPiece	get_kind () const

void	set_kind (const StringPiece &value)

bool	has_visibility () const

void	clear_visibility ()

const StringPiece	get_visibility () const

void	set_visibility (const StringPiece &value)

Static Public Member Functions
static EventDefinition *	New ()

Detailed Description

This is a JSON template for an event definition resource.

Constructor & Destructor Documentation

◆ EventDefinition() [1/2]

google_games_api::EventDefinition::EventDefinition ( const Json::Value & storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ EventDefinition() [2/2]

google_games_api::EventDefinition::EventDefinition ( Json::Value * storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ ~EventDefinition()

google_games_api::EventDefinition::~EventDefinition ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_child_events()

void google_games_api::EventDefinition::clear_child_events ( )

inline

Clears the 'childEvents' attribute.

◆ clear_description()

void google_games_api::EventDefinition::clear_description ( )

inline

Clears the 'description' attribute.

◆ clear_display_name()

void google_games_api::EventDefinition::clear_display_name ( )

inline

Clears the 'displayName' attribute.

◆ clear_id()

void google_games_api::EventDefinition::clear_id ( )

inline

Clears the 'id' attribute.

◆ clear_image_url()

void google_games_api::EventDefinition::clear_image_url ( )

inline

Clears the 'imageUrl' attribute.

◆ clear_is_default_image_url()

void google_games_api::EventDefinition::clear_is_default_image_url ( )

inline

Clears the 'isDefaultImageUrl' attribute.

◆ clear_kind()

void google_games_api::EventDefinition::clear_kind ( )

inline

Clears the 'kind' attribute.

◆ clear_visibility()

void google_games_api::EventDefinition::clear_visibility ( )

inline

Clears the 'visibility' attribute.

◆ get_child_events()

const client::JsonCppArray<EventChild > google_games_api::EventDefinition::get_child_events ( ) const

Get a reference to the value of the 'childEvents' attribute.

◆ get_description()

const StringPiece google_games_api::EventDefinition::get_description ( ) const

inline

Get the value of the 'description' attribute.

◆ get_display_name()

const StringPiece google_games_api::EventDefinition::get_display_name ( ) const

inline

Get the value of the 'displayName' attribute.

◆ get_id()

const StringPiece google_games_api::EventDefinition::get_id ( ) const

inline

Get the value of the 'id' attribute.

◆ get_image_url()

const StringPiece google_games_api::EventDefinition::get_image_url ( ) const

inline

Get the value of the 'imageUrl' attribute.

◆ get_is_default_image_url()

bool google_games_api::EventDefinition::get_is_default_image_url ( ) const

inline

Get the value of the 'isDefaultImageUrl' attribute.

◆ get_kind()

const StringPiece google_games_api::EventDefinition::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

◆ get_visibility()

const StringPiece google_games_api::EventDefinition::get_visibility ( ) const

inline

Get the value of the 'visibility' attribute.

◆ GetTypeName()

const StringPiece google_games_api::EventDefinition::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_games_api::EventDefinition

◆ has_child_events()

bool google_games_api::EventDefinition::has_child_events ( ) const

inline

Determine if the 'childEvents' attribute was set.

Returns: true if the 'childEvents' attribute was set.

◆ has_description()

bool google_games_api::EventDefinition::has_description ( ) const

inline

Determine if the 'description' attribute was set.

Returns: true if the 'description' attribute was set.

◆ has_display_name()

bool google_games_api::EventDefinition::has_display_name ( ) const

inline

Determine if the 'displayName' attribute was set.

Returns: true if the 'displayName' attribute was set.

◆ has_id()

bool google_games_api::EventDefinition::has_id ( ) const

inline

Determine if the 'id' attribute was set.

Returns: true if the 'id' attribute was set.

◆ has_image_url()

bool google_games_api::EventDefinition::has_image_url ( ) const

inline

Determine if the 'imageUrl' attribute was set.

Returns: true if the 'imageUrl' attribute was set.

◆ has_is_default_image_url()

bool google_games_api::EventDefinition::has_is_default_image_url ( ) const

inline

Determine if the 'isDefaultImageUrl' attribute was set.

Returns: true if the 'isDefaultImageUrl' attribute was set.

◆ has_kind()

bool google_games_api::EventDefinition::has_kind ( ) const

inline

Determine if the 'kind' attribute was set.

Returns: true if the 'kind' attribute was set.

◆ has_visibility()

bool google_games_api::EventDefinition::has_visibility ( ) const

inline

Determine if the 'visibility' attribute was set.

Returns: true if the 'visibility' attribute was set.

◆ mutable_childEvents()

client::JsonCppArray<EventChild > google_games_api::EventDefinition::mutable_childEvents ( )

Gets a reference to a mutable value of the 'childEvents' property.

A list of events that are a child of this event.

Returns: The result can be modified to change the attribute value.

◆ New()

EventDefinition * google_games_api::EventDefinition::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_description()

void google_games_api::EventDefinition::set_description ( const StringPiece & value )

inline

Change the 'description' attribute.

Description of what this event represents.

Parameters

[in] value The new value.

◆ set_display_name()

void google_games_api::EventDefinition::set_display_name ( const StringPiece & value )

inline

Change the 'displayName' attribute.

The name to display for the event.

Parameters

[in] value The new value.

◆ set_id()

void google_games_api::EventDefinition::set_id ( const StringPiece & value )

inline

Change the 'id' attribute.

The ID of the event.

Parameters

[in] value The new value.

◆ set_image_url()

void google_games_api::EventDefinition::set_image_url ( const StringPiece & value )

inline

Change the 'imageUrl' attribute.

The base URL for the image that represents the event.

Parameters

[in] value The new value.

◆ set_is_default_image_url()

void google_games_api::EventDefinition::set_is_default_image_url ( bool value )

inline

Change the 'isDefaultImageUrl' attribute.

Indicates whether the icon image being returned is a default image, or is game-provided.

Parameters

[in] value The new value.

◆ set_kind()

void google_games_api::EventDefinition::set_kind ( const StringPiece & value )

inline

Change the 'kind' attribute.

Uniquely identifies the type of this resource. Value is always the fixed string games::eventDefinition.

Parameters

[in] value The new value.

◆ set_visibility()

void google_games_api::EventDefinition::set_visibility ( const StringPiece & value )

inline

Change the 'visibility' attribute.

The visibility of event being tracked in this definition. Possible values are:

"REVEALED": This event should be visible to all users.
"HIDDEN": This event should only be shown to users that have recorded this event at least once.

Parameters

[in] value The new value.

The documentation for this class was generated from the following files:

google/games_api/event_definition.h
google/games_api/event_definition.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ EventDefinition() [1/2]

◆ EventDefinition() [2/2]

◆ ~EventDefinition()

Member Function Documentation

◆ clear_child_events()

◆ clear_description()

◆ clear_display_name()

◆ clear_id()

◆ clear_image_url()

◆ clear_is_default_image_url()

◆ clear_kind()

◆ clear_visibility()

◆ get_child_events()

◆ get_description()

◆ get_display_name()

◆ get_id()

◆ get_image_url()

◆ get_is_default_image_url()

◆ get_kind()

◆ get_visibility()

◆ GetTypeName()

◆ has_child_events()

◆ has_description()

◆ has_display_name()

◆ has_id()

◆ has_image_url()

◆ has_is_default_image_url()

◆ has_kind()

◆ has_visibility()

◆ mutable_childEvents()

◆ New()

◆ set_description()

◆ set_display_name()

◆ set_id()

◆ set_image_url()

◆ set_is_default_image_url()

◆ set_kind()

◆ set_visibility()