Metadata

Detailed Description

Attach and retrieve typed key-value metadata on LootLocker entities.

Metadata can be attached to Progressions, Leaderboards, Catalogs, Currencies, and Assets. Values are strongly typed: String, Boolean, Number, JSON, or Base64-encoded binary. Entries support optional Tags for filtering and a Game Read flag that restricts visibility to the Server API only — ideal for keeping sensitive config or scoring data out of the game client.

See the LootLocker documentation.

Function Documentation

GetMetadata()

static FString ULootLockerServerForCpp::GetMetadata ( const ELootLockerServerMetadataSources  Source, const FString &  SourceID, const FString &  Key, const FLootLockerServerGetMetadataResponseDelegate &  OnComplete, const bool  IgnoreFiles = false  )

static

Get Metadata for the specified source with the given key.

Parameters

Source	The source type for which to request metadata
SourceID	The specific source id for which to request metadata
Key	The key of the metadata to fetch, use this to fetch metadata for a specific key for the specified source.
OnComplete	delegate for handling the server response
IgnoreFiles	Optional: Base64 values will be set to content_type "application/x-redacted" and the content will be an empty String. Use this to avoid accidentally fetching large data files.

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

GetMultisourceMetadata()

static FString ULootLockerServerForCpp::GetMultisourceMetadata ( const TArray< FLootLockerServerMetadataSourceAndKeys > &  SourcesAndKeysToGet, const FLootLockerServerGetMultisourceMetadataResponseDelegate &  OnComplete, const bool  IgnoreFiles = false  )

static

Get Metadata for the specified keys on the specified sources.

Parameters

SourcesAndKeysToGet	The combination of sources to get keys for, and the keys to get for those sources
OnComplete	delegate for handling the server response
IgnoreFiles	Optional: Base64 values will be set to content_type "application/x-redacted" and the content will be an empty String. Use this to avoid accidentally fetching large data files.

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

ListMetadata() [1/2]

static FString ULootLockerServerForCpp::ListMetadata ( const ELootLockerServerMetadataSources  Source, const FString &  SourceID, const FLootLockerServerListMetadataResponseDelegate &  OnComplete, const bool  IgnoreFiles = false  )

static

List Metadata for the specified source with default pagination.

Parameters

Source	The source type for which to request metadata
SourceID	The specific source id for which to request metadata
OnComplete	delegate for handling the server response
IgnoreFiles	Optional: Base64 values will be set to content_type "application/x-redacted" and the content will be an empty String. Use this to avoid accidentally fetching large data files.

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

ListMetadata() [2/2]

static FString ULootLockerServerForCpp::ListMetadata ( const ELootLockerServerMetadataSources  Source, const FString &  SourceID, const int  Page, const int  PerPage, const FLootLockerServerListMetadataResponseDelegate &  OnComplete, const bool  IgnoreFiles = false  )

static

List the requested page of Metadata for the specified source with the specified pagination.

Parameters

Source	The source type for which to request metadata
SourceID	The specific source id for which to request metadata
Page	Used together with PerPage to apply pagination to this request. Page designates which "page" of items to fetch
PerPage	Used together with Page to apply pagination to this request.PerPage designates how many items are considered a "page"
OnComplete	delegate for handling the server response
IgnoreFiles	Optional: Base64 values will be set to content_type "application/x-redacted" and the content will be an empty String. Use this to avoid accidentally fetching large data files.

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

ListMetadataWithTags() [1/2]

static FString ULootLockerServerForCpp::ListMetadataWithTags ( const ELootLockerServerMetadataSources  Source, const FString &  SourceID, const TArray< FString > &  Tags, const FLootLockerServerListMetadataResponseDelegate &  OnComplete, const bool  IgnoreFiles = false  )

static

List Metadata for the specified source that has all of the provided tags, use default pagination.

Parameters

Source	The source type for which to request metadata
SourceID	The specific source id for which to request metadata
Tags	The tags that the requested metadata should have, only metadata matching all of the given tags will be returned
OnComplete	delegate for handling the server response
IgnoreFiles	Optional: Base64 values will be set to content_type "application/x-redacted" and the content will be an empty String. Use this to avoid accidentally fetching large data files.

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

ListMetadataWithTags() [2/2]

static FString ULootLockerServerForCpp::ListMetadataWithTags ( const ELootLockerServerMetadataSources  Source, const FString &  SourceID, const TArray< FString > &  Tags, const int  Page, const int  PerPage, const FLootLockerServerListMetadataResponseDelegate &  OnComplete, const bool  IgnoreFiles = false  )

static

List the requested page of Metadata for the specified source that has all of the provided tags and paginate according to the supplied pagination settings.

