gpg:: イベント
#include <event.h>
特定のイベントのステータスに関するデータを含む、単一のデータ構造体です。
概要
データは、ユーザー固有(ユーザーがイベントをロック解除したかどうかなど)とグローバル(イベント名など)の 2 種類で構成されます。
コンストラクタとデストラクタ |
|
---|---|
Event()
|
|
Event(std::shared_ptr< const EventImpl > impl)
|
|
Event(const Event & copy_from)
既存の
Event のコピーを作成します。 |
|
Event(Event && move_from)
既存の
Event を移動します。 |
|
~Event()
|
パブリック関数 |
|
---|---|
Count() const
|
uint64_t
イベントが増加した回数を返します。
|
Description() const
|
const std::string &
イベントの説明を返します。
|
Id() const
|
const std::string &
Google Play Console で事前に生成した一意の文字列を返します。
|
ImageUrl() const
|
const std::string &
このイベントのアイコンの画像に移動する URL を返します。
|
Name() const
|
const std::string &
イベントの略称を返します。
|
Valid() const
|
bool
このイベントにデータが挿入され、成功のレスポンス ステータスが伴う場合は true が返されます。ユーザー作成のイベントにデータが入力されていないか、データが入力されたイベントにレスポンスの失敗ステータスが伴う場合は false が返されます。
|
Visibility() const
|
イベントの状態(
HIDDEN または REVEALED )を返します。 |
operator=(const Event & copy_from)
|
Event &
この
Event を別のものからコピーして割り当てます。 |
operator=(Event && move_from)
|
Event &
この
Event を別のものに移動することで割り当てます。 |
パブリック関数
説明
const std::string & Description() const
イベントの説明を返します。
Event::Valid()
が true を返したときにのみ呼び出すことができます。
イベント
Event()
イベント
Event( std::shared_ptr< const EventImpl > impl )
shared_ptr
から EventImpl
への Event
を作成します。
API による内部使用を対象としています。
ID
const std::string & Id() const
Google Play Console で事前に生成した一意の文字列を返します。
ゲーム クライアント内のイベントを参照するために使用します。Event::Valid()
が true を返したときにのみ呼び出すことができます。
ImageUrl
const std::string & ImageUrl() const
このイベントのアイコンの画像に移動する URL を返します。
この関数を使用できるようにするには、Event::Valid()
が true を返す必要があります。
名前
const std::string & Name() const
イベントの略称を返します。
100 文字まで。Event::Valid()
が true を返したときにのみ呼び出すことができます。
有効
bool Valid() const
このイベントにデータが挿入され、成功のレスポンス ステータスが伴う場合は true が返されます。ユーザー作成のイベントにデータが入力されていないか、データが入力されたイベントにレスポンスの失敗ステータスが伴う場合は false が返されます。
このイベントのゲッター関数(id
、Name
、Description
など)を使用できるようにするには、true にする必要があります。
公開設定
EventVisibility Visibility() const
イベントの状態(HIDDEN
または REVEALED
)を返します。
この関数を使用できるようにするには、Event::Valid()
が true を返す必要があります。
~イベント
~Event()