DataStoreKeyInfo

Show Deprecated
Not Creatable
Not Replicated

An object describing information about a particular version of the key. This is returned as the second return value by GlobalDataStore:GetAsync(), GlobalDataStore:UpdateAsync(), GlobalDataStore:IncrementAsync(), GlobalDataStore:RemoveAsync(), and DataStore:GetVersionAsync().

See also:

  • Data Stores, an in-depth guide on data structure, management, error handling, etc.

Summary

Properties

  • Read Only
    Not Replicated
    Read Parallel

    The date and time the object was created.

  • Read Only
    Not Replicated
    Read Parallel

    The date and time the object was last updated.

  • Read Only
    Not Replicated
    Read Parallel

    Uniquely identifies the version of the object.

Methods

Properties

CreatedTime

Read Only
Not Replicated
Read Parallel

This property indicates the date and time the object was created, formatted as the number of milliseconds since epoch.

UpdatedTime

Read Only
Not Replicated
Read Parallel

This property indicates the date and time the object was last updated, formatted as the number of milliseconds since epoch.

Version

Read Only
Not Replicated
Read Parallel

This property uniquely identifies the version of the object. It can be passed to DataStore:GetVersionAsync() or DataStore:RemoveVersionAsync() to get or remove the version respectively.

Methods

GetMetadata

This function returns the metadata associated with the latest version of the object.


Returns

Metadata associated with the key.

GetUserIds

This function returns an array of UserIds tagged with the object.


Returns

An array of UserIds associated with the object.

Events