Home > @magiclane/maps-sdk > LogMetadata > getUserMetadata

LogMetadata.getUserMetadata() method

Retrieves custom user metadata stored with the given key.

The method returns the raw byte buffer that was previously saved using addUserMetadata. If the key does not exist an asynchronous empty response is represented as null.

Signature:

getUserMetadata(key: string): Uint8Array | null;

Parameters

Parameter

Type

Description

key

string

The string key used when saving the metadata.

Returns:

Uint8Array | null

A Uint8Array with the stored data, or null if no data exists for the provided key.