Trigger Reference of GS2-Chat Script

Reference of event triggers that call extended scripts

Trigger

createRoom

Room creation

Synchronous Execution Script

Script and Room creation are executed synchronously in that order.

Request

	Type	Description
namespace	Namespace	Namespace
room	Room	Room

Result

	Type	Required	Default	Value Limits	Description
permit	bool	✓			Whether to allow room creation

Implementation Example

namespace = args.namespace
room = args.room

result = {
  permit=permit
}

Asynchronous Execution Script

The script executes asynchronously after the Room creation.

Request

	Type	Description
namespace	Namespace	Namespace
room	Room	Room

Result

	Type	Required	Default	Value Limits	Description

Implementation Example

namespace = args.namespace
room = args.room

result = {
}

deleteRoom

Room deletion

Synchronous Execution Script

Script and Room deletion are executed synchronously in that order.

Request

	Type	Description
namespace	Namespace	Namespace
room	Room	Room

Result

	Type	Required	Default	Value Limits	Description
permit	bool	✓			Whether to allow room deletion

Implementation Example

namespace = args.namespace
room = args.room

result = {
  permit=permit
}

Asynchronous Execution Script

The script executes asynchronously after the Room deletion.

Request

	Type	Description
namespace	Namespace	Namespace
room	Room	Room

Result

	Type	Required	Default	Value Limits	Description

Implementation Example

namespace = args.namespace
room = args.room

result = {
}

postMessage

Message posting

Synchronous Execution Script

Script and Message posting are executed synchronously in that order.

Request

	Type	Description
namespace	Namespace	Namespace
room	Room	Room
message	Message	Message

Result

	Type	Required	Default	Value Limits	Description
permit	bool	✓			Whether to allow message posting

Implementation Example

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

result = {
  permit=permit
}

Asynchronous Execution Script

The script executes asynchronously after the Message posting.

Request

	Type	Description
namespace	Namespace	Namespace
room	Room	Room
message	Message	Message

Result

	Type	Required	Default	Value Limits	Description

Implementation Example

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

result = {
}

subscribeRoom

Room subscription

Synchronous Execution Script

Script and Room subscription are executed synchronously in that order.

Request

	Type	Description
namespace	Namespace	Namespace
room	Room	Room
subscribe	Subscribe	Subscribe

Result

	Type	Required	Default	Value Limits	Description
permit	bool	✓			Whether to allow room subscription

Implementation Example

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

result = {
  permit=permit
}

Asynchronous Execution Script

The script executes asynchronously after the Room subscription.

Request

	Type	Description
namespace	Namespace	Namespace
room	Room	Room
subscribe	Subscribe	Subscribe

Result

	Type	Required	Default	Value Limits	Description

Implementation Example

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

result = {
}

unsubscribeRoom

Room unsubscription

Synchronous Execution Script

Script and Room unsubscription are executed synchronously in that order.

Request

	Type	Description
namespace	Namespace	Namespace
room	Room	Room
subscribe	Subscribe	Subscribe

Result

	Type	Required	Default	Value Limits	Description
permit	bool	✓			Whether to allow room unsubscription

Implementation Example

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

result = {
  permit=permit
}

Asynchronous Execution Script

The script executes asynchronously after the Room unsubscription.

Request

	Type	Description
namespace	Namespace	Namespace
room	Room	Room
subscribe	Subscribe	Subscribe

Result

	Type	Required	Default	Value Limits	Description

Implementation Example

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

result = {
}