Class HubApi

VRoid HubへAPIリクエストを送信する

Inheritance
Object
HubApi
Inherited Members
Namespace: Pixiv.VroidSdk.Api.Legacy
Assembly: VRoidSDK.dll
Syntax
[Obsolete("HubApi is deprecated. Please use DefaultApi or HeartApi")]
public class HubApi
Remarks

APIとして使えるものは、SDKConfigurationとアプリケーション管理画面で作成したアプリケーションのスコープ設定により制限される

どのスコープでAPIが実行できるかは、各メソッドのRemarksを参照してください

Methods

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

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

Declaration
public static void DeleteDownloadLicense(string licenseId, Action<EmptySerializer> onSuccess, Action<ApiErrorFormat> onError)
Parameters
Type Name Description
String licenseId

無効化するライセンスID
Action<EmptySerializer> onSuccess

成功した時のコールバック
Action<ApiErrorFormat> onError

失敗した時のコールバック
Remarks

使用可能スコープ: default

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

キャラクターモデルについているハートを取り消す

Declaration
public static void DeleteHeart(string characterModelId, Action<EmptySerializer> onSuccess, Action<ApiErrorFormat> onError)
Parameters
Type Name Description
String characterModelId

ハートを消したいキャラクターモデルID
Action<EmptySerializer> onSuccess

成功したときのコールバック
Action<ApiErrorFormat> onError

失敗したときのコールバック
Remarks

使用可能スコープ: heart

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

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

Declaration
public static void GetAccount(Action<Account> onSuccess, Action<ApiErrorFormat> onError)
Parameters
Type Name Description
Action<Account> onSuccess

取得に成功した時のコールバック
Action<ApiErrorFormat> onError

エラー発生時のコールバック
Remarks

使用可能スコープ: default

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

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

Declaration
public static 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

エラー発生時のコールバック
Remarks

使用可能スコープ: default

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

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

Declaration
public static 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

エラー発生時のコールバック
Remarks

使用可能スコープ: default

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

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

Declaration
public static 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

エラー発生時のコールバック
Remarks

使用可能スコープ: default

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

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

Declaration
public static 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

エラー発生時のコールバック
Remarks

使用可能スコープ: default

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

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

Declaration
public static 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

エラー発生時のコールバック
Remarks

使用可能スコープ: default

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

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

Declaration
public static 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

エラー発生時のコールバック
Remarks

使用可能スコープ: default

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

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

Declaration
public static 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

エラー発生時のコールバック
Remarks

使用可能スコープ: default

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

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

Declaration
public static 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

エラー発生時のコールバック
Remarks

使用可能スコープ: default

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

アートワークの詳細を取得する

Declaration
public static void GetArtwork(string artworkId, Action<ArtworkDetail> onSuccess, Action<ApiErrorFormat> onError)
Parameters
Type Name Description
String artworkId

取得するアートワークのID
Action<ArtworkDetail> onSuccess

成功した時のコールバック
Action<ApiErrorFormat> onError

失敗した時のコールバック
Remarks

使用可能スコープ: default

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

キャラクターの詳細情報を取得する

Declaration
public static void GetCharacter(string characterId, Action<CharacterDetail> onSuccess, Action<ApiErrorFormat> onError)
Parameters
Type Name Description
String characterId

取得したいキャラクターのID
Action<CharacterDetail> onSuccess

成功した時のコールバック
Action<ApiErrorFormat> onError

失敗した時のコールバック
Remarks

使用可能スコープ: default

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

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

Declaration
public static void GetCharacterModel(string characterModelId, Action<CharacterModelDetail> onSuccess, Action<ApiErrorFormat> onError)
Parameters
Type Name Description
String characterModelId

詳細情報を取得したいキャラクターモデルID
Action<CharacterModelDetail> onSuccess

成功した時のコールバック
Action<ApiErrorFormat> onError

エラー発生時のコールバック
Remarks

使用可能スコープ: default

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

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

Declaration
public static void GetCharacterModelsProperty(string characterModelId, Action<CharacterModelProperty> onSuccess, Action<ApiErrorFormat> onError)
Parameters
Type Name Description
String characterModelId

プロパティ情報を取得するキャラクターモデルID
Action<CharacterModelProperty> onSuccess

成功した時のコールバック
Action<ApiErrorFormat> onError

失敗した時のコールバック

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

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

Declaration
public static 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

失敗した時のコールバック
Remarks

