GS2-Chat¶

ルーム新規作成時 ¶

ルーム新規作成時に呼び出されます。このイベントが発生した瞬間にはまだルームの作成は実行されておらず、スクリプトの結果として「作成を許可しない」というレスポンスを返すことが出来ます。また、このスクリプトをレスポンスした直後、ルームの永続化処理時に何らかのエラーが発生した場合には、ルームの作成が失敗する可能性があります。

Request ¶

{
  lobbyName=[string] GS2-Chat のロビー名,
  roomId=[string] 新しく作成するルームのID,
  allowUserIds=[array<string>] 入室可能なユーザIDリスト,
  password=[string] パスワード
}

Response ¶

{
  permit=[bool] ルームの作成を許可するか,
  (overrideAllowUserIds=[array<string>] 実際に適用する入室可能なユーザIDリスト)
  (overridePassword=[array<string>] 実際に適用する入室可能なパスワード)
}

ルーム新規作成完了時 ¶

ルームの新規作成が完了した時に呼び出されます。このイベントが発生した瞬間にはルームの永続化が完了されていることが保証されています。

Request ¶

{
  lobbyName=[string] GS2-Chat のロビー名,
  roomId=[string] 新しく作成するルームのID,
  allowUserIds=[array<string>] 入室可能なユーザIDリスト,
  password=[string] パスワード
}

Response ¶

{
}

ルーム削除時 ¶

ルーム削除時に呼び出されます。このイベントが発生した瞬間にはまだルームの削除は実行されておらず、スクリプトの結果として「削除を許可しない」というレスポンスを返すことが出来ます。また、このスクリプトをレスポンスした直後、ルームの削除処理時に何らかのエラーが発生した場合には、ルームの削除が失敗する可能性があります。

Request ¶

{
  lobbyName=[string] GS2-Chat のロビー名,
  roomId=[string] 削除するルームのID,
  allowUserIds=[array<string>] 入室可能なユーザIDリスト,
  password=[string] パスワード
}

Response ¶

{
  permit=[bool] ルームの削除を許可するか,
}

ルーム削除完了時 ¶

ルームの削除が完了した時に呼び出されます。このイベントが発生した瞬間にはルームの削除が完了されていることが保証されています。

Request ¶

{
  lobbyName=[string] GS2-Chat のロビー名,
  roomId=[string] 削除するルームのID,
  allowUserIds=[array<string>] 入室可能なユーザIDリスト,
  password=[string] パスワード
}

Response ¶

{
}

購読新規作成時 ¶

購読新規作成時に呼び出されます。このイベントが発生した瞬間にはまだ購読の作成は実行されておらず、スクリプトの結果として「作成を許可しない」というレスポンスを返すことが出来ます。また、このスクリプトをレスポンスした直後、購読の永続化処理時に何らかのエラーが発生した場合には、購読の作成が失敗する可能性があります。

Request ¶

{
  lobbyName=[string] GS2-Chat のロビー名,
  userId=[string] ユーザID,
  roomId=[string] 購読するルームID,
  accessToken=[string] アクセストークン
}

Response ¶

{
  permit=[bool] 購読の作成を許可するか
}

購読新規作成完了時 ¶

購読の新規作成が完了した時に呼び出されます。このイベントが発生した瞬間には購読の永続化が完了されていることが保証されています。

Request ¶

{
  lobbyName=[string] GS2-Chat のロビー名,
  userId=[string] ユーザID,
  roomId=[string] 購読するルームID,
  accessToken=[string] アクセストークン
}

Response ¶

{
}

購読解除時 ¶

購読解除時に呼び出されます。このイベントが発生した瞬間にはまだ購読の解除は実行されておらず、スクリプトの結果として「解除を許可しない」というレスポンスを返すことが出来ます。また、このスクリプトをレスポンスした直後、購読の解除処理時に何らかのエラーが発生した場合には、購読の解除が失敗する可能性があります。

Request ¶

{
  lobbyName=[string] GS2-Chat のロビー名,
  userId=[string] ユーザID,
  roomId=[string] 購読解除するルームID,
  accessToken=[string] アクセストークン
}

Response ¶

{
  permit=[bool] 購読の解除を許可するか,
}

購読解除完了時 ¶

購読の解除が完了した時に呼び出されます。このイベントが発生した瞬間には購読の解除が完了されていることが保証されています。

Request ¶

{
  lobbyName=[string] GS2-Chat のロビー名,
  userId=[string] ユーザID,
  roomId=[string] 購読解除するルームID,
  accessToken=[string] アクセストークン
}

Response ¶

{
}

メッセージ送信時 ¶

メッセージ送信時に呼び出されます。このイベントが発生した瞬間にはまだメッセージの送信は実行されておらず、スクリプトの結果として「作成を許可しない」というレスポンスを返すことが出来ます。また、このスクリプトをレスポンスした直後、メッセージの永続化処理時に何らかのエラーが発生した場合には、メッセージの送信が失敗する可能性があります。

Request ¶

{
  lobbyName=[string] GS2-Chat のロビー名,
  roomId=[string] ルームID,
  userId=[string] ユーザID,
  message=[string] メッセージテキスト,
  meta=[string] メッセージメタデータ,
  accessToken=[string] アクセストークン,
}

Response ¶

{
  permit=[bool] メッセージの送信を許可するか,
  (overrideMessage=[string] 実際に適用するメッセージテキスト)
  (overrideMeta=[string] 実際に適用するメッセージメタデータ)
}

メッセージ送信完了時 ¶

メッセージの新規作成が完了した時に呼び出されます。このイベントが発生した瞬間にはメッセージの永続化が完了されていることが保証されています。

Request ¶

{
  lobbyName=[string] GS2-Chat のロビー名,
  roomId=[string] ルームID,
  userId=[string] ユーザID,
  message=[string] メッセージテキスト,
  meta=[string] メッセージメタデータ,
  accessToken=[string] アクセストークン,
}

Response ¶

{
}