stingray.XboxConnectedStorage 네임스페이스 참조

설명

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입니다.

반환하는 항목

이 함수는 아무 값도 반환하지 않습니다.

각 작업 호출마다 정확히 한 번씩 이 함수를 호출해야 합니다(호출이 성공적으로 완료되었는지 여부에 관계없음).

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?	검색할 컨테이너의 접두사(선택 사항)입니다. 접두사가 지정되어 있지 않으면 모든 컨테이너를 반환합니다. ? 표기는 이 유형이 선택 사항임을 나타냅니다. 해당 인스턴스가 0개 또는 한 개일 수 있습니다.

반환하는 항목

integer

작업의 진행 상황을 추적하는 데 사용할 수 있는 ID입니다.

접두사가 지정되어 있지 않으면 모든 컨테이너에 관한 정보를 반환합니다.

query_result ( query_id ) : table query()가 성공적으로 완료된 후에 이 함수를 호출하여 쿼리 작업의 결과를 가져옵니다.

매개변수

query_id :

integer

읽기 작업의 ID입니다(query()에 의해 반환).

반환하는 항목

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

읽기 작업의 ID입니다(read()에 의해 반환).

반환하는 항목

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 작업이 시작되지 않았거나 완료되었기 때문에 작업을 시스템에서 알 수 없는 상태입니다.