使用可能スコープ: default

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

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

Declaration
public static 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

失敗した時のコールバック
Remarks

使用可能スコープ: default

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

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

Declaration
public static 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

失敗した時のコールバック
Remarks

使用可能スコープ: default

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

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

Declaration
public static 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

失敗した時のコールバック
Remarks

使用可能スコープ: default

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

ダウンロードライセンス情報を取得

Declaration
public static void GetDownloadLicense(string licenseId, Action<DownloadLicense> onSuccess, Action<ApiErrorFormat> onError)
Parameters
Type Name Description
String licenseId

取得するライセンスID
Action<DownloadLicense> onSuccess

成功した時のコールバック
Action<ApiErrorFormat> onError

失敗した時のコールバック
Remarks

使用可能スコープ: default

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

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

Declaration
public static void GetDownloadLicenseDownload(string licenseId, Action<byte[]> onSuccess, Action<float> onProgress, Action<ApiErrorFormat> onError)
Parameters
Type Name Description
String licenseId

ライセンスID
Action<Byte[]> onSuccess

成功した時のコールバック
Action<Single> onProgress

APIリクエスト中のコールバック
Action<ApiErrorFormat> onError

失敗した時のコールバック
Remarks

使用可能スコープ: default

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

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

Declaration
public static void GetDownloadLicenseDownload(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

失敗した時のコールバック
Remarks

使用可能スコープ: default

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

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

Declaration
public static 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

失敗した時のコールバック
Remarks

使用可能スコープ: default

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

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

Declaration
public static 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

失敗した時のコールバック
Remarks

使用可能スコープ: default

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

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

Declaration
public static 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

失敗した時のコールバック
Remarks

使用可能スコープ: default

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

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

Declaration
public static 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

失敗した時のコールバック
Remarks

使用可能スコープ: default

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

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

Declaration
public static 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

失敗した時のコールバック
Remarks

使用可能スコープ: default

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

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

Declaration
public static 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

失敗した時のコールバック
Remarks

使用可能スコープ: default

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

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

Declaration
public static 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

失敗した時のコールバック
Remarks

使用可能スコープ: default

Initialize(Client, ISdkConfig)

初期化

Declaration
public static void Initialize(Client client, ISdkConfig config)
Parameters
Type Name Description
Client client

OAuth通信を担うクライアント
ISdkConfig config

VRoid SDKの設定
See Also

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

アップロードしたメディアから新規アートワークを作成する

Declaration
public static void PostArtwork(PostArtworksParams requestParams, Action<ArtworkDetail> onSuccess, Action<ApiErrorFormat> onError)
Parameters
Type Name Description
PostArtworksParams requestParams

送信するパラメータ
Action<ArtworkDetail> onSuccess

成功した時のコールバック
Action<ApiErrorFormat> onError

エラー発生時のコールバック
Remarks

使用可能スコープ: default

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

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

Declaration
public static void PostArtworkMediaImage(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

エラー発生時のコールバック
Remarks

使用可能スコープ: default

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

複数のキャラクターのモデル情報をID指定でまとめて取得する

Declaration
public static void PostCharacterModelBatch(string[] characterModelIds, Action<List<CharacterModel>> onSuccess, Action<ApiErrorFormat> onError)
Parameters
Type Name Description
String[] characterModelIds

キャラクターモデルのID一覧. 最大100件まで対応可能
Action<List<CharacterModel>> onSuccess

成功した時のコールバック
Action<ApiErrorFormat> onError

失敗した時のコールバック
Remarks

使用可能スコープ: default

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

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

Declaration
public static 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

失敗した時のコールバック

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

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

Declaration
public static void PostDownloadLicense(string characterModelId, Action<DownloadLicense> onSuccess, Action<ApiErrorFormat> onError)
Parameters
Type Name Description
String characterModelId

キャラクターモデルID
Action<DownloadLicense> onSuccess

成功した時のコールバック
Action<ApiErrorFormat> onError

失敗した時のコールバック
Remarks

使用可能スコープ: default

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

モデルにハートをつける

Declaration
public static void PostHeart(string characterModelId, Action<EmptySerializer> onSuccess, Action<ApiErrorFormat> onError)
Parameters
Type Name Description
String characterModelId

ハートをつけるキャラクターモデルID
Action<EmptySerializer> onSuccess

成功した時のコールバック
Action<ApiErrorFormat> onError

失敗した時のコールバック
Remarks

使用可能スコープ: heart