Class AirshipDataStoreService

The Data Store provides simple key/value persistent storage.

The data store provides durable storage that can be accessed from any game server. Data access is slower than the Cache Store, but the data will never expire.

The Data Store is good for things like user profiles or unlocks. If you want to keep track of user statistics or build tradable inventory, check out the Leaderboard and PlatformInventory systems.s

Methods

DeleteKey GetKey SetKey checkKey

Methods

DeleteKey

  • DeleteKey<T>(key): Promise<Result<undefined | T, undefined>>

  • Deletes the data associated with the given key.

    Type Parameters

    • T extends object

    Parameters

    • key: string

      The key to use. Keys must be alphanumeric and may include the following symbols: _.:

    Returns Promise<Result<undefined | T, undefined>>

    The data that was deleted. If no data was deleted, nothing will be returned.

GetKey

  • GetKey<T>(key): Promise<Result<undefined | T, undefined>>

  • Gets the data associated with the given key.

    Type Parameters

    • T extends object

    Parameters

    • key: string

      The key to use. Keys must be alphanumeric and may include the following symbols: _.:

    Returns Promise<Result<undefined | T, undefined>>

    The data associated with the provided key. If no data is found, nothing is returned.

SetKey

  • SetKey<T>(key, data): Promise<Result<T, undefined>>

  • Sets the data for the given key.

    Type Parameters

    • T extends object

    Parameters

    • key: string

      The key to use. Keys must be alphanumeric and may include the following symbols: _.:

    • data: T

      The data to associate with the provided key.

    Returns Promise<Result<T, undefined>>

    The data that was associated with the provided key.

Private checkKey

  • checkKey(key): void

  • Checks that the key is valid

    Parameters

    • key: string

    Returns void

Settings

Member Visibility

Theme

On This Page

DeleteKeyGetKeySetKeycheckKey