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

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

トリガー

receiveMessage

メッセージ受信

同期実行スクリプト

スクリプト、メッセージ受信の順に同期実行されます。

Request

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

Result

	型	必須	デフォルト	値の制限	説明
permit	bool	✓			メッセージ受信を許可するか
overrideMetadata	string			0 ~ 4096文字	上書き後のメタデータ

実装例

namespace = args.namespace
message = args.message

result = {
  permit=permit,
  overrideMetadata=overrideMetadata
}

非同期実行スクリプト

メッセージ受信の実行後にスクリプトが非同期実行されます。

Request

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

Result

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

実装例

namespace = args.namespace
message = args.message

result = {
}

readMessage

メッセージ開封

同期実行スクリプト

スクリプト、メッセージ開封の順に同期実行されます。

Request

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

Result

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

実装例

namespace = args.namespace
message = args.message

result = {
  permit=permit
}

非同期実行スクリプト

メッセージ開封の実行後にスクリプトが非同期実行されます。

Request

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

Result

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

実装例

namespace = args.namespace
message = args.message

result = {
}

deleteMessage

メッセージ削除

同期実行スクリプト

スクリプト、メッセージ削除の順に同期実行されます。

Request

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

Result

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

実装例

namespace = args.namespace
message = args.message

result = {
  permit=permit
}

非同期実行スクリプト

メッセージ削除の実行後にスクリプトが非同期実行されます。

Request

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

Result

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

実装例

namespace = args.namespace
message = args.message

result = {
}