GS2-Chat GS2-Deploy/CDK リファレンス
エンティティ
Namespace
ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。
GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
GetAttr
実装例
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"
)
}
);
}
}
console.log(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
NotificationType
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
category | int | ✓ | 0 | ~ 2147483646 | 新着メッセージ通知を受け取るカテゴリ |
enableTransferMobilePushNotification | bool | ✓ | false | | オフラインだった時にモバイルプッシュ通知に転送するか |
ScriptSetting
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
triggerScriptId | string | | | ~ 1024文字 | スクリプトGRN |
doneTriggerTargetType | enum [’none’, ‘gs2_script’, ‘aws’] | ✓ | “none” | ~ 128文字 | 完了通知の通知先 |
doneTriggerScriptId | string | {doneTriggerTargetType} == “gs2_script” | | ~ 1024文字 | スクリプトGRN |
doneTriggerQueueNamespaceId | string | {doneTriggerTargetType} == “gs2_script” | | ~ 1024文字 | ネームスペースGRN |
NotificationSetting
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
gatewayNamespaceId | string | ✓ | | ~ 1024文字 | ネームスペースGRN |
enableTransferMobileNotification | bool? | | | | モバイルプッシュ通知へ転送するか |
sound | string | | | ~ 1024文字 | モバイルプッシュ通知で使用するサウンドファイル名 |
LogSetting
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
loggingNamespaceId | string | ✓ | | ~ 1024文字 | ネームスペースGRN |