ZEPETO.Multiplay.DataStorage
型 | 説明 |
|---|---|
データストレージ関連のリクエストが失敗した理由を示すエラーコード。 | |
データを保存、取得、削除するメソッドを提供するデータストレージの抽象化を表します。このインターフェースは、単一および複数のデータ操作に対する非同期処理を定義します。 |
DataStorageError
enum
データストレージ関連のリクエストが失敗した理由を示すエラーコード。
名前 | 値 | 説明 |
|---|---|---|
Unknown | -1 | エラー: 不明なエラー。 |
NetworkError | 0 | エラー: 接続の切断や不安定な接続など、ネットワークに関連するエラー。 |
KeyConstraintViolated | 103 | エラー: キーのエラー。 |
ValueConstraintViolated | 104 | エラー: 値のエラー。 |
DataStorage
interface
データを保存、取得、削除するメソッドを提供するデータストレージの抽象化を表します。 このインターフェースは、単一および複数のデータ操作に対する非同期処理を定義します。
メソッド
set
set(key: string, value: T) → Promise<boolean>
指定したキーで値を保存します。DataStorageError をスローします。
パラメーター | 型 | 説明 |
|---|---|---|
key | string | 保存に使用するキー。 |
value | T | 保存するデータ。 |
戻り値: Promise<boolean> — 処理の完了時に解決される Promise。成功時は true、失敗時は false を示します。
get
get(key: string) → Promise<T>
キーを指定して値を取得します。DataStorageError をスローします。
パラメーター | 型 | 説明 |
|---|---|---|
key | string | 検索するキー。 |
戻り値: Promise<T> — 処理の完了時に T 型の値とともに解決される Promise。
remove
remove(key: string) → Promise<boolean>
指定したキーの値を削除します。DataStorageError をスローします。
パラメーター | 型 | 説明 |
|---|---|---|
key | string | 検索するキー。 |
戻り値: Promise<boolean> — 処理の完了時に解決される Promise。成功時は true、失敗時は false を示します。
mget
mget(keys: string[]) → Promise<{ [key: string]: T }>
複数のキーを指定して値を取得します。DataStorageError をスローします。
パラメーター | 型 | 説明 |
|---|---|---|
keys | string[] | 検索するキーの配列。 |
戻り値: Promise<{ [key: string]: T }> — 処理の完了時にキーと値のオブジェクトとともに解決される Promise。
mset
mset(keyValueSet: { key: string; value: T }[]) → Promise<boolean>
指定した複数のキーで値を保存します。DataStorageError をスローします。
パラメーター | 型 | 説明 |
|---|---|---|
keyValueSet | { key: string; value: T }[] | 保存するキーと値のオブジェクトの配列。 |
戻り値: Promise<boolean> — 処理の完了時に解決される Promise。成功時は true、失敗時は false を示します。