PFLeaderboardsGetLeaderboardDefinitionResponse

PFLeaderboardsGetLeaderboardDefinitionResponse data model.

Syntax

typedef struct PFLeaderboardsGetLeaderboardDefinitionResponse {  
    PFLeaderboardsLeaderboardColumn const* columns;  
    uint32_t columnsCount;  
    time_t created;  
    const char* entityType;  
    PFLeaderboardsLeaderboardEventEmissionConfig const* eventEmissionConfig;  
    time_t const* lastResetTime;  
    const char* name;  
    int32_t sizeLimit;  
    uint32_t version;  
    PFVersionConfiguration const* versionConfiguration;  
} PFLeaderboardsGetLeaderboardDefinitionResponse;  

Members

columns   PFLeaderboardsLeaderboardColumn const*

Sort direction of the leaderboard columns, cannot be changed after creation.

columnsCount   uint32_t

Count of columns

created   time_t

Created time, in UTC.

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.

lastResetTime   time_t const*
may be nullptr

(Optional) Last time, in UTC, leaderboard version was incremented.

name   const char*
is null-terminated

A name for the leaderboard, unique per title.

sizeLimit   int32_t

Maximum number of entries on this leaderboard.

version   uint32_t

Latest Leaderboard version.

versionConfiguration   PFVersionConfiguration const*

The version reset configuration for the leaderboard definition.

Requirements

Header: PFLeaderboardsTypes.h

See also

PFLeaderboardsTypes members