PFLeaderboardsCreateLeaderboardDefinitionRequest

PFLeaderboardsCreateLeaderboardDefinitionRequest data model.

Syntax

typedef struct PFLeaderboardsCreateLeaderboardDefinitionRequest {  
    PFLeaderboardsLeaderboardColumn const* columns;  
    uint32_t columnsCount;  
    PFStringDictionaryEntry const* customTags;  
    uint32_t customTagsCount;  
    const char* entityType;  
    PFLeaderboardsLeaderboardEventEmissionConfig const* eventEmissionConfig;  
    const char* name;  
    int32_t sizeLimit;  
    PFVersionConfiguration const* versionConfiguration;  
} PFLeaderboardsCreateLeaderboardDefinitionRequest;  

Members

columns   PFLeaderboardsLeaderboardColumn const*

Leaderboard columns describing the sort directions, cannot be changed after creation. A maximum of 5 columns are allowed.

columnsCount   uint32_t

Count of columns

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

entityType   const char*
is null-terminated

The entity type being represented on the leaderboard. If it doesn't correspond to the PlayFab entity types, use 'external' as the type.

eventEmissionConfig   PFLeaderboardsLeaderboardEventEmissionConfig const*
may be nullptr

(Optional) [In Preview]: The configuration for the events emitted by this leaderboard. If not specified, no events will be emitted.

name   const char*
is null-terminated

A name for the leaderboard, unique per title.

sizeLimit   int32_t

Maximum number of entries on this leaderboard.

versionConfiguration   PFVersionConfiguration const*
may be nullptr

(Optional) The version reset configuration for the leaderboard definition.

Requirements

Header: PFLeaderboardsTypes.h

See also

PFLeaderboardsTypes members