Transaction Action of GS2-Guild

Specification of verify/consume/acquire transaction actions

VerifyAction

Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName

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

Actions for which quantity can be specified: NO

	Type	Description
namespaceName	string	Namespace name
guildModelName	string	Guild Model Name
guildName	string	Guild name
verifyType	enum [ “less”, “lessEqual”, “greater”, “greaterEqual”, “equal”, “notEqual” ]	Type of verification
value	int	Maximum number of guild members
multiplyValueSpecifyingQuantity	bool	Whether to multiply the value used for verification when specifying the quantity

Enumeration type definition to specify as verifyType

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

{
    "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").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]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 user ID

Actions for which quantity can be specified: NO

	Type	Description
namespaceName	string	Namespace name
guildModelName	string	Guild Model Name
guildName	string	Guild Name
userId	string	Set `#{userId}` to replace the currently logged in user ID.
verifyType	enum [ “include”, “notInclude” ]	Type of verification
timeOffsetToken	string	Time offset token

Enumeration type definition to specify as verifyType

Enumerator String Definition	Description
include	Guild members include the specified user
notInclude	Guild 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

	Type	Description
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"
    }
}

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

	Type	Description
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"
    }
}

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

	Type	Description
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"
    }
}

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",
})