DataStoreKeyInfo
An object specifying information about a particular version of the key.
Memory category | Instances |
---|
Member index 5
Removed member index 1
History | Member | |
---|---|---|
489 | KeyName: string |
Description
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.
History 16
- 553 Change Default of Version from to
- 553 Change Default of UpdatedTime from to
- 553 Change Default of CreatedTime from to
- 489 Add GetUserIds
- 489 Add GetMetadata
- 489 Add Version
- 489 Add UpdatedTime
- 489 Remove KeyName
- 489 Add CreatedTime
- 486 Change ThreadSafety of KeyName from ReadOnly to ReadSafe
- 462 Change ThreadSafety of KeyName from to ReadOnly
- 461 Add KeyName
- 461 Add DataStoreKeyInfo
- 452 Remove DataStoreKeyInfo
- 453 Add KeyName
- 453 Add DataStoreKeyInfo
Members 5
CreatedTime
Type | Default | |
---|---|---|
int64 |
This property indicates the date and time the object was created, formatted as the number of milliseconds since epoch.
Thread safety | ReadSafe |
---|---|
Category | Data |
Loaded/Saved | false/true |
History 2
- 553 Change Default of CreatedTime from to
- 489 Add CreatedTime
GetMetadata
Parameters (0) | ||
---|---|---|
No parameters. | ||
Returns (1) | ||
Dictionary |
This function returns the metadata associated with the latest version of the object.
Thread safety | Unsafe |
---|
History 1
- 489 Add GetMetadata
GetUserIds
Parameters (0) | ||
---|---|---|
No parameters. | ||
Returns (1) | ||
Array |
This function returns an array of UserIds tagged with the object.
Thread safety | Unsafe |
---|
History 1
- 489 Add GetUserIds
UpdatedTime
Type | Default | |
---|---|---|
int64 |
This property indicates the date and time the object was last updated, formatted as the number of milliseconds since epoch.
Thread safety | ReadSafe |
---|---|
Category | Data |
Loaded/Saved | false/true |
History 2
- 553 Change Default of UpdatedTime from to
- 489 Add UpdatedTime
Version
Type | Default | |
---|---|---|
string |
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.
Thread safety | ReadSafe |
---|---|
Category | Data |
Loaded/Saved | false/true |
Removed members 1
KeyName
Type | Default | |
---|---|---|
string |
Thread safety | ReadSafe |
---|---|
Category | Data |
Loaded/Saved | false/true |