gpg::Event

#include <event.h>

A single data structure containing data about the status of a specific event.

Summary

Data comprise two types: user-specific (e.g., whether the user has unlocked the event), and global (e.g., event name).

Constructors and Destructors
Event()
Event(std::shared_ptr< const EventImpl > impl)
Constructs an Event from a shared_ptr to an EventImpl.
Event(const Event & copy_from)
Creates a copy of an existing Event.
Event(Event && move_from)
Moves an existing Event.
~Event()

Public functions
Count() const
uint64_t
Returns the number of times the event has been incremented.
Description() const
const std::string &
Returns the description of the event.
Id() const
const std::string &
Returns the unique string that the Google Play Developer Console generated beforehand.
ImageUrl() const
const std::string &
Returns the URL leading to the image of the icon for this event.
Name() const
const std::string &
Returns the short name of the event.
Valid() const
bool
Returns true if this event is populated with data and is accompanied by a successful response status; false for an unpopulated user-created event or for a populated one accompanied by an unsuccessful response status.
Visibility() const
Returns the event state: HIDDEN or REVEALED.
operator=(const Event & copy_from)
Event &
Assigns this Event by copying from another one.
operator=(Event && move_from)
Event &
Assigns this Event by moving another one into it.

Public functions

Count

uint64_t Count() const

Returns the number of times the event has been incremented.

Event::Valid() must return true for this function to be usable.

Description

const std::string & Description() const

Returns the description of the event.

It can only be called when Event::Valid() returns true.

Event

 Event()

Event

 Event(
  std::shared_ptr< const EventImpl > impl
)

Constructs an Event from a shared_ptr to an EventImpl.

Intended for internal use by the API.

Event

 Event(
  const Event & copy_from
)

Creates a copy of an existing Event.

Event

 Event(
  Event && move_from
)

Moves an existing Event.

Id

const std::string & Id() const

Returns the unique string that the Google Play Developer Console generated beforehand.

Use it to refer to an event in your game client. It can only be called when Event::Valid() returns true.

ImageUrl

const std::string & ImageUrl() const

Returns the URL leading to the image of the icon for this event.

Event::Valid() must return true for this function to be usable.

Name

const std::string & Name() const

Returns the short name of the event.

Up to 100 characters. It can only be called when Event::Valid() returns true.

Valid

bool Valid() const

Returns true if this event is populated with data and is accompanied by a successful response status; false for an unpopulated user-created event or for a populated one accompanied by an unsuccessful response status.

It must be true for the getter functions on this event (id, Name, Description, etc.) to be usable.

Visibility

EventVisibility Visibility() const

Returns the event state: HIDDEN or REVEALED.

Event::Valid() must return true for this function to be usable.

operator=

Event & operator=(
  const Event & copy_from
)

Assigns this Event by copying from another one.

operator=

Event & operator=(
  Event && move_from
)

Assigns this Event by moving another one into it.

~Event

 ~Event()