Gs2ChatClient (Game Server Services GS2-Chat SDK for Java 0.3.1 API)

java.lang.Object
- io.gs2.AbstractGs2Client<Gs2ChatClient>
- - io.gs2.chat.Gs2ChatClient

public class Gs2ChatClient
extends AbstractGs2Client<Gs2ChatClient>

GS2 Chat API クライアント

Author:: Game Server Services, Inc.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT
- Fields inherited from class io.gs2.AbstractGs2Client
  credential, region

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT`

Constructor Summary

Constructors
Constructor and Description

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

Constructors
Constructor and Description
`Gs2ChatClient(IGs2Credential credential)` コンストラクタ。

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CheckEstimateScanByteByAllRoomResult`	`checkEstimateScanByteByAllRoom(CheckEstimateScanByteByAllRoomRequest request)` メッセージ検索時にスキャンするログサイズの予測値を取得します。長期にわたる検索を行う場合、事前におおよそのログスキャン容量を把握したいと思うはずです。そのような場合にはこのAPIを使用することで、事前にログスキャン容量を把握することが出来ます。ただし、ここで得られる値はあくまで予測値であり、実際に実行した際の値とは異なる場合があります。
`CheckEstimateScanByteByRoomResult`	`checkEstimateScanByteByRoom(CheckEstimateScanByteByRoomRequest request)` メッセージ検索時にスキャンするログサイズの予測値を取得します。長期にわたる検索を行う場合、事前におおよそのログスキャン容量を把握したいと思うはずです。そのような場合にはこのAPIを使用することで、事前にログスキャン容量を把握することが出来ます。ただし、ここで得られる値はあくまで予測値であり、実際に実行した際の値とは異なる場合があります。
`CreateLobbyResult`	`createLobby(CreateLobbyRequest request)` ロビーを新規作成します GS2-Chat の使用を開始するには、まずはロビーを作成します。ロビーはチャットルームの集合体のような存在です。ロビーへの設定項目として購読しているルームに発言があったときの通知方式を指定できます。 http/https を設定した場合は、新しい発言があるたびに指定されたURLに通知を出します。通知は以下のフォーマットで通知されます。 { "_gs2_service": "GS2-Chat#Receive", "notificationUserIds": [ 通知先ユーザID ], "roomId": 発言されたルームID, "userId": 発言したユーザのユーザID, "message": { "text": メッセージテキスト, "meta": メタデータ, } } GS2-InGamePushNotification を指定した場合は、新しい発言があるたびにプッシュ通知を出します。通知は以下のフォーマットで通知されます。 { "subject": メッセージテキスト, "body": { "_gs2_service": "GS2-Chat#Receive", "roomId": 発言されたルームID, "userId": 発言したユーザのユーザID, "message": { "text": メッセージテキスト, "meta": メタデータ, } } }
`CreateMySubscribeResult`	`createMySubscribe(CreateMySubscribeRequest request)` ルームを購読します。ルームを購読すると、ルームに対する新着メッセージを受信したときに通知を受けることが出来ます。通知方式はロビーの設定に依存します。
`CreateRoomResult`	`createRoom(CreateRoomRequest request)` ルームを作成しますルームには参加可能なユーザIDリストを設定することが出来ます。ここで指定されたユーザID以外のユーザがメッセージ情報を取得したり、メッセージを書き込もうとしても失敗するようになります。何も指定しなければ、誰でも読み書きの出来る部屋になります。ルームを作成する際に参加するユーザが確定している場合に使用するといいでしょう。ルームにはパスワードを設定することが出来ます。パスワードが設定されたルームのメッセージ情報を取得したり、メッセージを書き込もうとするさいにパスワードを指定する必要があります。パスワードが一致しない場合は失敗します。何も指定しなければ、メッセージの読み書きにパスワードを要求しません。ルームを作成する際には参加するユーザが確定できないけれど、アクセスを制限したい場合に使用するといいでしょう。ルームIDには任意の値を指定することが出来ます。たとえば、マッチメイキングを実行し構築されたギャザリングのユーザ向けにチャットルームを提供したい場合、ギャザリングIDをキーとしてルームを作成することで、クライアントがチャットにアクセスする際にIDの特定が容易になります。ルームIDを省略するとUUIDv4に基づいて自動的に採番されます。
`CreateSubscribeResult`	`createSubscribe(CreateSubscribeRequest request)` ルームを購読します。ルームを購読すると、ルームに対する新着メッセージを受信したときに通知を受けることが出来ます。通知方式はロビーの設定に依存します。
`void`	`deleteLobby(DeleteLobbyRequest request)` ロビーを削除します
`void`	`deleteMySubscribe(DeleteMySubscribeRequest request)` 購読を解除する。
`void`	`deleteRoom(DeleteRoomRequest request)` ルームを削除します
`void`	`deleteSubscribe(DeleteSubscribeRequest request)` 購読を解除する。
`DescribeLobbyResult`	`describeLobby(DescribeLobbyRequest request)` ロビーの一覧を取得します
`DescribeMessageResult`	`describeMessage(DescribeMessageRequest request)` メッセージの一覧を取得します。
`DescribeMessageNoAuthResult`	`describeMessageNoAuth(DescribeMessageNoAuthRequest request)` メッセージの一覧を取得します。
`DescribeMySubscribeResult`	`describeMySubscribe(DescribeMySubscribeRequest request)` ユーザが購読しているルームの一覧を取得します。
`DescribeRoomResult`	`describeRoom(DescribeRoomRequest request)` ルームの一覧を取得します。
`DescribeServiceClassResult`	`describeServiceClass(DescribeServiceClassRequest request)` サービスクラスの一覧を取得します
`DescribeSubscribeByRoomIdResult`	`describeSubscribeByRoomId(DescribeSubscribeByRoomIdRequest request)` ルームを購読しているユーザの一覧を取得します。
`DescribeSubscribeByUserIdResult`	`describeSubscribeByUserId(DescribeSubscribeByUserIdRequest request)` ユーザが購読しているルームの一覧を取得します。
`GetLobbyResult`	`getLobby(GetLobbyRequest request)` ロビーを取得します
`GetLobbyStatusResult`	`getLobbyStatus(GetLobbyStatusRequest request)` ロビーの状態を取得します
`GetMySubscribeResult`	`getMySubscribe(GetMySubscribeRequest request)` 購読情報を取得する。
`GetRoomResult`	`getRoom(GetRoomRequest request)` ルームを取得します
`GetSubscribeResult`	`getSubscribe(GetSubscribeRequest request)` 購読情報を取得する。
`SearchLogByAllRoomResult`	`searchLogByAllRoom(SearchLogByAllRoomRequest request)` メッセージログを検索します。メッセージログの検索には以下のパラメータを使用できます。 * ユーザID * メッセージテキスト * メッセージメタデータいずれも部分一致で検索できます。たとえば、メッセージメタデータに JSON フォーマットを使用している場合は JSON 文字列に対する部分一致検索が適用できます。一方で、BLOB データを Base64 かけたようなデータの場合は検索対象とするのは困難です。メッセージログ検索にかかる費用は、検索時にログデータを何バイトスキャンしたかで決定されます。そのため、発言者が滞在していたルームが特定できている場合は、本APIではなく『Gs2Chat:SearchLogByRoom』を使用する方が費用を節約できます。また、検索範囲を時間で指定できますが、ログデータは1日単位(UTC)で分割して保存されており、スキャン時には1日分全てがスキャン対象となります。つまり、特定の日付の5分間のログを検索するクエリを実行した場合、該当する1日分のログデータがスキャン対象となり、さらにその5分間が日付をまたぐような場合は2日分のログデータがスキャン対象となります。検索結果が指定した取得最大件数以上の結果を持つ場合、実行後一定期間内であればページトークンを使用した続きのデータ取得が可能です。
`SearchLogByRoomResult`	`searchLogByRoom(SearchLogByRoomRequest request)` メッセージログを検索します。メッセージログの検索には以下のパラメータを使用できます。 * ユーザID * メッセージテキスト * メッセージメタデータいずれも部分一致で検索できます。たとえば、メッセージメタデータに JSON フォーマットを使用している場合は JSON 文字列に対する部分一致検索が適用できます。一方で、BLOB データを Base64 かけたようなデータの場合は検索対象とするのは困難です。メッセージログ検索にかかる費用は、検索時にログデータを何バイトスキャンしたかで決定されます。検索範囲を時間で指定できますが、ログデータは1日単位(UTC)で分割して保存されており、スキャン時には1日分全てがスキャン対象となります。つまり、特定の日付の5分間のログを検索するクエリを実行した場合、該当する1日分のログデータがスキャン対象となり、さらにその5分間が日付をまたぐような場合は2日分のログデータがスキャン対象となります。検索結果が指定した取得最大件数以上の結果を持つ場合、実行後一定期間内であればページトークンを使用した続きのデータ取得が可能です。
`SendMessageResult`	`sendMessage(SendMessageRequest request)` メッセージを送信します。
`SendMessageNoAuthResult`	`sendMessageNoAuth(SendMessageNoAuthRequest request)` メッセージを送信します。
`UpdateLobbyResult`	`updateLobby(UpdateLobbyRequest request)` ロビーを更新します

