PFGroupsUpdateGroupRequest

PFGroupsUpdateGroupRequest data model. Updates data about a group, such as the name or default member role. Returns information about whether the update was successful. Only title claimants may modify the administration role for a group.

Syntax

typedef struct PFGroupsUpdateGroupRequest {  
    const char* adminRoleId;  
    PFStringDictionaryEntry const* customTags;  
    uint32_t customTagsCount;  
    int32_t const* expectedProfileVersion;  
    PFEntityKey const* group;  
    const char* groupName;  
    const char* memberRoleId;  
} PFGroupsUpdateGroupRequest;  

Members

adminRoleId const char*
is null-terminated (Optional) Optional: the ID of an existing role to set as the new administrator role for the group. 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 expectedProfileVersion int32_t const*
may be nullptr (Optional) Optional field used for concurrency control. By specifying the previously returned ProfileVersion value from the GetGroup API, you can ensure that the group data update is performed only if the group has not been updated since you last loaded that version. If the same group has been updated, the requested update will not occur and the returned SetResult value will be None. group PFEntityKey const* The identifier of the group. groupName const char*
is null-terminated (Optional) Optional: the new name of the group. memberRoleId const char*
is null-terminated (Optional) Optional: the ID of an existing role to set as the new member role for the group.

Requirements

Header: PFGroupsTypes.h

PlayFab API

PlayFab REST API References

Syntax

Members

Requirements

See also

​Syntax

​Members

​Requirements

​See also

Syntax

Members

Requirements

See also