Interface IModelDownloadable

モデルをダウンロードする場合に実装するインターフェース

どのAPIも非同期にコールバックが呼び出される

Asyncがつくものは非同期に実行されるかつ、成功結果のTaskが返ってくる

Namespace: Pixiv.VroidSdk.Api

Assembly: Pixiv.VroidSdk.dll

Syntax

public interface IModelDownloadable

Methods

GetDownloadLicenses(String, Action<DownloadLicense>, Action<ApiErrorFormat>)

モデルをダウンロードするためのライセンス情報を取得する

Declaration

void GetDownloadLicenses(string licenseId, Action<DownloadLicense> onSuccess, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
String	licenseId	ライセンスID
Action<DownloadLicense>	onSuccess	成功した時のコールバック
Action<ApiErrorFormat>	onError	エラー発生時のコールバック

GetDownloadLicensesAsync(String)

モデルをダウンロードするためのライセンス情報を取得する

Declaration

Task<DownloadLicense> GetDownloadLicensesAsync(string licenseId)

Parameters

Type	Name	Description
String	licenseId	ライセンスID

Returns

Type	Description
Task<DownloadLicense>	モデルをダウンロードするためのライセンス情報

Exceptions

Type	Condition
ApiErrorFormat	APIエラー

GetDownloadLicensesDownload(String, Action<Byte[]>, Action<Single>, Action<ApiErrorFormat>)

ダウンロードライセンスからバイナリデータを取得する

Declaration

void GetDownloadLicensesDownload(string licenseId, Action<byte[]> onSuccess, Action<float> onProgress, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
String	licenseId	ライセンスID
Action<Byte[]>	onSuccess	成功した時のコールバック
Action<Single>	onProgress	ダウンロードの進捗コールバック
Action<ApiErrorFormat>	onError	エラー発生時のコールバック

GetDownloadLicensesDownload(String, Int32, Action<Byte[]>, Action<Single>, Action<ApiErrorFormat>)

ダウンロードライセンスに紐づくモデルのバージョンを取得(タイムアウトは300秒)

Declaration

void GetDownloadLicensesDownload(string licenseId, int timeout, Action<byte[]> onSuccess, Action<float> onProgress, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
String	licenseId	ライセンスID
Int32	timeout	リクエストタイムアウト(秒)
Action<Byte[]>	onSuccess	成功した時のコールバック
Action<Single>	onProgress	APIリクエスト中のコールバック
Action<ApiErrorFormat>	onError	失敗した時のコールバック

GetDownloadLicensesDownloadAsync(String, Action<Single>)

ダウンロードライセンスに紐づくモデルのバージョンを取得(タイムアウトは300秒)

Declaration

Task<byte[]> GetDownloadLicensesDownloadAsync(string licenseId, Action<float> onProgress)

Parameters

Type	Name	Description
String	licenseId	ライセンスID
Action<Single>	onProgress	ダウンロードの進捗コールバック

Returns

Type	Description
Task<Byte[]>	ダウンロードしたモデルのbyte配列

Exceptions

Type	Condition
ApiErrorFormat	APIエラー

GetDownloadLicensesDownloadAsync(String, Int32, Action<Single>)

ダウンロードライセンスに紐づくモデルのバージョンを取得

Declaration

Task<byte[]> GetDownloadLicensesDownloadAsync(string licenseId, int timeout, Action<float> onProgress)

Parameters

Type	Name	Description
String	licenseId	ライセンスID
Int32	timeout	タイムアウト(秒)
Action<Single>	onProgress	APIリクエスト中のコールバック

Returns

Type	Description
Task<Byte[]>	ダウンロードしたモデルのbyte配列

Exceptions

Type	Condition
ApiErrorFormat	APIエラー