Methods inherited from class io.gs2.AbstractGs2Client
createHttpDelete, createHttpGet, createHttpPost, createHttpPut, doRequest, getRegion, setRegion, withRegion

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ENDPOINT
```
public static String ENDPOINT
```
- Constructor Detail
  - Gs2ChatClient
```
public Gs2ChatClient(IGs2Credential credential)
```
    コンストラクタ。
    
    Parameters:
    
    credential - 認証情報
- Method Detail
  - checkEstimateScanByteByAllRoom
```
public CheckEstimateScanByteByAllRoomResult checkEstimateScanByteByAllRoom(CheckEstimateScanByteByAllRoomRequest request)
```
    メッセージ検索時にスキャンするログサイズの予測値を取得します。
    
    長期にわたる検索を行う場合、事前におおよそのログスキャン容量を把握したいと思うはずです。
    そのような場合にはこのAPIを使用することで、事前にログスキャン容量を把握することが出来ます。
    
    ただし、ここで得られる値はあくまで予測値であり、実際に実行した際の値とは異なる場合があります。
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - checkEstimateScanByteByRoom
```
public CheckEstimateScanByteByRoomResult checkEstimateScanByteByRoom(CheckEstimateScanByteByRoomRequest request)
```
    メッセージ検索時にスキャンするログサイズの予測値を取得します。
    
    長期にわたる検索を行う場合、事前におおよそのログスキャン容量を把握したいと思うはずです。
    そのような場合にはこのAPIを使用することで、事前にログスキャン容量を把握することが出来ます。
    
    ただし、ここで得られる値はあくまで予測値であり、実際に実行した際の値とは異なる場合があります。
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - createLobby
```
public CreateLobbyResult createLobby(CreateLobbyRequest request)
```
    ロビーを新規作成します
    
    GS2-Chat の使用を開始するには、まずはロビーを作成します。
    ロビーはチャットルームの集合体のような存在です。
    
    ロビーへの設定項目として購読しているルームに発言があったときの通知方式を指定できます。
    http/https を設定した場合は、新しい発言があるたびに指定されたURLに通知を出します。
    通知は以下のフォーマットで通知されます。
    {
    "_gs2_service": "GS2-Chat#Receive",
    "notificationUserIds": [
    通知先ユーザID
    ],
    "roomId": 発言されたルームID,
    "userId": 発言したユーザのユーザID,
    "message": {
    "text": メッセージテキスト,
    "meta": メタデータ,
    }
    }
    GS2-InGamePushNotification を指定した場合は、新しい発言があるたびにプッシュ通知を出します。
    通知は以下のフォーマットで通知されます。
    {
    "subject": メッセージテキスト,
    "body": {
    "_gs2_service": "GS2-Chat#Receive",
    "roomId": 発言されたルームID,
    "userId": 発言したユーザのユーザID,
    "message": {
    "text": メッセージテキスト,
    "meta": メタデータ,
    }
    }
    }
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - createMySubscribe
```
public CreateMySubscribeResult createMySubscribe(CreateMySubscribeRequest request)
```
    ルームを購読します。
    
    ルームを購読すると、ルームに対する新着メッセージを受信したときに通知を受けることが出来ます。
    通知方式はロビーの設定に依存します。
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - createRoom
```
public CreateRoomResult createRoom(CreateRoomRequest request)
```
    ルームを作成します
    
    ルームには参加可能なユーザIDリストを設定することが出来ます。
    ここで指定されたユーザID以外のユーザがメッセージ情報を取得したり、メッセージを書き込もうとしても失敗するようになります。
    何も指定しなければ、誰でも読み書きの出来る部屋になります。
    ルームを作成する際に参加するユーザが確定している場合に使用するといいでしょう。
    
    ルームにはパスワードを設定することが出来ます。
    パスワードが設定されたルームのメッセージ情報を取得したり、メッセージを書き込もうとするさいにパスワードを指定する必要があります。
    パスワードが一致しない場合は失敗します。
    何も指定しなければ、メッセージの読み書きにパスワードを要求しません。
    ルームを作成する際には参加するユーザが確定できないけれど、アクセスを制限したい場合に使用するといいでしょう。
    
    ルームIDには任意の値を指定することが出来ます。
    たとえば、マッチメイキングを実行し構築されたギャザリングのユーザ向けにチャットルームを提供したい場合、
    ギャザリングIDをキーとしてルームを作成することで、クライアントがチャットにアクセスする際にIDの特定が容易になります。
    ルームIDを省略するとUUIDv4に基づいて自動的に採番されます。
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - createSubscribe
```
public CreateSubscribeResult createSubscribe(CreateSubscribeRequest request)
```
    ルームを購読します。
    
    ルームを購読すると、ルームに対する新着メッセージを受信したときに通知を受けることが出来ます。
    通知方式はロビーの設定に依存します。
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - deleteLobby
```
public void deleteLobby(DeleteLobbyRequest request)
```
    ロビーを削除します
    
    Parameters:
    
    request - リクエストパラメータ
  - deleteMySubscribe
