Stay organized with collections
Save and categorize content based on your preferences.
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)
|
~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)
|
Assigns this Event by copying from another one. |
operator=(Event && move_from)
|
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(
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
)
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.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-10-28 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-28 UTC."],[],[],null,["# gpg::Event Class Reference\n\ngpg::Event\n==========\n\n`#include \u003cevent.h\u003e`\n\nA single data structure containing data about the status of a specific event.\n\nSummary\n-------\n\nData comprise two types: user-specific (e.g., whether the user has unlocked the event), and global (e.g., event name).\n\n| ### Constructors and Destructors ||\n|---|---|\n| [Event](#classgpg_1_1_event_1a62fd9e25eef0cfb63671b32c15b63de7)`()` ||\n| [Event](#classgpg_1_1_event_1a1cd0e63978cdc2ad42154db032f33afd)`(std::shared_ptr\u003c const EventImpl \u003e impl)` Constructs an [Event](/games/services/cpp/api/class/gpg/event#classgpg_1_1_event) from a `shared_ptr` to an `EventImpl`. ||\n| [Event](#classgpg_1_1_event_1a2b7169ab4771a6bea14b7695ddb462bc)`(const `[Event](/games/services/cpp/api/class/gpg/event#classgpg_1_1_event)` & copy_from)` Creates a copy of an existing [Event](/games/services/cpp/api/class/gpg/event#classgpg_1_1_event). ||\n| [Event](#classgpg_1_1_event_1aba344e939c30bb607368c273f2b426b4)`(`[Event](/games/services/cpp/api/class/gpg/event#classgpg_1_1_event)` && move_from)` Moves an existing [Event](/games/services/cpp/api/class/gpg/event#classgpg_1_1_event). ||\n| [~Event](#classgpg_1_1_event_1ac0b9230499fdda8eface3326b99ef166)`()` ||\n\n| ### Public functions ||\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Count](#classgpg_1_1_event_1a4eb8c54247277e4c8f617dcd2b748880)`() const ` | `uint64_t` Returns the number of times the event has been incremented. |\n| [Description](#classgpg_1_1_event_1a01d8ce7e40655babf5afd968c2a1c0bc)`() const ` | `const std::string &` Returns the description of the event. |\n| [Id](#classgpg_1_1_event_1aa267791e0e672bee41b7f2504059577d)`() const ` | `const std::string &` Returns the unique string that the Google Play Developer Console generated beforehand. |\n| [ImageUrl](#classgpg_1_1_event_1a2e6f44a2ddf6b00b9306ca7bf1b9f953)`() const ` | `const std::string &` Returns the URL leading to the image of the icon for this event. |\n| [Name](#classgpg_1_1_event_1a9a47a1e62994acafb15afb02de337ab1)`() const ` | `const std::string &` Returns the short name of the event. |\n| [Valid](#classgpg_1_1_event_1a4cb4348adc0bbdc1d1f7a20d0c9e2bec)`() 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. |\n| [Visibility](#classgpg_1_1_event_1ad59342d5735fafb6050f2277318c8c3c)`() const ` | [EventVisibility](/games/services/cpp/api/namespace/gpg#namespacegpg_1aa87a4b2e8a01c80e2155286d4bdb9942) Returns the event state: `HIDDEN` or `REVEALED`. |\n| [operator=](#classgpg_1_1_event_1ab795a0f5221cb5b9f30934dfcb5c73d3)`(const `[Event](/games/services/cpp/api/class/gpg/event#classgpg_1_1_event)` & copy_from)` | [Event](/games/services/cpp/api/class/gpg/event#classgpg_1_1_event)` &` Assigns this [Event](/games/services/cpp/api/class/gpg/event#classgpg_1_1_event) by copying from another one. |\n| [operator=](#classgpg_1_1_event_1a2de54c196b31ab58160066c750c28cbf)`(`[Event](/games/services/cpp/api/class/gpg/event#classgpg_1_1_event)` && move_from)` | [Event](/games/services/cpp/api/class/gpg/event#classgpg_1_1_event)` &` Assigns this [Event](/games/services/cpp/api/class/gpg/event#classgpg_1_1_event) by moving another one into it. |\n\nPublic functions\n----------------\n\n### Count\n\n```c++\nuint64_t Count() const \n``` \nReturns the number of times the event has been incremented.\n\n[Event::Valid()](/games/services/cpp/api/class/gpg/event#classgpg_1_1_event_1a4cb4348adc0bbdc1d1f7a20d0c9e2bec) must return true for this function to be usable. \n\n### Description\n\n```c++\nconst std::string & Description() const \n``` \nReturns the description of the event.\n\nIt can only be called when [Event::Valid()](/games/services/cpp/api/class/gpg/event#classgpg_1_1_event_1a4cb4348adc0bbdc1d1f7a20d0c9e2bec) returns true. \n\n### Event\n\n```c++\n Event()\n``` \n\n### Event\n\n```c++\n Event(\n std::shared_ptr\u003c const EventImpl \u003e impl\n)\n``` \nConstructs an [Event](/games/services/cpp/api/class/gpg/event#classgpg_1_1_event) from a `shared_ptr` to an `EventImpl`.\n\nIntended for internal use by the API. \n\n### Event\n\n```c++\n Event(\n const Event & copy_from\n)\n``` \nCreates a copy of an existing [Event](/games/services/cpp/api/class/gpg/event#classgpg_1_1_event). \n\n### Event\n\n```c++\n Event(\n Event && move_from\n)\n``` \nMoves an existing [Event](/games/services/cpp/api/class/gpg/event#classgpg_1_1_event). \n\n### Id\n\n```c++\nconst std::string & Id() const \n``` \nReturns the unique string that the Google Play Developer Console generated beforehand.\n\nUse it to refer to an event in your game client. It can only be called when [Event::Valid()](/games/services/cpp/api/class/gpg/event#classgpg_1_1_event_1a4cb4348adc0bbdc1d1f7a20d0c9e2bec) returns true. \n\n### ImageUrl\n\n```c++\nconst std::string & ImageUrl() const \n``` \nReturns the URL leading to the image of the icon for this event.\n\n[Event::Valid()](/games/services/cpp/api/class/gpg/event#classgpg_1_1_event_1a4cb4348adc0bbdc1d1f7a20d0c9e2bec) must return true for this function to be usable. \n\n### Name\n\n```c++\nconst std::string & Name() const \n``` \nReturns the short name of the event.\n\nUp to 100 characters. It can only be called when [Event::Valid()](/games/services/cpp/api/class/gpg/event#classgpg_1_1_event_1a4cb4348adc0bbdc1d1f7a20d0c9e2bec) returns true. \n\n### Valid\n\n```c++\nbool Valid() const \n``` \nReturns 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.\n\nIt must be true for the getter functions on this event (`id`, `Name`, `Description`, etc.) to be usable. \n\n### Visibility\n\n```c++\nEventVisibility Visibility() const \n``` \nReturns the event state: `HIDDEN` or `REVEALED`.\n\n[Event::Valid()](/games/services/cpp/api/class/gpg/event#classgpg_1_1_event_1a4cb4348adc0bbdc1d1f7a20d0c9e2bec) must return true for this function to be usable. \n\n### operator=\n\n```c++\nEvent & operator=(\n const Event & copy_from\n)\n``` \nAssigns this [Event](/games/services/cpp/api/class/gpg/event#classgpg_1_1_event) by copying from another one. \n\n### operator=\n\n```c++\nEvent & operator=(\n Event && move_from\n)\n``` \nAssigns this [Event](/games/services/cpp/api/class/gpg/event#classgpg_1_1_event) by moving another one into it. \n\n### \\~Event\n\n```c++\n ~Event()\n```"]]
