Attach and retrieve typed key-value metadata on any LootLocker entity.
Metadata can be attached to Progressions, Leaderboards, Catalogs, Currencies, Assets, and more. Values are strongly typed: String, Boolean, Number, JSON, or Base64-encoded binary. Entries support optional Tags for filtering (e.g., seasonal, featured) and a Game Read flag that restricts visibility to the Server API only — useful for keeping sensitive data out of the game client.
See the LootLocker documentation.
◆ GetMetadata()
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, note that if the source is self then this too should be set to "self" |
| 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. |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
◆ GetMultisourceMetadata()
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
-
| 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. |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
◆ ListMetadata() [1/2]
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 | 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. |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
◆ ListMetadata() [2/2]
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 | 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. |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
◆ ListMetadataWithTags() [1/2]
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 | 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. |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
◆ ListMetadataWithTags() [2/2]
| static void LootLocker.Requests.LootLockerSDKManager.ListMetadataWithTags |
( |
LootLockerMetadataSources |
Source, |
|
|
string |
SourceID, |
|
|
string[] |
Tags, |
|
|
int |
Page, |
|
|
int |
PerPage, |
|
|
Action< LootLockerListMetadataResponse > |
onComplete, |
|
|
bool |
IgnoreFiles = false, |
|
|
string |
forPlayerWithUlid = null |
|
) |
| |
|
inlinestatic |
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 | 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. |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
◆ PerformMetadataOperations()
Perform the specified metadata operations 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 that the source id refers to |
| SourceID | The specific source id for which to set metadata, note that if the source is self then this too should be set to "self" |
| OperationsToPerform | List of operations to perform for the given source |
| onComplete | Delegate for handling the server response |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
|
| static void | LootLocker.Requests.LootLockerSDKManager.ListMetadata (LootLockerMetadataSources Source, string SourceID, Action< LootLockerListMetadataResponse > onComplete, bool IgnoreFiles=false, string forPlayerWithUlid=null) |
| | List Metadata for the specified source with default pagination.
|
| |
| static void | LootLocker.Requests.LootLockerSDKManager.ListMetadata (LootLockerMetadataSources Source, string SourceID, int Page, int PerPage, Action< LootLockerListMetadataResponse > onComplete, bool IgnoreFiles=false, string forPlayerWithUlid=null) |
| | List the requested page of Metadata for the specified source with the specified pagination.
|
| |
| static void | LootLocker.Requests.LootLockerSDKManager.ListMetadataWithTags (LootLockerMetadataSources Source, string SourceID, string[] Tags, Action< LootLockerListMetadataResponse > onComplete, bool IgnoreFiles=false, string forPlayerWithUlid=null) |
| | List Metadata for the specified source that has all of the provided tags, use default pagination.
|
| |
| static void | LootLocker.Requests.LootLockerSDKManager.ListMetadataWithTags (LootLockerMetadataSources Source, string SourceID, string[] Tags, int Page, int PerPage, Action< LootLockerListMetadataResponse > onComplete, bool IgnoreFiles=false, string forPlayerWithUlid=null) |
| | 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 void | LootLocker.Requests.LootLockerSDKManager.GetMetadata (LootLockerMetadataSources Source, string SourceID, string Key, Action< LootLockerGetMetadataResponse > onComplete, bool IgnoreFiles=false, string forPlayerWithUlid=null) |
| | Get Metadata for the specified source with the given key.
|
| |
| static void | LootLocker.Requests.LootLockerSDKManager.GetMultisourceMetadata (LootLockerMetadataSourceAndKeys[] SourcesAndKeysToGet, Action< LootLockerGetMultisourceMetadataResponse > onComplete, bool IgnoreFiles=false, string forPlayerWithUlid=null) |
| | 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 void | LootLocker.Requests.LootLockerSDKManager.PerformMetadataOperations (LootLockerMetadataSources Source, string SourceID, List< LootLockerMetadataOperation > OperationsToPerform, Action< LootLockerMetadataOperationsResponse > onComplete, string forPlayerWithUlid=null) |
| | Perform the specified metadata operations for the specified source Note that a subset of the specified operations can fail without the full request failing.
|
| |
