Transaction Action of GS2-Guild

Specification of verify/consume/acquire transaction actions

VerifyAction

Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName

Verify the maximum number of guild members by specifying a Guild name

Whether the action allows quantity specification: NO

Type

Condition

Required

Default

Value Limits

Description

namespaceName

string

✓

~ 128 chars

Namespace name

Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).

guildModelName

string

✓

~ 128 chars

Guild Model name

Guild Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).

guildName

string

✓

~ 128 chars

Guild name

verifyType

String Enum
enum {
  “less”,
  “lessEqual”,
  “greater”,
  “greaterEqual”,
  “equal”,
  “notEqual”
}

✓

Type of verification

Enumerator String Definition	Description
“less”	The maximum number of guild members is less than the specified value
“lessEqual”	The maximum number of guild members is less than or equal to the specified value
“greater”	The maximum number of guild members is greater than the specified value
“greaterEqual”	The maximum number of guild members is greater than or equal to the specified value
“equal”	The maximum number of guild members is equal to the specified value
“notEqual”	The maximum number of guild members is not equal to the specified value

value

int

1 ~ 2147483646

Maximum number of guild members

multiplyValueSpecifyingQuantity

bool

✓

false

Whether to multiply the value used for verification when specifying the quantity

{
    "action": "Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName",
    "request": {
        "namespaceName": "[string]Namespace name",
        "guildModelName": "[string]Guild Model name",
        "guildName": "[string]Guild name",
        "verifyType": "[string]Type of verification",
        "value": "[int]Maximum number of guild members",
        "multiplyValueSpecifyingQuantity": "[bool]Whether to multiply the value used for verification when specifying the quantity"
    }
}

action: Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName
request:
  namespaceName: "[string]Namespace name"
  guildModelName: "[string]Guild Model name"
  guildName: "[string]Guild name"
  verifyType: "[string]Type of verification"
  value: "[int]Maximum number of guild members"
  multiplyValueSpecifyingQuantity: "[bool]Whether to multiply the value used for verification when specifying the quantity"

transaction.service("guild").verify.verify_current_maximum_member_count_by_guild_name({
    namespaceName="[string]Namespace name",
    guildModelName="[string]Guild Model name",
    guildName="[string]Guild name",
    verifyType="[string]Type of verification",
    value="[int]Maximum number of guild members",
    multiplyValueSpecifyingQuantity="[bool]Whether to multiply the value used for verification when specifying the quantity",
})

Gs2Guild:VerifyIncludeMemberByUserId

Verify if guild members include user ID by specifying a user ID

Whether the action allows quantity specification: NO

Type Condition Required Default Value Limits Description

namespaceName

string

✓

~ 128 chars

Namespace name

Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).

guildModelName

string

✓

~ 128 chars

Guild Model name

Guild Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).

guildName

string

✓

UUID

~ 36 chars

Guild Name

Maintains a unique name for each guild.
The name is automatically generated in UUID (Universally Unique Identifier) format and used to identify each guild.

userId

string

✓

~ 128 chars

User ID
Set #{userId} to replace the currently logged in user ID.

verifyType

String Enum
enum {
“include”,
“notInclude”
}

✓

Type of verification

Enumerator String Definition	Description
“include”	Guild members include the specified user
“notInclude”	Guild members do not include the specified user

timeOffsetToken string ~ 1024 chars Time offset token

