Class DefaultApi

スコープがdefaultのAPI

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

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

Inheritance

Object

ApiBase

DefaultApi

Implements

IDownloadLicensePublishable

IModelDownloadable

Inherited Members

ApiBase._client

ApiBase.OnSuccessCallback<T>(IHttpResponse, Action<T, ApiLinksFormat>, Action<ApiErrorFormat>)

ApiBase.OnSuccessCallback<T>(IHttpResponse, Action<T>, Action<ApiErrorFormat>)

ApiBase.ConvertApiResponse<T>(IHttpResponse)

ApiBase.OnHttpRequestFailed(Action<Account>, Action<ApiErrorFormat>)

ApiBase.ConvertErrorResponse(IHttpResponse)

ApiBase.OmitApiLinksFormat<T>(Action<T>)

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Pixiv.VroidSdk.Api

Assembly: Pixiv.VroidSdk.dll

Syntax

public sealed class DefaultApi : ApiBase, IDownloadLicensePublishable, IModelDownloadable

Constructors

DefaultApi(Client)

コンストラクタ

Declaration

public DefaultApi(Client client)

Parameters

Type	Name	Description
Client	client	APIリクエストを行うクライアント

Methods

DeleteDownloadLicenses(String, Action<EmptySerializer>, Action<ApiErrorFormat>)

ダウンロードライセンスを無効化する

Declaration

