PFGroupsChangeMemberRoleRequest

PFGroupsChangeMemberRoleRequest data model. Changes the role membership of a list of entities from one role to another in a single operation. The destination role must already exist. This is equivalent to adding the entities to the destination role and removing from the origin role. Returns nothing if successful.

Syntax

typedef struct PFGroupsChangeMemberRoleRequest {  
    PFStringDictionaryEntry const* customTags;  
    uint32_t customTagsCount;  
    const char* destinationRoleId;  
    PFEntityKey const* group;  
    PFEntityKey const* members;  
    uint32_t membersCount;  
    const char* originRoleId;  
} PFGroupsChangeMemberRoleRequest;  

Members

customTags PFStringDictionaryEntry const*
may be nullptr (Optional) The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). customTagsCount uint32_t Count of customTags destinationRoleId const char*
is null-terminated (Optional) The ID of the role that the entities will become a member of. This must be an existing role. Role IDs must be between 1 and 64 characters long. group PFEntityKey const* The identifier of the group. members PFEntityKey const* List of entities to move between roles in the group. All entities in this list must be members of the group and origin role. membersCount uint32_t Count of members originRoleId const char*
is null-terminated The ID of the role that the entities currently are a member of. Role IDs must be between 1 and 64 characters long.

Requirements

Header: PFGroupsTypes.h

PlayFab API

Syntax

Members

Requirements

See also

​Syntax

​Members

​Requirements

​See also

Syntax

Members

Requirements

See also