GS2-Deploy/CDK Reference of GS2-Friend
Entities
Namespace
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 | ||
followScript | ScriptSetting | Script to run when followed | |||
unfollowScript | ScriptSetting | Script to run when unfollowed | |||
sendRequestScript | ScriptSetting | Script to run when a friend request is issued | |||
cancelRequestScript | ScriptSetting | Script to execute when a friend request is canceled | |||
acceptRequestScript | ScriptSetting | Script to run when a friend request is accepted | |||
rejectRequestScript | ScriptSetting | Script to execute when a friend request is rejected | |||
deleteFriendScript | ScriptSetting | Script to run when a friend is deleted | |||
updateProfileScript | ScriptSetting | Script to run when you update your profile | |||
followNotification | NotificationSetting | Push notification when you are followed | |||
receiveRequestNotification | NotificationSetting | ✓ | Push notification when a friend request is received | ||
acceptRequestNotification | NotificationSetting | ✓ | Push notification when a friend request is approved | ||
logSetting | LogSetting | Log output settings |
GetAttr
Type | Description | |
---|---|---|
Item | Namespace | Namespace created |
Implementation Example
Type: GS2::Friend::Namespace
Properties:
Name: namespace1
Description: null
FollowScript: null
UnfollowScript: null
SendRequestScript: null
CancelRequestScript: null
AcceptRequestScript: null
RejectRequestScript: null
DeleteFriendScript: null
UpdateProfileScript: null
FollowNotification: null
ReceiveRequestNotification: null
AcceptRequestNotification: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1
from gs2_cdk import Stack, core, friend
class SampleStack(Stack):
def __init__(self):
super().__init__()
friend.Namespace(
stack=self,
name="namespace-0001",
options=friend.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\Friend\Model\Namespace_(
stack: $this,
name: "namespace-0001",
options: new \Gs2Cdk\Friend\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.friend.model.Namespace(
this,
"namespace-0001",
new io.gs2.cdk.friend.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 friend from "@/gs2cdk/friend";
class SampleStack extends core.Stack
{
public constructor() {
super();
new friend.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.Gs2Friend.Model.Namespace(
this,
"namespace-0001",
new Gs2Cdk.Gs2Friend.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
ScriptSetting
Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
triggerScriptId | string | ~ 1024 chars | Script GRN | ||
doneTriggerTargetType | enum [ “none”, “gs2_script”, “aws” ] | ✓ | “none” | ~ 128 chars | Notification of Completion |
doneTriggerScriptId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024 chars | Script GRN | |
doneTriggerQueueNamespaceId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024 chars | Namespace GRN |
NotificationSetting
Push notification settings
This is a setting for sending push notifications when an event occurs in a GS2 microservice. The push notification here refers to the processing via the WebSocket interface provided by GS2-Gateway, and is different from the push notification of a smartphone. For example, when a matchmaking is completed or a friend request is received, the GS2-Gateway can send a push notification via the WebSocket interface, and the game client can detect the change of the state.
GS2-Gateway’s push notifications can be used to send additional processing to mobile push notifications when the destination device is offline. If you use mobile push notifications well, you may be able to realize a flow in which you can notify the player by using mobile push notifications even if you end the game during matchmaking and return to the game.
Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
gatewayNamespaceId | string | ✓ | “grn:gs2:{region}:{ownerId}:gateway:default” | ~ 1024 chars | GS2-Gateway namespace to use for push notifications |
enableTransferMobileNotification | bool? | false | Forwarding to mobile push notification | ||
sound | string | {enableTransferMobileNotification} == true | ~ 1024 chars | Sound file name to be used for mobile push notifications |
LogSetting
Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
loggingNamespaceId | string | ✓ | ~ 1024 chars | Namespace GRN |