```
public void deleteMySubscribe(DeleteMySubscribeRequest request)
```
    購読を解除する。
    
    Parameters:
    
    request - リクエストパラメータ
  - deleteRoom
```
public void deleteRoom(DeleteRoomRequest request)
```
    ルームを削除します
    
    Parameters:
    
    request - リクエストパラメータ
  - deleteSubscribe
```
public void deleteSubscribe(DeleteSubscribeRequest request)
```
    購読を解除する。
    
    Parameters:
    
    request - リクエストパラメータ
  - describeLobby
```
public DescribeLobbyResult describeLobby(DescribeLobbyRequest request)
```
    ロビーの一覧を取得します
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - describeMessage
```
public DescribeMessageResult describeMessage(DescribeMessageRequest request)
```
    メッセージの一覧を取得します。
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - describeMessageNoAuth
```
public DescribeMessageNoAuthResult describeMessageNoAuth(DescribeMessageNoAuthRequest request)
```
    メッセージの一覧を取得します。
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - describeMySubscribe
```
public DescribeMySubscribeResult describeMySubscribe(DescribeMySubscribeRequest request)
```
    ユーザが購読しているルームの一覧を取得します。
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - describeRoom
```
public DescribeRoomResult describeRoom(DescribeRoomRequest request)
```
    ルームの一覧を取得します。
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - describeServiceClass
```
public DescribeServiceClassResult describeServiceClass(DescribeServiceClassRequest request)
```
    サービスクラスの一覧を取得します
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - describeSubscribeByRoomId
```
public DescribeSubscribeByRoomIdResult describeSubscribeByRoomId(DescribeSubscribeByRoomIdRequest request)
```
    ルームを購読しているユーザの一覧を取得します。
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - describeSubscribeByUserId
```
public DescribeSubscribeByUserIdResult describeSubscribeByUserId(DescribeSubscribeByUserIdRequest request)
```
    ユーザが購読しているルームの一覧を取得します。
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - getLobby
```
public GetLobbyResult getLobby(GetLobbyRequest request)
```
    ロビーを取得します
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - getLobbyStatus
```
public GetLobbyStatusResult getLobbyStatus(GetLobbyStatusRequest request)
```
    ロビーの状態を取得します
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - getMySubscribe
```
public GetMySubscribeResult getMySubscribe(GetMySubscribeRequest request)
```
    購読情報を取得する。
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - getRoom
```
public GetRoomResult getRoom(GetRoomRequest request)
```
    ルームを取得します
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - getSubscribe
```
public GetSubscribeResult getSubscribe(GetSubscribeRequest request)
```
    購読情報を取得する。
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - searchLogByAllRoom
```
public SearchLogByAllRoomResult searchLogByAllRoom(SearchLogByAllRoomRequest request)
```
    メッセージログを検索します。
    
    メッセージログの検索には以下のパラメータを使用できます。
    * ユーザID
    * メッセージテキスト
    * メッセージメタデータ
    いずれも部分一致で検索できます。
    たとえば、メッセージメタデータに JSON フォーマットを使用している場合は JSON 文字列に対する部分一致検索が適用できます。
    一方で、BLOB データを Base64 かけたようなデータの場合は検索対象とするのは困難です。
    
    メッセージログ検索にかかる費用は、検索時にログデータを何バイトスキャンしたかで決定されます。
    そのため、発言者が滞在していたルームが特定できている場合は、本APIではなく『Gs2Chat:SearchLogByRoom』を使用する方が費用を節約できます。
    また、検索範囲を時間で指定できますが、ログデータは1日単位(UTC)で分割して保存されており、スキャン時には1日分全てがスキャン対象となります。
    つまり、特定の日付の5分間のログを検索するクエリを実行した場合、該当する1日分のログデータがスキャン対象となり、
    さらにその5分間が日付をまたぐような場合は2日分のログデータがスキャン対象となります。
    
    検索結果が指定した取得最大件数以上の結果を持つ場合、実行後一定期間内であればページトークンを使用した続きのデータ取得が可能です。
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - searchLogByRoom
```
public SearchLogByRoomResult searchLogByRoom(SearchLogByRoomRequest request)
```
    メッセージログを検索します。
    
    メッセージログの検索には以下のパラメータを使用できます。
    * ユーザID
    * メッセージテキスト
    * メッセージメタデータ
    いずれも部分一致で検索できます。
    たとえば、メッセージメタデータに JSON フォーマットを使用している場合は JSON 文字列に対する部分一致検索が適用できます。
    一方で、BLOB データを Base64 かけたようなデータの場合は検索対象とするのは困難です。
    
    メッセージログ検索にかかる費用は、検索時にログデータを何バイトスキャンしたかで決定されます。
    検索範囲を時間で指定できますが、ログデータは1日単位(UTC)で分割して保存されており、スキャン時には1日分全てがスキャン対象となります。
    つまり、特定の日付の5分間のログを検索するクエリを実行した場合、該当する1日分のログデータがスキャン対象となり、
    さらにその5分間が日付をまたぐような場合は2日分のログデータがスキャン対象となります。
    
    検索結果が指定した取得最大件数以上の結果を持つ場合、実行後一定期間内であればページトークンを使用した続きのデータ取得が可能です。
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - sendMessage
```
public SendMessageResult sendMessage(SendMessageRequest request)
```
    メッセージを送信します。
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - sendMessageNoAuth
```
public SendMessageNoAuthResult sendMessageNoAuth(SendMessageNoAuthRequest request)
```
    メッセージを送信します。
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - updateLobby
```
public UpdateLobbyResult updateLobby(UpdateLobbyRequest request)
```
    ロビーを更新します
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果

Class Gs2ChatClient

Field Summary

Fields inherited from class io.gs2.AbstractGs2Client

Constructor Summary

Method Summary

Methods inherited from class io.gs2.AbstractGs2Client

Methods inherited from class java.lang.Object

Field Detail

ENDPOINT

Constructor Detail

Gs2ChatClient

Method Detail

checkEstimateScanByteByAllRoom

checkEstimateScanByteByRoom

createLobby

createMySubscribe

createRoom

createSubscribe

deleteLobby

deleteMySubscribe

deleteRoom

deleteSubscribe

describeLobby

describeMessage

describeMessageNoAuth

describeMySubscribe

describeRoom

describeServiceClass

describeSubscribeByRoomId

describeSubscribeByUserId

getLobby

getLobbyStatus

getMySubscribe

getRoom

getSubscribe

searchLogByAllRoom

searchLogByRoom

sendMessage

sendMessageNoAuth

updateLobby