Gs2InGamePushNotificationClient (Game Server Services GS2-InGamePushNotification SDK for Java 0.2.0 API)

java.lang.Object
- io.gs2.AbstractGs2Client<Gs2InGamePushNotificationClient>
- - io.gs2.inGamePushNotification.Gs2InGamePushNotificationClient

public class Gs2InGamePushNotificationClient
extends AbstractGs2Client<Gs2InGamePushNotificationClient>

GS2 InGamePushNotification API クライアント

作成者:: Game Server Services, Inc.

フィールドのサマリー

フィールド
修飾子とタイプフィールドと説明

static String ENDPOINT
- クラスから継承されたフィールド io.gs2.AbstractGs2Client
  credential, region

フィールド
修飾子とタイプ	フィールドと説明
`static String`	`ENDPOINT`

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

Gs2InGamePushNotificationClient(IGs2Credential credential)
コンストラクタ。

コンストラクタ
コンストラクタと説明
`Gs2InGamePushNotificationClient(IGs2Credential credential)` コンストラクタ。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`CreateCertificateResult`	`createCertificate(CreateCertificateRequest request)` クライアント証明書を新規作成します MQTTサーバに接続するためのクライアント証明書の発行を行います。
`CreateGameResult`	`createGame(CreateGameRequest request)` ゲームを新規作成します GS2-InGamePushNotification の使用を開始するには、まずはゲームを作成します。
`void`	`deleteCertificate(DeleteCertificateRequest request)` クライアント証明書を削除します。
`void`	`deleteGame(DeleteGameRequest request)` ゲームを削除します
`DescribeGameResult`	`describeGame(DescribeGameRequest request)` ゲームの一覧を取得します
`DescribeServiceClassResult`	`describeServiceClass(DescribeServiceClassRequest request)` サービスクラスの一覧を取得します
`DescribeStatusResult`	`describeStatus(DescribeStatusRequest request)` ユーザステータスの一覧を取得します
`GetGameResult`	`getGame(GetGameRequest request)` ゲームを取得します
`GetGameStatusResult`	`getGameStatus(GetGameStatusRequest request)` ゲームの状態を取得します
`GetMqttHostResult`	`getMqttHost(GetMqttHostRequest request)` MQTTサーバ情報を取得します
`GetWebSocketHostResult`	`getWebSocketHost(GetWebSocketHostRequest request)` MQTT over Websocketサーバ情報を取得します
`PublishResult`	`publish(PublishRequest request)` 通知を送信します。
`SetFirebaseTokenResult`	`setFirebaseToken(SetFirebaseTokenRequest request)` Firebase のデバイストークンを設定します。
`UpdateGameResult`	`updateGame(UpdateGameRequest request)` ゲームを更新します

クラスから継承されたメソッド io.gs2.AbstractGs2Client
createHttpDelete, createHttpGet, createHttpPost, createHttpPut, doRequest, getRegion, setRegion, withRegion

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - ENDPOINT
```
public static String ENDPOINT
```
- コンストラクタの詳細
  - Gs2InGamePushNotificationClient
```
public Gs2InGamePushNotificationClient(IGs2Credential credential)
```
    コンストラクタ。
    
    パラメータ:
    
    credential - 認証情報
- メソッドの詳細
  - describeServiceClass
```
public DescribeServiceClassResult describeServiceClass(DescribeServiceClassRequest request)
```
    サービスクラスの一覧を取得します
    
    パラメータ:
    
    request - リクエストパラメータ
    
    戻り値:
    
    結果
  - getMqttHost
```
public GetMqttHostResult getMqttHost(GetMqttHostRequest request)
```
    MQTTサーバ情報を取得します
    
    パラメータ:
    
    request - リクエストパラメータ
    
    戻り値:
    
    結果
  - getWebSocketHost
```
public GetWebSocketHostResult getWebSocketHost(GetWebSocketHostRequest request)
```
    MQTT over Websocketサーバ情報を取得します
    
    パラメータ:
    
    request - リクエストパラメータ
    
    戻り値:
    
    結果
  - setFirebaseToken
```
public SetFirebaseTokenResult setFirebaseToken(SetFirebaseTokenRequest request)
```
    Firebase のデバイストークンを設定します。
    
    - 消費クオータ: 10
    
    パラメータ:
    
    request - リクエストパラメータ
    
    戻り値:
    
    結果
  - describeStatus
