API
Return to top
DataStorage
编辑

数据处理 / DataStorage

DataStorage Class
​

数据存储

Table of contents ​

Methods
​

asyncGetData(key: string): Promise<DataStorageResult> server
异步获取自定义数据
asyncGetOtherGameData(gameId: string, key: string): Promise<DataStorageResult> server
异步获取其他游戏保存的数据
asyncRemoveData(key: string): Promise<DataStorageResultCode> server
异步删除自定义数据
asyncSetData(key: string, value: any): Promise<DataStorageResultCode> server
异步设置自定义数据
asyncSetOtherGameData(gameId: string, key: string, value: any): Promise<DataStorageResultCode> server
异步设置其他游戏保存的数据
getDataSize(data: any): number
返回data的当前大小。单位为byte（字节）。
setTemporaryStorage(isTemporary: boolean): void server
设置数据存储环境是否是临时的

Methods ​

asyncGetData
​

• Static asyncGetData(key): Promise<DataStorageResult> server

异步获取自定义数据

Parameters ​

key string字符串类型键，用来查找唯一标识存储的数据
range: 字符串长度依据 asyncSetData 设置的而定。

Returns ​

Promise<DataStorageResult>之前保存的自定义数据

asyncGetOtherGameData
​

• Static asyncGetOtherGameData(gameId, key): Promise<DataStorageResult> server

异步获取其他游戏保存的数据

Parameters ​

gameId string开发者后台其他游戏的 gameId。
range: 字符串长度依据 gameId 长度而定。
key string字符串类型键，用来查找唯一标识存储的数据。
range: 字符串长度依据设置长度而定。

Returns ​

Promise<DataStorageResult>其他游戏保存的数据

asyncRemoveData
​

• Static asyncRemoveData(key): Promise<DataStorageResultCode> server

异步删除自定义数据

Parameters ​

key string字符串类型键，用来查找唯一标识存储的数据
range: 字符串长度依据 asyncSetData 设置的而定。

Returns ​

Promise<DataStorageResultCode>数据删除状态

asyncSetData
​

• Static asyncSetData(key, value): Promise<DataStorageResultCode> server

异步设置自定义数据

Parameters ​

key string字符串类型的键，用来唯一标识存储的数据。
range: 字符串长度不做限制，但请设置合适的标识。
value any要保存的数据，不支持 map 类型及数据结构中包含 map，且无法还原 function

Returns ​

Promise<DataStorageResultCode>数据储存状态

asyncSetOtherGameData
​

• Static asyncSetOtherGameData(gameId, key, value): Promise<DataStorageResultCode> server

异步设置其他游戏保存的数据

Parameters ​

gameId string开发者后台其他游戏的 gameId
range: 字符串长度依据 gameId 长度而定。
key string字符串类型键，用来查找唯一标识存储的数据
range: 字符串长度依据设置长度而定。
value any要保存的数据，不支持 map 类型及数据结构中包含 map，且无法还原 function

Returns ​

Promise<DataStorageResultCode>设置其他游戏的数据状态码

getDataSize
​

• Static getDataSize(data): number

返回data的当前大小。单位为byte（字节）。

Parameters ​

data any数据键值对对象。

Returns ​

number数据大小

setTemporaryStorage
​

• Static setTemporaryStorage(isTemporary): void server

设置数据存储环境是否是临时的

Parameters ​

isTemporary booleantrue代表临时存储，数据在游戏服务器进程中，游戏退出时数据被删除。false为永久存储，数据存储在专用服务器，游戏退出时数据不会被删除。