public void DeleteDownloadLicenses(string licenseId, Action<EmptySerializer> onSuccess, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
String	licenseId	無効化するライセンスID
Action<EmptySerializer>	onSuccess	成功した時のコールバック
Action<ApiErrorFormat>	onError	失敗した時のコールバック

See Also

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

PostDownloadLicensesAsync(String)

DeleteDownloadLicensesAsync(String)

ダウンロードライセンスを無効化する

Declaration

public async Task<EmptySerializer> DeleteDownloadLicensesAsync(string licenseId)

Parameters

Type	Name	Description
String	licenseId	無効化するライセンスID

Returns

Type	Description
Task<EmptySerializer>	レスポンスの空データ

Exceptions

Type	Condition
ApiErrorFormat	APIエラー

See Also

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

PostDownloadLicensesAsync(String)

GetAccount(Action<Account>, Action<ApiErrorFormat>)

VRoid Hubにログインしているユーザ情報を取得する

Declaration

public void GetAccount(Action<Account> onSuccess, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
Action<Account>	onSuccess	取得に成功した時のコールバック
Action<ApiErrorFormat>	onError	エラー発生時のコールバック

GetAccountAsync()

VRoid Hubにログインしているユーザ情報を取得する

Declaration

public async Task<Account> GetAccountAsync()

Returns

Type	Description
Task<Account>	取得したユーザー情報

Exceptions

Type	Condition
ApiErrorFormat	APIエラー

GetAccountCharacterModels(Int32, Action<List<CharacterModel>, ApiLinksFormat>, Action<ApiErrorFormat>)

ユーザが作成したキャラクターモデル一覧を取得する (関連のリンク情報付き)

Declaration

public void GetAccountCharacterModels(int count, Action<List<CharacterModel>, ApiLinksFormat> onSuccess, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
Int32	count	取得するキャラクターモデル数 (MAX 100)
Action<List<CharacterModel>, ApiLinksFormat>	onSuccess	成功した時のコールバック
Action<ApiErrorFormat>	onError	エラー発生時のコールバック

GetAccountCharacterModels(Int32, Action<List<CharacterModel>>, Action<ApiErrorFormat>)

ユーザが作成したキャラクターモデル一覧を取得する

Declaration

public void GetAccountCharacterModels(int count, Action<List<CharacterModel>> onSuccess, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
Int32	count	取得するキャラクターモデル数 (MAX 100)
Action<List<CharacterModel>>	onSuccess	成功した時のコールバック
Action<ApiErrorFormat>	onError	エラー発生時のコールバック

GetAccountCharacterModels(Int32, String, Action<List<CharacterModel>, ApiLinksFormat>, Action<ApiErrorFormat>)

ユーザが作成したキャラクターモデル一覧を取得する (関連のリンク情報付き)

Declaration

public void GetAccountCharacterModels(int count, string maxId, Action<List<CharacterModel>, ApiLinksFormat> onSuccess, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
Int32	count	取得するキャラクターモデル数 (MAX 100)
String	maxId	指定したモデルIDよりも古いモデルを返す
Action<List<CharacterModel>, ApiLinksFormat>	onSuccess	成功した時のコールバック
Action<ApiErrorFormat>	onError	エラー発生時のコールバック

GetAccountCharacterModels(Int32, String, Action<List<CharacterModel>>, Action<ApiErrorFormat>)

ユーザが作成したキャラクターモデル一覧を取得する

Declaration

public void GetAccountCharacterModels(int count, string maxId, Action<List<CharacterModel>> onSuccess, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
Int32	count	取得するキャラクターモデル数 (MAX 100)
String	maxId	指定したモデルIDよりも古いモデルを返す
Action<List<CharacterModel>>	onSuccess	成功した時のコールバック
Action<ApiErrorFormat>	onError	エラー発生時のコールバック

GetAccountCharacterModelsAsync(Int32, String)

ユーザが作成したキャラクターモデル一覧を取得する (関連のリンク情報付き)

Declaration

public async Task<List<CharacterModel>> GetAccountCharacterModelsAsync(int count, string maxId = null)

Parameters

Type	Name	Description
Int32	count	取得するキャラクターモデル数 (MAX 100)
String	maxId	指定したモデルIDよりも古いモデルを返す

Returns

Type	Description
Task<List<CharacterModel>>	取得したキャラクターモデル一覧

Exceptions

Type	Condition
ApiErrorFormat	APIエラー

GetAccountCharacterModelsAsyncWithLink(Int32, String)

ユーザが作成したキャラクターモデル一覧を取得する (関連のリンク情報付き)

Declaration

public async Task<WithLink<List<CharacterModel>>> GetAccountCharacterModelsAsyncWithLink(int count, string maxId = null)

Parameters

Type	Name	Description
Int32	count	取得するキャラクターモデル数 (MAX 100)
String	maxId	指定したモデルIDよりも古いモデルを返す

Returns

Type	Description
Task<WithLink<List<CharacterModel>>>	取得したキャラクターモデル一覧

Exceptions

Type	Condition
ApiErrorFormat	APIエラー

GetAccountCharacters(Int32, Action<List<Character>, ApiLinksFormat>, Action<ApiErrorFormat>)

ユーザが作成したキャラクター一覧を取得する (関連のリンク情報付き)

Declaration

public void GetAccountCharacters(int count, Action<List<Character>, ApiLinksFormat> onSuccess, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
Int32	count	取得するキャラクター数 (MAX 100)
Action<List<Character>, ApiLinksFormat>	onSuccess	成功した時のコールバック
Action<ApiErrorFormat>	onError	エラー発生時のコールバック

GetAccountCharacters(Int32, Action<List<Character>>, Action<ApiErrorFormat>)

ユーザが作成したキャラクター一覧を取得する

Declaration

public void GetAccountCharacters(int count, Action<List<Character>> onSuccess, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
Int32	count	取得するキャラクター数 (MAX 100)
Action<List<Character>>	onSuccess	成功した時のコールバック
Action<ApiErrorFormat>	onError	エラー発生時のコールバック

GetAccountCharacters(Int32, String, Action<List<Character>, ApiLinksFormat>, Action<ApiErrorFormat>)

ユーザが作成したキャラクター一覧を取得する (関連のリンク情報付き)

Declaration

public void GetAccountCharacters(int count, string maxId, Action<List<Character>, ApiLinksFormat> onSuccess, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
Int32	count	取得するキャラクター数 (MAX 100)
String	maxId	指定したキャラクターIDよりも古いキャラクターを返す
Action<List<Character>, ApiLinksFormat>	onSuccess	成功した時のコールバック
Action<ApiErrorFormat>	onError	エラー発生時のコールバック

GetAccountCharacters(Int32, String, Action<List<Character>>, Action<ApiErrorFormat>)

ユーザが作成したキャラクター一覧を取得する

Declaration

public void GetAccountCharacters(int count, string maxId, Action<List<Character>> onSuccess, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
Int32	count	取得するキャラクター数 (MAX 100)
String	maxId	指定したキャラクターIDよりも古いキャラクターを返す
Action<List<Character>>	onSuccess	成功した時のコールバック
Action<ApiErrorFormat>	onError	エラー発生時のコールバック

GetAccountCharactersAsync(Int32, String)

ユーザが作成したキャラクターモデル一覧を取得する

Declaration

public async Task<List<Character>> GetAccountCharactersAsync(int count, string maxId = null)

Parameters

Type	Name	Description
Int32	count	取得するキャラクターモデル数 (MAX 100)
String	maxId	指定したモデルIDよりも古いモデルを返す

Returns

Type	Description
Task<List<Character>>	取得したキャラクターモデル一覧

Exceptions

Type	Condition
ApiErrorFormat	APIエラー

GetAccountCharactersAsyncWithLink(Int32, String)

ユーザが作成したキャラクター一覧を取得する (関連のリンク情報付き)

Declaration

public async Task<WithLink<List<Character>>> GetAccountCharactersAsyncWithLink(int count, string maxId = null)

Parameters

Type	Name	Description
Int32	count	取得するキャラクター数 (MAX 100)
String	maxId	指定したキャラクターIDよりも古いキャラクターを返す

Returns

Type	Description
Task<WithLink<List<Character>>>	取得したモデル

Exceptions

Type	Condition
ApiErrorFormat	APIエラー

GetArtworks(String, Action<ArtworkDetail>, Action<ApiErrorFormat>)

ユーザのアートワーク詳細を取得する (関連のリンク情報付き)

Declaration

public void GetArtworks(string artworkId, Action<ArtworkDetail> onSuccess, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
String	artworkId	取得対象のアートワークID
Action<ArtworkDetail>	onSuccess	成功した時のコールバック
Action<ApiErrorFormat>	onError	失敗した時のコールバック

GetArtworksAsync(String)

ユーザのアートワーク詳細を取得する (関連のリンク情報付き)

Declaration

public async Task<ArtworkDetail> GetArtworksAsync(string artworkId)

Parameters

Type	Name	Description
String	artworkId	取得対象のアートワークID

Returns

Type	Description
Task<ArtworkDetail>	取得したアートワーク詳細

Exceptions

Type	Condition
ApiErrorFormat	APIエラー

GetCharacterModels(String, Action<CharacterModelDetail>, Action<ApiErrorFormat>)

キャラクターに紐づくモデル詳細を取得する

Declaration

public void GetCharacterModels(string characterModelId, Action<CharacterModelDetail> onSuccess, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
String	characterModelId	取得するキャラクターモデルID
Action<CharacterModelDetail>	onSuccess	成功した時のコールバック
Action<ApiErrorFormat>	onError	エラー発生時のコールバック

GetCharacterModelsAsync(String)

キャラクターに紐づくモデル詳細を取得する

Declaration

public async Task<CharacterModelDetail> GetCharacterModelsAsync(string characterModelId)

Parameters

Type	Name	Description
String	characterModelId	取得するキャラクターモデルID

Returns

Type	Description
Task<CharacterModelDetail>	取得したモデル詳細一覧

Exceptions

Type	Condition
ApiErrorFormat	APIエラー

GetCharacterModelsProperty(String, Action<CharacterModelProperty>, Action<ApiErrorFormat>)

キャラクターモデルのプロパティ情報を取得する

Declaration

public void GetCharacterModelsProperty(string characterModelId, Action<CharacterModelProperty> onSuccess, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
String	characterModelId	取得したいキャラクターモデルのID
Action<CharacterModelProperty>	onSuccess	成功した時のコールバック
Action<ApiErrorFormat>	onError	失敗した時のコールバック

GetCharacterModelsPropertyAsync(String)

キャラクターモデルのプロパティ情報を取得する

Declaration

public async Task<CharacterModelProperty> GetCharacterModelsPropertyAsync(string characterModelId)

Parameters

Type	Name	Description
String	characterModelId	取得したいキャラクターモデルのID

Returns

Type	Description
Task<CharacterModelProperty>	キャラクターモデルのプロパティ

Exceptions

Type	Condition
ApiErrorFormat	APIエラー

GetCharacters(String, Action<CharacterDetail>, Action<ApiErrorFormat>)

キャラクターを取得する

Declaration

public void GetCharacters(string characterId, Action<CharacterDetail> onSuccess, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
String	characterId	取得するキャラクターID
Action<CharacterDetail>	onSuccess	成功した時のコールバック
Action<ApiErrorFormat>	onError	エラー発生時のコールバック

GetCharactersAsync(String)

キャラクターを取得する

Declaration

public async Task<CharacterDetail> GetCharactersAsync(string characterId)

Parameters

Type	Name	Description
String	characterId	取得するキャラクターID

Returns

Type	Description
Task<CharacterDetail>	キャラクター

Exceptions

Type	Condition
ApiErrorFormat	APIエラー

GetCharactersModels(String, Int32, Action<List<CharacterModel>, ApiLinksFormat>, Action<ApiErrorFormat>)

キャラクターに紐づくモデル一覧を取得する (関連のリンク情報付き)

Declaration

public void GetCharactersModels(string characterId, int count, Action<List<CharacterModel>, ApiLinksFormat> onSuccess, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
String	characterId	取得するキャラクターID
Int32	count	取得するキャラクター数 (MAX 100)
Action<List<CharacterModel>, ApiLinksFormat>	onSuccess	成功した時のコールバック
Action<ApiErrorFormat>	onError	エラー発生時のコールバック

GetCharactersModels(String, Int32, Action<List<CharacterModel>>, Action<ApiErrorFormat>)

キャラクターに紐づくモデル一覧を取得する

Declaration

public void GetCharactersModels(string characterId, int count, Action<List<CharacterModel>> onSuccess, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
String	characterId	取得するキャラクターID
Int32	count	取得するモデル数 (MAX 100)
Action<List<CharacterModel>>	onSuccess	成功した時のコールバック
Action<ApiErrorFormat>	onError	エラー発生時のコールバック

GetCharactersModels(String, Int32, String, Action<List<CharacterModel>, ApiLinksFormat>, Action<ApiErrorFormat>)

キャラクターに紐づくモデル一覧を取得する

Declaration

public void GetCharactersModels(string characterId, int count, string maxId, Action<List<CharacterModel>, ApiLinksFormat> onSuccess, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
String	characterId	取得するキャラクターID
Int32	count	取得するキャラクター数 (MAX 100)
String	maxId	指定したキャラクターIDよりも古いキャラクターを返す
Action<List<CharacterModel>, ApiLinksFormat>	onSuccess	成功した時のコールバック
Action<ApiErrorFormat>	onError	エラー発生時のコールバック

GetCharactersModels(String, Int32, String, Action<List<CharacterModel>>, Action<ApiErrorFormat>)

キャラクターに紐づくモデル一覧を取得する

Declaration

public void GetCharactersModels(string characterId, int count, string maxId, Action<List<CharacterModel>> onSuccess, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
String	characterId	取得するキャラクターID
Int32	count	取得するキャラクター数 (MAX 100)
String	maxId	指定したキャラクターIDよりも古いキャラクターを返す
Action<List<CharacterModel>>	onSuccess	成功した時のコールバック
Action<ApiErrorFormat>	onError	エラー発生時のコールバック

GetCharactersModelsAsync(String, Int32, String)

キャラクターに紐づくモデル一覧を取得する

Declaration

public async Task<List<CharacterModel>> GetCharactersModelsAsync(string characterId, int count, string maxId = null)

Parameters

Type	Name	Description
String	characterId	取得するキャラクターID
Int32	count	取得するキャラクター数 (MAX 100)
String	maxId	指定したキャラクターIDよりも古いキャラクターを返す

Returns

Type	Description
Task<List<CharacterModel>>	モデル一覧

Exceptions

Type	Condition
ApiErrorFormat	APIエラー

GetCharactersModelsAsyncWithLink(String, Int32, String)

キャラクターに紐づくモデル一覧を取得する (関連のリンク情報付き)

Declaration

public async Task<WithLink<List<CharacterModel>>> GetCharactersModelsAsyncWithLink(string characterId, int count, string maxId = null)

Parameters

Type	Name	Description
String	characterId	取得するキャラクターID
Int32	count	取得するキャラクター数 (MAX 100)
String	maxId	指定したキャラクターIDよりも古いキャラクターを返す

Returns

Type	Description
Task<WithLink<List<CharacterModel>>>	モデル一覧

Exceptions

Type	Condition
ApiErrorFormat	APIエラー

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

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

Declaration

public 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

public async 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

public 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>)

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

Declaration

public 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

public 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>)

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

Declaration

public async 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エラー

GetHearts(Int32, Action<List<CharacterModel>, ApiLinksFormat>, Action<ApiErrorFormat>)

ハートしたモデル一覧を取得する (関連のリンク情報付き)

Declaration

public void GetHearts(int count, Action<List<CharacterModel>, ApiLinksFormat> onSuccess, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
Int32	count	取得するキャラクターモデル数 (MAX 100)
Action<List<CharacterModel>, ApiLinksFormat>	onSuccess	成功した時のコールバック
Action<ApiErrorFormat>	onError	失敗した時のコールバック

GetHearts(Int32, Action<List<CharacterModel>>, Action<ApiErrorFormat>)

ハートしたモデル一覧を取得する

Declaration

public void GetHearts(int count, Action<List<CharacterModel>> onSuccess, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
Int32	count	取得するキャラクターモデル数 (MAX 100)
Action<List<CharacterModel>>	onSuccess	成功した時のコールバック
Action<ApiErrorFormat>	onError	失敗した時のコールバック

GetHearts(Int32, String, Action<List<CharacterModel>, ApiLinksFormat>, Action<ApiErrorFormat>)

ハートしたモデル一覧を取得する (関連のリンク情報付き)

Declaration

public void GetHearts(int count, string maxId, Action<List<CharacterModel>, ApiLinksFormat> onSuccess, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
Int32	count	取得するキャラクターモデル数 (MAX 100)
String	maxId	ページング処理のための上限となるモデルID
Action<List<CharacterModel>, ApiLinksFormat>	onSuccess	成功した時のコールバック
Action<ApiErrorFormat>	onError	失敗した時のコールバック

GetHearts(Int32, String, Action<List<CharacterModel>>, Action<ApiErrorFormat>)

ハートしたモデル一覧を取得する

Declaration

public void GetHearts(int count, string maxId, Action<List<CharacterModel>> onSuccess, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
Int32	count	取得するキャラクターモデル数 (MAX 100)
String	maxId	ページング処理のための上限となるモデルID
Action<List<CharacterModel>>	onSuccess	成功した時のコールバック
Action<ApiErrorFormat>	onError	失敗した時のコールバック

GetHeartsAsync(Int32, String)

ハートしたモデル一覧を取得する

Declaration

public async Task<List<CharacterModel>> GetHeartsAsync(int count, string maxId = null)

Parameters

Type	Name	Description
Int32	count	取得するキャラクターモデル数 (MAX 100)
String	maxId	ページング処理のための上限となるモデルID

Returns

Type	Description
Task<List<CharacterModel>>	ハートしたモデルのリスト

Exceptions

Type	Condition
ApiErrorFormat	APIエラー

GetHeartsAsyncWithLink(Int32, String)

ハートしたモデル一覧を取得する (関連のリンク情報付き)

Declaration

public async Task<WithLink<List<CharacterModel>>> GetHeartsAsyncWithLink(int count, string maxId = null)

Parameters

Type	Name	Description
Int32	count	取得するキャラクターモデル数 (MAX 100)
String	maxId	ページング処理のための上限となるモデルID

Returns

Type	Description
Task<WithLink<List<CharacterModel>>>	ハートしたモデルのリスト

Exceptions

Type	Condition
ApiErrorFormat	APIエラー

GetStaffPicks(Int32, Action<List<StaffPicksCharacterModel>, ApiLinksFormat>, Action<ApiErrorFormat>)

VRoidHubのピックアップモデル一覧を取得する (関連のリンク情報付き)

Declaration

public void GetStaffPicks(int count, Action<List<StaffPicksCharacterModel>, ApiLinksFormat> onSuccess, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
Int32	count	取得するキャラクターモデル数 (MAX 100)
Action<List<StaffPicksCharacterModel>, ApiLinksFormat>	onSuccess	成功した時のコールバック
Action<ApiErrorFormat>	onError	失敗した時のコールバック

GetStaffPicks(Int32, Action<List<StaffPicksCharacterModel>>, Action<ApiErrorFormat>)

VRoidHubのピックアップモデル一覧を取得する

Declaration

public void GetStaffPicks(int count, Action<List<StaffPicksCharacterModel>> onSuccess, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
Int32	count	取得するキャラクターモデル数 (MAX 100)
Action<List<StaffPicksCharacterModel>>	onSuccess	成功した時のコールバック
Action<ApiErrorFormat>	onError	失敗した時のコールバック

GetStaffPicksAsync(Int32)

VRoidHubのピックアップモデル一覧を取得する

Declaration

public async Task<List<StaffPicksCharacterModel>> GetStaffPicksAsync(int count)

Parameters

Type	Name	Description
Int32	count	取得するキャラクターモデル数 (MAX 100)

Returns

Type	Description
Task<List<StaffPicksCharacterModel>>	ピックアップモデル一覧

Exceptions

Type	Condition
ApiErrorFormat	APIエラー

GetStaffPicksAsyncWithLink(Int32)

VRoidHubのピックアップモデル一覧を取得する (関連のリンク情報付き)

Declaration

public async Task<WithLink<List<StaffPicksCharacterModel>>> GetStaffPicksAsyncWithLink(int count)

Parameters

Type	Name	Description
Int32	count	取得するキャラクターモデル数 (MAX 100)

Returns

Type	Description
Task<WithLink<List<StaffPicksCharacterModel>>>	ピックアップモデル一覧

Exceptions

Type	Condition
ApiErrorFormat	APIエラー

GetUsersArtworks(User, Int32, Action<List<Artwork>, ApiLinksFormat>, Action<ApiErrorFormat>)

ユーザのアートワーク一覧を取得する (関連のリンク情報付き)

Declaration

public void GetUsersArtworks(User user, int count, Action<List<Artwork>, ApiLinksFormat> onSuccess, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
User	user	取得対象のユーザ
Int32	count	取得するアートワークの数
Action<List<Artwork>, ApiLinksFormat>	onSuccess	成功した時のコールバック
Action<ApiErrorFormat>	onError	失敗した時のコールバック

GetUsersArtworks(User, Int32, Action<List<Artwork>>, Action<ApiErrorFormat>)

ユーザのアートワーク一覧を取得する

Declaration

public void GetUsersArtworks(User user, int count, Action<List<Artwork>> onSuccess, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
User	user	取得対象のユーザ
Int32	count	取得するアートワークの数
Action<List<Artwork>>	onSuccess	成功した時のコールバック
Action<ApiErrorFormat>	onError	失敗した時のコールバック

GetUsersArtworks(User, Int32, String, Action<List<Artwork>, ApiLinksFormat>, Action<ApiErrorFormat>)

ユーザのアートワーク一覧を取得する (関連のリンク情報付き)

Declaration

public void GetUsersArtworks(User user, int count, string maxId, Action<List<Artwork>, ApiLinksFormat> onSuccess, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
User	user	取得対象のユーザ
Int32	count	取得するアートワークの数
String	maxId	ページング処理のための上限となるアートワークID
Action<List<Artwork>, ApiLinksFormat>	onSuccess	成功した時のコールバック
Action<ApiErrorFormat>	onError	失敗した時のコールバック

GetUsersArtworksAsync(User, Int32, String)

ユーザのアートワーク一覧を取得する

Declaration

public async Task<List<Artwork>> GetUsersArtworksAsync(User user, int count, string maxId = null)

Parameters

Type	Name	Description
User	user	取得対象のユーザ
Int32	count	取得するアートワークの数
String	maxId	ページング処理のための上限となるアートワークID

Returns

Type	Description
Task<List<Artwork>>	取得したアートワークのリスト

Exceptions

Type	Condition
ApiErrorFormat	APIエラー

GetUsersArtworksAsyncWithLink(User, Int32, String)

ユーザのアートワーク一覧を取得する (関連のリンク情報付き)

Declaration

public async Task<WithLink<List<Artwork>>> GetUsersArtworksAsyncWithLink(User user, int count, string maxId = null)

Parameters

Type	Name	Description
User	user	取得対象のユーザ
Int32	count	取得するアートワークの数
String	maxId	ページング処理のための上限となるアートワークID

Returns

Type	Description
Task<WithLink<List<Artwork>>>	取得したアートワークのリスト

Exceptions

Type	Condition
ApiErrorFormat	APIエラー

PostArtworkMediaImages(PostArtworkMediaImagesParams, Action<ArtworkMedium>, Action<Single>, Action<ApiErrorFormat>)

新しいアートワーク画像をアップロードする

Declaration

public void PostArtworkMediaImages(PostArtworkMediaImagesParams requestParams, Action<ArtworkMedium> onSuccess, Action<float> onProgress, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
PostArtworkMediaImagesParams	requestParams	送信するパラメータ
Action<ArtworkMedium>	onSuccess	成功した時のコールバック
Action<Single>	onProgress	アップロード中に呼ばれるコールバック
Action<ApiErrorFormat>	onError	エラー発生時のコールバック

PostArtworkMediaImagesAsync(PostArtworkMediaImagesParams, Action<Single>)

新しいアートワーク画像をアップロードする

Declaration

public async Task<ArtworkMedium> PostArtworkMediaImagesAsync(PostArtworkMediaImagesParams requestParams, Action<float> onProgress)

Parameters

Type	Name	Description
PostArtworkMediaImagesParams	requestParams	送信するパラメータ
Action<Single>	onProgress	アップロード中に呼ばれるコールバック

Returns

Type	Description
Task<ArtworkMedium>	アップロードしたアートワーク画像

Exceptions

Type	Condition
ApiErrorFormat	APIエラー

PostArtworks(PostArtworksParams, Action<ArtworkDetail>, Action<ApiErrorFormat>)

アートワークを投稿する

Declaration

public void PostArtworks(PostArtworksParams requestParams, Action<ArtworkDetail> onSuccess, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
PostArtworksParams	requestParams	送信するパラメータ
Action<ArtworkDetail>	onSuccess	成功した時のコールバック
Action<ApiErrorFormat>	onError	エラー発生時のコールバック

PostArtworksAsync(PostArtworksParams)

アートワークを投稿する

Declaration

public async Task<ArtworkDetail> PostArtworksAsync(PostArtworksParams requestParams)

Parameters

Type	Name	Description
PostArtworksParams	requestParams	送信するパラメータ

Returns

Type	Description
Task<ArtworkDetail>	アップロードしたアートワーク画像

Exceptions

Type	Condition
ApiErrorFormat	APIエラー

PostCharacterModelsBatch(String[], Action<List<CharacterModel>>, Action<ApiErrorFormat>)

キャラクターに紐づくモデルを一括で取得する

Declaration

public void PostCharacterModelsBatch(string[] characterModelIds, Action<List<CharacterModel>> onSuccess, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
String[]	characterModelIds	情報を取得するCharacterModelのID一覧
Action<List<CharacterModel>>	onSuccess	成功したときのコールバック
Action<ApiErrorFormat>	onError	エラー発生時のコールバック

PostCharacterModelsBatchAsync(String[])

複数のキャラクターモデル詳細を取得する

Declaration

public async Task<List<CharacterModel>> PostCharacterModelsBatchAsync(string[] characterModelIds)

Parameters

Type	Name	Description
String[]	characterModelIds	取得するキャラクターモデルID

Returns

Type	Description
Task<List<CharacterModel>>	キャラクターモデル詳細一覧

Exceptions

Type	Condition
ApiErrorFormat	APIエラー

PostCharacterModelsPropertiesBatch(List<String>, Action<List<CharacterModelProperty>>, Action<ApiErrorFormat>)

複数のキャラクターモデルのプロパティ情報を一括取得する

Declaration

public void PostCharacterModelsPropertiesBatch(List<string> characterModelIds, Action<List<CharacterModelProperty>> onSuccess, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
List<String>	characterModelIds	取得したいキャラクターモデルのIDリスト
Action<List<CharacterModelProperty>>	onSuccess	成功した時のコールバック
Action<ApiErrorFormat>	onError	失敗した時のコールバック

PostCharacterModelsPropertiesBatchAsync(List<String>)

複数のキャラクターモデルのプロパティ情報を一括取得する

Declaration

public async Task<List<CharacterModelProperty>> PostCharacterModelsPropertiesBatchAsync(List<string> characterModelIds)

Parameters

Type	Name	Description
List<String>	characterModelIds	取得したいキャラクターモデルのIDリスト

Returns

Type	Description
Task<List<CharacterModelProperty>>	キャラクターモデルのプロパティ情報のリスト

Exceptions

Type	Condition
ApiErrorFormat	APIエラー

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

ダウンロードライセンスを発行する

Declaration

public void PostDownloadLicenses(string characterModelId, Action<DownloadLicense> onSuccess, Action<ApiErrorFormat> onError)

Parameters

Type	Name	Description
String	characterModelId	キャラクターモデルID
Action<DownloadLicense>	onSuccess	成功した時のコールバック
Action<ApiErrorFormat>	onError	失敗した時のコールバック

PostDownloadLicensesAsync(String)

ダウンロードライセンスを発行する

Declaration

public async Task<DownloadLicense> PostDownloadLicensesAsync(string characterModelId)

Parameters

Type	Name	Description
String	characterModelId	キャラクターモデルID

Returns

Type	Description
Task<DownloadLicense>	ダウンロードライセンス

Exceptions

Type	Condition
ApiErrorFormat	APIエラー

Implements

IDownloadLicensePublishable

IModelDownloadable