GS2-Chat
Reference for event triggers that call GS2-Script
GS2-Script Reference
Trigger
createRoom
createRoom
namespace = args.namespace
room = args.room
result = {
permit=permit
}
Event trigger to call GS2-Script before a room is created.
Request
| Type | Description | |
|---|---|---|
| namespace | Namespace | Namespace |
| room | Room | Room |
Result
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| permit | bool | ✓ | Allow room creation? |
createRoomDone
createRoomDone
namespace = args.namespace
room = args.room
result = {
}
GS2-Script called after a room is created.
Request
| Type | Description | |
|---|---|---|
| namespace | Namespace | Namespace |
| room | Room | Room |
Result
| Type | Require | Default | Limitation | Description |
|---|
deleteRoom
deleteRoom
namespace = args.namespace
room = args.room
result = {
permit=permit
}
Event trigger to call GS2-Script before a room is deleted.
Request
| Type | Description | |
|---|---|---|
| namespace | Namespace | Namespace |
| room | Room | Room |
Result
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| permit | bool | ✓ | Allow room deletion or |
deleteRoomDone
deleteRoomDone
namespace = args.namespace
room = args.room
result = {
}
GS2-Script called after a room is deleted.
Request
| Type | Description | |
|---|---|---|
| namespace | Namespace | Namespace |
| room | Room | Room |
Result
| Type | Require | Default | Limitation | Description |
|---|
postMessage
postMessage
namespace = args.namespace
room = args.room
message = args.message
result = {
permit=permit
}
Event trigger to call GS2-Script before posting a message.
Request
| Type | Description | |
|---|---|---|
| namespace | Namespace | Namespace |
| room | Room | Room |
| message | Message | Message |
Result
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| permit | bool | ✓ | Allow message posting or |
postMessageDone
postMessageDone
namespace = args.namespace
room = args.room
message = args.message
result = {
}
GS2-Script called after posting a message.
Request
| Type | Description | |
|---|---|---|
| namespace | Namespace | Namespace |
| room | Room | Room |
| message | Message | Message |
Result
| Type | Require | Default | Limitation | Description |
|---|
subscribeRoom
subscribeRoom
namespace = args.namespace
room = args.room
subscribe = args.subscribe
result = {
permit=permit
}
Event trigger to call GS2-Script before subscribing to a room.
Request
| Type | Description | |
|---|---|---|
| namespace | Namespace | Namespace |
| room | Room | Room |
| subscribe | Subscribe | Subscribe |
Result
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| permit | bool | ✓ | Allow room subscription |
subscribeRoomDone
subscribeRoomDone
namespace = args.namespace
room = args.room
subscribe = args.subscribe
result = {
}
GS2-Script called after subscribing to a room.
Request
| Type | Description | |
|---|---|---|
| namespace | Namespace | Namespace |
| room | Room | Room |
| subscribe | Subscribe | Subscribe |
Result
| Type | Require | Default | Limitation | Description |
|---|
unsubscribeRoom
unsubscribeRoom
namespace = args.namespace
room = args.room
subscribe = args.subscribe
result = {
permit=permit
}
Event trigger to call GS2-Script before room subscription is cancelled.
Request
| Type | Description | |
|---|---|---|
| namespace | Namespace | Namespace |
| room | Room | Room |
| subscribe | Subscribe | Subscribe |
Result
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| permit | bool | ✓ | Allow room unsubscription |
unsubscribeRoomDone
unsubscribeRoomDone
namespace = args.namespace
room = args.room
subscribe = args.subscribe
result = {
}
GS2-Script called after room subscription is cancelled.
Request
| Type | Description | |
|---|---|---|
| namespace | Namespace | Namespace |
| room | Room | Room |
| subscribe | Subscribe | Subscribe |
Result
| Type | Require | Default | Limitation | Description |
|---|