Parameters

Source	The source type for which to request metadata
SourceID	The specific source id for which to request metadata
Tags	The tags that the requested metadata should have, only metadata matching all of the given tags will be returned
Page	Used together with PerPage to apply pagination to this request. Page designates which "page" of items to fetch
PerPage	Used together with Page to apply pagination to this request.PerPage designates how many items are considered a "page"
OnComplete	delegate for handling the server response
IgnoreFiles	Optional: Base64 values will be set to content_type "application/x-redacted" and the content will be an empty String. Use this to avoid accidentally fetching large data files.

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

MakeMetadataEntryWithUStructValue()

template<typename T >

static FLootLockerServerMetadataEntry ULootLockerServerForCpp::MakeMetadataEntryWithUStructValue ( const FString &  Key, const TArray< FString > &  Tags, const TArray< FString > &  Access, const T &  Value  )

inlinestatic

SetMetadata()

static FString ULootLockerServerForCpp::SetMetadata ( const ELootLockerServerMetadataSources  Source, const FString &  SourceID, const TArray< FLootLockerServerSetMetadataAction > &  MetadataToActionsToPerform, const FLootLockerServerSetMetadataResponseDelegate &  OnComplete  )

static

Set the provided metadata for the specified source.

Note that a subset of the specified operations can fail without the full request failing. Make sure to check the errors array in the response.

Parameters

Source	The source type for which to set metadata
SourceID	The specific source id for which to set metadata
MetadataToActionsToPerform	List of actions to take during this set operation.
OnComplete	delegate for handling the server response

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

TryGetMetadataValueAsUStruct()

template<typename T >

static bool ULootLockerServerForCpp::TryGetMetadataValueAsUStruct ( const FLootLockerServerMetadataEntry &  Entry, T &  Output  )

inlinestatic

Functions
static FString	ULootLockerServerForCpp::ListMetadata (const ELootLockerServerMetadataSources Source, const FString &SourceID, const FLootLockerServerListMetadataResponseDelegate &OnComplete, const bool IgnoreFiles=false)
	List Metadata for the specified source with default pagination.
static FString	ULootLockerServerForCpp::ListMetadata (const ELootLockerServerMetadataSources Source, const FString &SourceID, const int Page, const int PerPage, const FLootLockerServerListMetadataResponseDelegate &OnComplete, const bool IgnoreFiles=false)
	List the requested page of Metadata for the specified source with the specified pagination.
static FString	ULootLockerServerForCpp::ListMetadataWithTags (const ELootLockerServerMetadataSources Source, const FString &SourceID, const TArray< FString > &Tags, const FLootLockerServerListMetadataResponseDelegate &OnComplete, const bool IgnoreFiles=false)
	List Metadata for the specified source that has all of the provided tags, use default pagination.
static FString	ULootLockerServerForCpp::ListMetadataWithTags (const ELootLockerServerMetadataSources Source, const FString &SourceID, const TArray< FString > &Tags, const int Page, const int PerPage, const FLootLockerServerListMetadataResponseDelegate &OnComplete, const bool IgnoreFiles=false)
	List the requested page of Metadata for the specified source that has all of the provided tags and paginate according to the supplied pagination settings.
static FString	ULootLockerServerForCpp::GetMetadata (const ELootLockerServerMetadataSources Source, const FString &SourceID, const FString &Key, const FLootLockerServerGetMetadataResponseDelegate &OnComplete, const bool IgnoreFiles=false)
	Get Metadata for the specified source with the given key.
static FString	ULootLockerServerForCpp::GetMultisourceMetadata (const TArray< FLootLockerServerMetadataSourceAndKeys > &SourcesAndKeysToGet, const FLootLockerServerGetMultisourceMetadataResponseDelegate &OnComplete, const bool IgnoreFiles=false)
	Get Metadata for the specified keys on the specified sources.
static FString	ULootLockerServerForCpp::SetMetadata (const ELootLockerServerMetadataSources Source, const FString &SourceID, const TArray< FLootLockerServerSetMetadataAction > &MetadataToActionsToPerform, const FLootLockerServerSetMetadataResponseDelegate &OnComplete)
	Set the provided metadata for the specified source.
template<typename T >
static bool	ULootLockerServerForCpp::TryGetMetadataValueAsUStruct (const FLootLockerServerMetadataEntry &Entry, T &Output)
template<typename T >
static FLootLockerServerMetadataEntry	ULootLockerServerForCpp::MakeMetadataEntryWithUStructValue (const FString &Key, const TArray< FString > &Tags, const TArray< FString > &Access, const T &Value)