PFProfilesGetEntityProfileRequest

PFProfilesGetEntityProfileRequest data model. Given an entity type and entity identifier will retrieve the profile from the entity store. If the profile being retrieved is the caller’s, then the read operation is consistent, if not it is an inconsistent read. An inconsistent read means that we do not guarantee all committed writes have occurred before reading the profile, allowing for a stale read. If consistency is important the Version Number on the result can be used to compare which version of the profile any reader has.

Syntax

typedef struct PFProfilesGetEntityProfileRequest {  
    PFStringDictionaryEntry const* customTags;  
    uint32_t customTagsCount;  
    bool const* dataAsObject;  
    PFEntityKey const* entity;  
    bool includeStatistics;  
} PFProfilesGetEntityProfileRequest;  

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 dataAsObject bool const*
may be nullptr (Optional) Determines whether the objects will be returned as an escaped JSON string or as a un-escaped JSON object. Default is JSON string. entity PFEntityKey const*
may be nullptr (Optional) The optional entity to perform this action on. Defaults to the currently logged in entity. includeStatistics bool Determines whether the entity statistics will be returned in the entity profile. Default is false.

Requirements

Header: PFProfilesTypes.h

PlayFab API

PlayFab REST API References

Supplemental pages

PFProfilesGetEntityProfileRequest

Syntax

Members

Requirements

See also

​Syntax

​Members

​Requirements

​See also

Syntax

Members

Requirements

See also