GS2-Chat Script トリガーリファレンス

拡張スクリプトを呼び出すイベントトリガーのリファレンス

トリガー

createRoom

ルーム作成

同期実行スクリプト

ルーム作成処理の前に、スクリプトが同期実行されます。

Request

	型	説明
namespace	Namespace	ネームスペース
room	Room	ルーム

Result

	型	必須	デフォルト	値の制限	説明
permit	bool	✓			ルーム作成を許可するか

実装例

namespace = args.namespace
room = args.room

result = {
  permit=permit
}

非同期実行スクリプト

ルーム作成処理の後に、スクリプトが非同期実行されます。

Request

	型	説明
namespace	Namespace	ネームスペース
room	Room	ルーム

実装例

namespace = args.namespace
room = args.room

result = {
}

deleteRoom

ルーム削除

同期実行スクリプト

ルーム削除処理の前に、スクリプトが同期実行されます。

Request

	型	説明
namespace	Namespace	ネームスペース
room	Room	ルーム

Result

	型	必須	デフォルト	値の制限	説明
permit	bool	✓			ルーム削除を許可するか

実装例

namespace = args.namespace
room = args.room

result = {
  permit=permit
}

非同期実行スクリプト

ルーム削除処理の後に、スクリプトが非同期実行されます。

Request

	型	説明
namespace	Namespace	ネームスペース
room	Room	ルーム

実装例

namespace = args.namespace
room = args.room

result = {
}

postMessage

メッセージ投稿

同期実行スクリプト

メッセージ投稿処理の前に、スクリプトが同期実行されます。

Request

	型	説明
namespace	Namespace	ネームスペース
room	Room	ルーム
message	Message	メッセージ

Result

	型	必須	デフォルト	値の制限	説明
permit	bool	✓			メッセージ投稿を許可するか

実装例

namespace = args.namespace
room = args.room
message = args.message

result = {
  permit=permit
}

非同期実行スクリプト

メッセージ投稿処理の後に、スクリプトが非同期実行されます。

Request

	型	説明
namespace	Namespace	ネームスペース
room	Room	ルーム
message	Message	メッセージ

実装例

namespace = args.namespace
room = args.room
message = args.message

result = {
}

subscribeRoom

ルーム購読

同期実行スクリプト

ルーム購読処理の前に、スクリプトが同期実行されます。

Request

	型	説明
namespace	Namespace	ネームスペース
room	Room	ルーム
subscribe	Subscribe	購読

Result

	型	必須	デフォルト	値の制限	説明
permit	bool	✓			ルーム購読を許可するか

実装例

namespace = args.namespace
room = args.room
subscribe = args.subscribe

result = {
  permit=permit
}

非同期実行スクリプト

ルーム購読処理の後に、スクリプトが非同期実行されます。

Request

	型	説明
namespace	Namespace	ネームスペース
room	Room	ルーム
subscribe	Subscribe	購読

実装例

namespace = args.namespace
room = args.room
subscribe = args.subscribe

result = {
}

unsubscribeRoom

ルーム購読解除

同期実行スクリプト

ルーム購読解除処理の前に、スクリプトが同期実行されます。

Request

	型	説明
namespace	Namespace	ネームスペース
room	Room	ルーム
subscribe	Subscribe	購読

Result

	型	必須	デフォルト	値の制限	説明
permit	bool	✓			ルーム購読解除を許可するか

実装例

namespace = args.namespace
room = args.room
subscribe = args.subscribe

result = {
  permit=permit
}

非同期実行スクリプト

ルーム購読解除処理の後に、スクリプトが非同期実行されます。

Request

	型	説明
namespace	Namespace	ネームスペース
room	Room	ルーム
subscribe	Subscribe	購読

実装例

namespace = args.namespace
room = args.room
subscribe = args.subscribe

result = {
}