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

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

receiveMessage

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

Request

説明
namespaceNamespaceネームスペース
messageMessageメッセージ

Result

必須デフォルト値の制限説明
permitboolメッセージ受信 を許可するか
overrideMetadatastring~ 4096文字上書き後のメタデータ

実装例

namespace = args.namespace
message = args.message

result = {
  permit=permit,
  overrideMetadata=overrideMetadata
}

receiveMessageDone

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

Request

説明
namespaceNamespaceネームスペース
messageMessageメッセージ

Result

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

実装例

namespace = args.namespace
message = args.message

result = {
}

readMessage

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

Request

説明
namespaceNamespaceネームスペース
messageMessageメッセージ

Result

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

実装例

namespace = args.namespace
message = args.message

result = {
  permit=permit
}

readMessageDone

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

Request

説明
namespaceNamespaceネームスペース
messageMessageメッセージ

Result

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

実装例

namespace = args.namespace
message = args.message

result = {
}

deleteMessage

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

Request

説明
namespaceNamespaceネームスペース
messageMessageメッセージ

Result

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

実装例

namespace = args.namespace
message = args.message

result = {
  permit=permit
}

deleteMessageDone

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

Request

説明
namespaceNamespaceネームスペース
messageMessageメッセージ

Result

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

実装例

namespace = args.namespace
message = args.message

result = {
}