{
    "action": "Gs2Guild:VerifyIncludeMemberByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "guildModelName": "[string]Guild Model name",
        "guildName": "[string]Guild Name",
        "userId": "[string]User ID",
        "verifyType": "[string]Type of verification",
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2Guild:VerifyIncludeMemberByUserId
request:
  namespaceName: "[string]Namespace name"
  guildModelName: "[string]Guild Model name"
  guildName: "[string]Guild Name"
  userId: "[string]User ID"
  verifyType: "[string]Type of verification"
  timeOffsetToken: "[string]Time offset token"

transaction.service("guild").verify.verify_include_member_by_user_id({
    namespaceName="[string]Namespace name",
    guildModelName="[string]Guild Model name",
    guildName="[string]Guild Name",
    userId="[string]User ID",
    verifyType="[string]Type of verification",
    timeOffsetToken="[string]Time offset token",
})

ConsumeAction

Gs2Guild:DecreaseMaximumCurrentMaximumMemberCountByGuildName

Decrease the maximum number of members by specifying a Guild name

Whether the action allows quantity specification: YES

Whether the action is reversible: YES

	Type	Required	Value Limits	Description
namespaceName	string	✓	~ 128 chars	Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
guildModelName	string	✓	~ 128 chars	Guild Model name Guild Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
guildName	string	✓	~ 128 chars	Guild name
value	int		1 ~ 2147483646	Increase the maximum number of members

{
    "action": "Gs2Guild:DecreaseMaximumCurrentMaximumMemberCountByGuildName",
    "request": {
        "namespaceName": "[string]Namespace name",
        "guildModelName": "[string]Guild Model name",
        "guildName": "[string]Guild name",
        "value": "[int]Increase the maximum number of members"
    }
}

action: Gs2Guild:DecreaseMaximumCurrentMaximumMemberCountByGuildName
request:
  namespaceName: "[string]Namespace name"
  guildModelName: "[string]Guild Model name"
  guildName: "[string]Guild name"
  value: "[int]Increase the maximum number of members"

transaction.service("guild").consume.decrease_maximum_current_maximum_member_count_by_guild_name({
    namespaceName="[string]Namespace name",
    guildModelName="[string]Guild Model name",
    guildName="[string]Guild name",
    value="[int]Increase the maximum number of members",
})

AcquireAction

Gs2Guild:IncreaseMaximumCurrentMaximumMemberCountByGuildName

Add the maximum number of members by specifying a Guild name

Whether the action allows quantity specification: YES

Whether the action is reversible: YES

	Type	Required	Value Limits	Description
namespaceName	string	✓	~ 128 chars	Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
guildModelName	string	✓	~ 128 chars	Guild Model name Guild Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
guildName	string	✓	~ 128 chars	Guild name
value	int		1 ~ 2147483646	Increase the maximum number of members

{
    "action": "Gs2Guild:IncreaseMaximumCurrentMaximumMemberCountByGuildName",
    "request": {
        "namespaceName": "[string]Namespace name",
        "guildModelName": "[string]Guild Model name",
        "guildName": "[string]Guild name",
        "value": "[int]Increase the maximum number of members"
    }
}

action: Gs2Guild:IncreaseMaximumCurrentMaximumMemberCountByGuildName
request:
  namespaceName: "[string]Namespace name"
  guildModelName: "[string]Guild Model name"
  guildName: "[string]Guild name"
  value: "[int]Increase the maximum number of members"

transaction.service("guild").acquire.increase_maximum_current_maximum_member_count_by_guild_name({
    namespaceName="[string]Namespace name",
    guildModelName="[string]Guild Model name",
    guildName="[string]Guild name",
    value="[int]Increase the maximum number of members",
})

Gs2Guild:SetMaximumCurrentMaximumMemberCountByGuildName

Set the maximum number of guild members by specifying a Guild name

Whether the action allows quantity specification: NO

Whether the action is reversible: NO

	Type	Required	Value Limits	Description
namespaceName	string	✓	~ 128 chars	Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
guildName	string	✓	~ 128 chars	Guild name
guildModelName	string	✓	~ 128 chars	Guild Model name Guild Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
value	int		1 ~ 2147483646	Set the maximum number of members

{
    "action": "Gs2Guild:SetMaximumCurrentMaximumMemberCountByGuildName",
    "request": {
        "namespaceName": "[string]Namespace name",
        "guildName": "[string]Guild name",
        "guildModelName": "[string]Guild Model name",
        "value": "[int]Set the maximum number of members"
    }
}

action: Gs2Guild:SetMaximumCurrentMaximumMemberCountByGuildName
request:
  namespaceName: "[string]Namespace name"
  guildName: "[string]Guild name"
  guildModelName: "[string]Guild Model name"
  value: "[int]Set the maximum number of members"

transaction.service("guild").acquire.set_maximum_current_maximum_member_count_by_guild_name({
    namespaceName="[string]Namespace name",
    guildName="[string]Guild name",
    guildModelName="[string]Guild Model name",
    value="[int]Set the maximum number of members",
})