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

GS2-Chatで定義されている、拡張スクリプトを呼び出すイベントトリガーのリファレンス

createRoom

ルーム作成実行前にGS2-Scriptを呼び出すイベントトリガー

Request

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

Result

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

実装例

namespace = args.namespace
room = args.room

result = {
  permit=permit
}

createRoomDone

ルーム作成実行後にGS2-Scriptを呼び出すイベントトリガー

Request

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

Result

	型	必須	デフォルト	値の制限	説明

実装例

namespace = args.namespace
room = args.room

result = {
}

deleteRoom

ルーム削除実行前にGS2-Scriptを呼び出すイベントトリガー

Request

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

Result

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

実装例

namespace = args.namespace
room = args.room

result = {
  permit=permit
}

deleteRoomDone

ルーム削除実行後にGS2-Scriptを呼び出すイベントトリガー

Request

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

Result

	型	必須	デフォルト	値の制限	説明

実装例

namespace = args.namespace
room = args.room

result = {
}

postMessage

メッセージ投稿実行前にGS2-Scriptを呼び出すイベントトリガー

Request

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

Result

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

実装例

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

result = {
  permit=permit
}

postMessageDone

メッセージ投稿実行後にGS2-Scriptを呼び出すイベントトリガー

Request

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

Result

	型	必須	デフォルト	値の制限	説明

実装例

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

result = {
}

subscribeRoom

ルーム購読実行前にGS2-Scriptを呼び出すイベントトリガー

Request

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

Result

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

実装例

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

result = {
  permit=permit
}

subscribeRoomDone

ルーム購読実行後にGS2-Scriptを呼び出すイベントトリガー

Request

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

Result

	型	必須	デフォルト	値の制限	説明

実装例

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

result = {
}

unsubscribeRoom

ルーム購読解除実行前にGS2-Scriptを呼び出すイベントトリガー

Request

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

Result

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

実装例

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

result = {
  permit=permit
}

unsubscribeRoomDone

ルーム購読解除実行後にGS2-Scriptを呼び出すイベントトリガー

Request

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

Result

	型	必須	デフォルト	値の制限	説明

実装例

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

result = {
}