XboxConnectedStorage - stingray.XboxConnectedStorage ネームスペース リファレンス - Stingray Lua API リファレンス
説明
Xbox One の ConnectedStorage (データの保存)システムと通信するために使用されます。
関数
 |
delete ( storage_id, container ) : integer 指定されたコンテナをストレージ領域から削除します。
|
storage_id : | integer | 削除元のストレージ領域の ID です。 |
container : | string | 削除するストレージ領域内のコンテナです。 |
integer |
status() を使用して、操作のステータスを追跡するために使用できる ID です。 |
これは status() を使用して進行状況を追跡する非同期操作です。タスクが完了したら、finish() を呼び出す必要があります。
| |
finish ( read_id )すべてのリソースを操作から解放します。
|
read_id : | integer | 完了した操作の ID です。 |
| この関数は値を返しません。 |
これは操作の呼び出しごとに(呼び出しが正常に完了したかどうかに関係なく) 1 回だけ呼び出す必要があります。
| |
get_storage_space ( user_id ) : integer指定したユーザに対してストレージ領域を取得します。
|
user_id : | integer | ストレージ領域がクエリーの対象となっているユーザです。 |
integer |
ストレージ領域を識別する ID です。 |
これは非同期操作です。status() を使用してそのステータスを確認できます。操作が完了したら、ストレージ領域を使用できます。ストレージ領域の使用が完了したら、finish() を呼び出して、すべてのリソースとストレージ領域を解放する必要があります。
| |
query ( storage_id, container_prefix ) : integer指定されたプリフィックスを持つすべてのコンテナに関する情報を要求します。
|
storage_id : | integer | 読み込み元のストレージ領域の ID です。 |
container_prefix : | string? | 検索するコンテナのオプションのプリフィックスです。指定しない場合は、すべてのコンテナが返されます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
integer |
操作の進行状況を追跡するために使用できる ID です。 |
プリフィックスが指定されていない場合は、すべてのコンテナに関する情報が返されます。
| |
query_result ( query_id ) : tableこれは、query() が正常に完了した後に、クエリー操作の結果を取得するために呼び出します。
|
query_id : | integer | (query() によって返される)読み込み操作の ID です。 |
table |
クエリー操作の結果を含むテーブルです。返されたテーブルには、各コンテナのデータとフィールド "display_name"、"name"、"needs_sync"、"total_size" を含むテーブルがあります。 |
データは finish() を呼び出すまで使用できます。
| |
read ( storage_id, container, reads ) : integerストレージ コンテナからデータを読み込みます。
|
storage_id : | integer | 読み込み元のストレージ領域の ID です。 |
container : | string | 読み込み元のコンテナの名前です。 |
reads : | table | コンテナから読み込む必要のあるキーが含まれた文字列のテーブルです。 |
integer |
操作の進行状況を追跡するために使用できる ID です。 |
この関数を呼び出す前に、storage_id に対して get_storage_space() が完了している必要があります。
これは非同期操作です。status() を使用して、操作の進行状況を追跡します。完了したら、finish() を呼び出して操作を完了する必要があります。
| |
read_result ( read_id ) : tableこれは、read() が正常に完了した後に、読み込み操作の結果を取得するために呼び出します。
|
read_id : | integer | (read() によって返される)読み込み操作の ID です。 |
table |
読み込み操作の結果を含むテーブルです。 |
データは finish() を呼び出すまで使用できます。
| |
status ( id ) : integer操作の現在のステータスを返します。
|
id : | integer | 非同期操作の ID です。 |
integer |
操作のステータス(UNKNOWN、STARTED、COMPLETED、CANCELED、ERROR)です。 |
| |
submit ( storage_id, container, display_name, writes, deletes ) : integerストレージ領域内のコンテナにデータを書き込みます。
|
storage_id : | integer | データの書き込み先のストレージ領域の ID です。 |
container : | string | 書き込み先のストレージ領域内のコンテナです。 |
display_name : | string | コンテナに表示される表示名です。 |
writes : | table | コンテナに書き込むキー(文字列)と値(文字列)が含まれたテーブルです。データを削除するだけの場合は、これを nil にすることができます。 |
deletes : | table | コンテナから削除するキーの名前を含むテーブルです。データを書き込むだけの場合は、これを nil にすることができます。 |
integer |
status() を使用して、操作のステータスを追跡するために使用できる ID です。 |
値の数値は、指定されたキーの下に書き込まれます。キーはこの関数を使用しても削除することができます。この関数は、ストレージ領域に対して get_storage_space() が正常に完了している場合にのみ呼び出すことができます。
これは status() を使用して進行状況を追跡する非同期操作です。タスクが完了したら、finish() を呼び出す必要があります。
このグループ内の定数は、のは、非同期操作のステータスとして返すことができます。
 |
CANCELED : integer ユーザにより操作がキャンセルされました。
|
| |
COMPLETED : integer操作が正常に完了しました。
|
| |
ERROR : integer操作の実行中にエラーが発生しました。
|
| |
STARTED : integer操作は進行中です。
|
開始されていますが、まだ完了していません。
| |
UNKNOWN : integerこの操作は、開始されていないか、完了しているかのいずれかの理由により、システムにとって不明な操作です。
|