GS2-Chat
Reference to resource definitions available in GS2-Deploy templates
GS2-Deploy Reference
Entities
Namespace
Namespace
Type: GS2::Chat::Namespace
Properties:
Name: namespace1
Description: null
AllowCreateRoom: null
PostMessageScript: null
CreateRoomScript: null
DeleteRoomScript: null
SubscribeRoomScript: null
UnsubscribeRoomScript: null
PostNotification: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1
from gs2_cdk import Stack, core, chat
class SampleStack(Stack):
def __init__(self):
super().__init__()
chat.Namespace(
stack=self,
name="namespace-0001",
options=chat.NamespaceOptions(
log_setting=core.LogSetting(
logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
),
),
)
print(SampleStack().yaml()) # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
new \Gs2Cdk\Chat\Model\Namespace_(
stack: $this,
name: "namespace-0001",
options: new \Gs2Cdk\Chat\Model\Options\NamespaceOptions(
logSetting: new \Gs2Cdk\Core\Model\LogSetting(
loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001",
),
),
);
}
}
print((new SampleStack())->yaml()); // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.chat.model.Namespace(
this,
"namespace-0001",
new io.gs2.cdk.chat.model.options.NamespaceOptions() {
{
logSetting = new io.gs2.cdk.core.model.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
);
}
}
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
import core from "@/gs2cdk/core";
import chat from "@/gs2cdk/chat";
class SampleStack extends core.Stack
{
public constructor() {
super();
new chat.model.Namespace(
this,
"namespace-0001",
{
logSetting: new core.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
}
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Chat.Model.Namespace(
this,
"namespace-0001",
new Gs2Cdk.Gs2Chat.Model.Options.NamespaceOptions {
logSetting = new Gs2Cdk.Core.Model.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
),
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Template
Namespace
Namespace is a mechanism that allows multiple uses of the same service for different purposes within a single project.
Basically, GS2 services have a layer called namespace, and different namespaces are treated as completely different data spaces, even for the same service.
Therefore, it is necessary to create a namespace before starting to use each service.
Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
name | string | ✓ | ~ 32 chars | Namespace name | |
description | string | ~ 1024 chars | description of Namespace | ||
allowCreateRoom | bool | ✓ | true | Allow game players to create rooms? | |
postMessageScript | ScriptSetting | Script to run when you post a message | |||
createRoomScript | ScriptSetting | Script to run when a room is created | |||
deleteRoomScript | ScriptSetting | Script to run when a room is deleted | |||
subscribeRoomScript | ScriptSetting | Script to run when a room is subscribed | |||
unsubscribeRoomScript | ScriptSetting | Script to run when a room is unsubscribed | |||
postNotification | NotificationSetting | Push notifications when new posts come to the rooms to which you are subscribed | |||
logSetting | LogSetting | Log output settings |