NAV
Japanese | English
GS2-Script

GS2-Chat

GS2-Scriptを呼び出すイベントトリガーのリファレンス

GS2-Script リファレンス

トリガー

createRoom

createRoom

namespace = args.namespace
room = args.room

result = {
  permit=permit
}

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

Request

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

Result

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

createRoomDone

createRoomDone

namespace = args.namespace
room = args.room

result = {
}

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

Request

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

Result

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

deleteRoom

deleteRoom

namespace = args.namespace
room = args.room

result = {
  permit=permit
}

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

Request

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

Result

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

deleteRoomDone

deleteRoomDone

namespace = args.namespace
room = args.room

result = {
}

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

Request

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

Result

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

postMessage

postMessage

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

result = {
  permit=permit
}

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

Request

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

Result

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

postMessageDone

postMessageDone

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

result = {
}

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

Request

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

Result

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

subscribeRoom

subscribeRoom

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

result = {
  permit=permit
}

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

Request

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

Result

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

subscribeRoomDone

subscribeRoomDone

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

result = {
}

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

Request

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

Result

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

unsubscribeRoom

unsubscribeRoom

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

result = {
  permit=permit
}

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

Request

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

Result

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

unsubscribeRoomDone

unsubscribeRoomDone

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

result = {
}

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

Request

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

Result

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