```
public DescribeStatusResult describeStatus(DescribeStatusRequest request)
```
    ユーザステータスの一覧を取得します
    
    パラメータ:
    
    request - リクエストパラメータ
    
    戻り値:
    
    結果
  - publish
```
public PublishResult publish(PublishRequest request)
```
    通知を送信します。
    
    - 消費クオータ: 3
    
    パラメータ:
    
    request - リクエストパラメータ
    
    戻り値:
    
    結果
  - createGame
```
public CreateGameResult createGame(CreateGameRequest request)
```
    ゲームを新規作成します
    
    GS2-InGamePushNotification の使用を開始するには、まずはゲームを作成します。
    その後、ゲームに対してMQTTに接続するためのクライアント証明書の発行を依頼をします。
    応答されたクライアント証明書と秘密鍵をデバイスに保存し、MQTTサーバへの接続に使用します。
    
    サーバサイドからユーザに対してプッシュ通知を出すことが出来ます。
    その際にユーザがMQTTに接続している場合はMQTTを使用して通知を出します。
    もし、ユーザがMQTTに接続していない場合の挙動はゲームの設定で変更できます。
    
    1つ目は何もしない。
    2つ目は指定したURLに通知する。
    3つ目は Firebase Cloud Messaging を使用してモバイルプッシュ通知する。です。
    
    http/https を指定した場合、以下のフォーマットでURLにPOSTします。
    {
    "_gs2_service": "gs2-in-game-push-notification",
    "userId": ユーザID
    "subject": サブジェクト,
    "body": ボディ,
    }
    
    APIリクエスト以外に各デバイスがMQTTサーバに新しく接続する際にクオータを10消費する点にご注意ください。
    
    パラメータ:
    
    request - リクエストパラメータ
    
    戻り値:
    
    結果
  - describeGame
```
public DescribeGameResult describeGame(DescribeGameRequest request)
```
    ゲームの一覧を取得します
    
    パラメータ:
    
    request - リクエストパラメータ
    
    戻り値:
    
    結果
  - getGameStatus
```
public GetGameStatusResult getGameStatus(GetGameStatusRequest request)
```
    ゲームの状態を取得します
    
    パラメータ:
    
    request - リクエストパラメータ
    
    戻り値:
    
    結果
  - createCertificate
```
public CreateCertificateResult createCertificate(CreateCertificateRequest request)
```
    クライアント証明書を新規作成します
    
    MQTTサーバに接続するためのクライアント証明書の発行を行います。
    1ユーザに対して発行できるクライアント証明書は同時に1つのみです。
    異なるデバイスでMQTTサーバにアクセスする場合、クライアント証明書を削除して取り直すようにしてください。
    
    - 消費クオータ: 10
    
    パラメータ:
    
    request - リクエストパラメータ
    
    戻り値:
    
    結果
  - deleteCertificate
```
public void deleteCertificate(DeleteCertificateRequest request)
```
    クライアント証明書を削除します。
    
    - 消費クオータ: 10
    
    パラメータ:
    
    request - リクエストパラメータ
  - updateGame
```
public UpdateGameResult updateGame(UpdateGameRequest request)
```
    ゲームを更新します
    
    パラメータ:
    
    request - リクエストパラメータ
    
    戻り値:
    
    結果
  - getGame
```
public GetGameResult getGame(GetGameRequest request)
```
    ゲームを取得します
    
    パラメータ:
    
    request - リクエストパラメータ
    
    戻り値:
    
    結果
  - deleteGame
```
public void deleteGame(DeleteGameRequest request)
```
    ゲームを削除します
    
    パラメータ:
    
    request - リクエストパラメータ

クラス Gs2InGamePushNotificationClient

フィールドのサマリー

クラスから継承されたフィールド io.gs2.AbstractGs2Client

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド io.gs2.AbstractGs2Client

クラスから継承されたメソッド java.lang.Object

フィールドの詳細

ENDPOINT

コンストラクタの詳細

Gs2InGamePushNotificationClient

メソッドの詳細

describeServiceClass

getMqttHost

getWebSocketHost

setFirebaseToken

describeStatus

publish

createGame

describeGame

getGameStatus

createCertificate

deleteCertificate

updateGame

getGame

deleteGame