Transaction Action of GS2-Guild

VerifyAction

Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName

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

Actions for which quantity can be specified: NO

TypeDescription
namespaceNamestringNamespace name
guildModelNamestringGuild Model Name
guildNamestringGuild name
verifyTypeenum [
    “less”,
    “lessEqual”,
    “greater”,
    “greaterEqual”,
    “equal”,
    “notEqual”
]
Type of verification
valueintSet the maximum number of members
multiplyValueSpecifyingQuantityboolWhether to multiply the value used for verification when specifying the quantity

Enumeration type definition to specify as verifyType

Enumerator String DefinitionDescription
lessRank is less than the specified value
lessEqualRank is less than or equal to the specified value
greaterRank is greater than the specified value
greaterEqualRank is greater than or equal to the specified value
equalRank is equal to the specified value
notEqualRank is not equal to the specified value
{
    "action": "Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName",
    "request": {
        "namespaceName": "[string]Namespace name",
        "guildModelName": "[string]Guild Model Name",
        "guildName": "[string]Guild name",
        "verifyType": "[string]Type of verification",
        "value": "[int]Set the maximum number of 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]Set the maximum number of members"
  multiplyValueSpecifyingQuantity: "[bool]Whether to multiply the value used for verification when specifying the quantity"
transaction.service("guild").consume.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]Set the maximum number of 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 user ID

Actions for which quantity can be specified: NO

TypeDescription
namespaceNamestringNamespace name
guildModelNamestringGuild Model Name
guildNamestringGuild Name
userIdstring
Set #{userId} to replace the currently logged in user ID.
verifyTypeenum [
    “include”,
    “notInclude”
]
Type of verification
timeOffsetTokenstringTime offset token

Enumeration type definition to specify as verifyType

Enumerator String DefinitionDescription
includeGuild members include the specified user
notIncludeGuild members do not include the specified user
{
    "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").consume.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 the guild name

Actions for which quantity can be specified: YES

Reversible action: YES

TypeDescription
namespaceNamestringNamespace name
guildModelNamestringGuild Model Name
guildNamestringGuild name
valueintIncrease 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 the guild name

Actions for which quantity can be specified: YES

Reversible action: YES

TypeDescription
namespaceNamestringNamespace name
guildModelNamestringGuild Model Name
guildNamestringGuild name
valueintIncrease 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 waiting time by specifying the guild name

Actions for which quantity can be specified: NO

Reversible action: NO

TypeDescription
namespaceNamestringNamespace name
guildNamestringGuild name
guildModelNamestringGuild Model Name
valueintSet 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",
})