Class HubApi

Send API request to VRoid Hub

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

What can be used as API is restricted by application scope setting created on SDKConfiguration and application management page

Check remarks of each method to see what scope API can run

Methods

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

Invalidate download license

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

License ID to invalidate
Action<EmptySerializer> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on failure
Remarks

Usable scope: default

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

Remove hearts from character model

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

Character model ID to remove hearts from
Action<EmptySerializer> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on failure
Remarks

Usable scope: heart

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

Get user data of user logged in to VRoid Hub

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

Callback on success
Action<ApiErrorFormat> onError

Callback on error
Remarks

Usable scope: default

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

Get user created character models (with related link data)

Declaration
public static void GetAccountCharacterModels(int count, Action<List<CharacterModel>, ApiLinksFormat> onSuccess, Action<ApiErrorFormat> onError)
Parameters
Type Name Description
Int32 count

No. of character models (MAX 100)
Action<List<CharacterModel>, ApiLinksFormat> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on error
Remarks

Usable scope: default

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

Get user created character models

Declaration
public static void GetAccountCharacterModels(int count, Action<List<CharacterModel>> onSuccess, Action<ApiErrorFormat> onError)
Parameters
Type Name Description
Int32 count

No. of character models (MAX 100)
Action<List<CharacterModel>> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on error
Remarks

Usable scope: default

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

Get user created character models (with related link data)

Declaration
public static void GetAccountCharacterModels(int count, string maxId, Action<List<CharacterModel>, ApiLinksFormat> onSuccess, Action<ApiErrorFormat> onError)
Parameters
Type Name Description
Int32 count

No. of character models (MAX 100)
String maxId

Highest ID of model linked to character
Action<List<CharacterModel>, ApiLinksFormat> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on error
Remarks

Usable scope: default

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

Get user created character models

Declaration
public static void GetAccountCharacterModels(int count, string maxId, Action<List<CharacterModel>> onSuccess, Action<ApiErrorFormat> onError)
Parameters
Type Name Description
Int32 count

No. of character models (MAX 100)
String maxId

Highest ID of model linked to character
Action<List<CharacterModel>> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on error
Remarks

Usable scope: default

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

Get user created characters (with related link data)

Declaration
public static void GetAccountCharacters(int count, Action<List<Character>, ApiLinksFormat> onSuccess, Action<ApiErrorFormat> onError)
Parameters
Type Name Description
Int32 count

No. of character models (MAX 100)
Action<List<Character>, ApiLinksFormat> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on error
Remarks

Usable scope: default

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

Get user created characters

Declaration
public static void GetAccountCharacters(int count, Action<List<Character>> onSuccess, Action<ApiErrorFormat> onError)
Parameters
Type Name Description
Int32 count

No. of character models (MAX 100)
Action<List<Character>> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on error
Remarks

Usable scope: default

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

Get user created characters (with related link data)

Declaration
public static void GetAccountCharacters(int count, string maxId, Action<List<Character>, ApiLinksFormat> onSuccess, Action<ApiErrorFormat> onError)
Parameters
Type Name Description
Int32 count

No. of character models (MAX 100)
String maxId

Highest model ID for paging
Action<List<Character>, ApiLinksFormat> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on error
Remarks

Usable scope: default

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

Get user created characters

Declaration
public static void GetAccountCharacters(int count, string maxId, Action<List<Character>> onSuccess, Action<ApiErrorFormat> onError)
Parameters
Type Name Description
Int32 count

No. of character models (MAX 100)
String maxId

Highest model ID for paging
Action<List<Character>> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on error
Remarks

Usable scope: default

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

Get artwork details

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

Artwork ID to get
Action<ArtworkDetail> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on failure
Remarks

Usable scope: default

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

Get character details

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

Character ID to get
Action<CharacterDetail> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on failure
Remarks

Usable scope: default

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

Get character model details

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

Character model ID to get details of
Action<CharacterModelDetail> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on error
Remarks

Usable scope: default

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

Get character model properties

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

Character model ID to get properties of
Action<CharacterModelProperty> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on failure

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

Get character models linked to character

Declaration
public static void GetCharactersModels(string characterId, int count, Action<List<CharacterModel>, ApiLinksFormat> onSuccess, Action<ApiErrorFormat> onError)
Parameters
Type Name Description
String characterId

Character ID
Int32 count

No. of character models (MAX 100)
Action<List<CharacterModel>, ApiLinksFormat> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on failure
Remarks

Usable scope: default

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

Get character models linked to character

Declaration
public static void GetCharactersModels(string characterId, int count, Action<List<CharacterModel>> onSuccess, Action<ApiErrorFormat> onError)
Parameters
Type Name Description
String characterId

Character ID
Int32 count

No. of character models (MAX 100)
Action<List<CharacterModel>> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on failure
Remarks

Usable scope: default

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

Get character models linked to character (with related link data)

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

Character ID
Int32 count

No. of character models (MAX 100)
String maxId

Highest character model ID for paging purposes
Action<List<CharacterModel>, ApiLinksFormat> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on failure
Remarks

Usable scope: default

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

Get character models linked to character

Declaration
public static void GetCharactersModels(string characterId, int count, string maxId, Action<List<CharacterModel>> onSuccess, Action<ApiErrorFormat> onError)
Parameters
Type Name Description
String characterId

Character ID
Int32 count

No. of character models (MAX 100)
String maxId

Highest character model ID for paging purposes
Action<List<CharacterModel>> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on failure
Remarks

Usable scope: default

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

Get download license data

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

License ID to get
Action<DownloadLicense> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on failure
Remarks

Usable scope: default

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

Get model version linked to download license (timeout 300 seconds)

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

License ID
Action<Byte[]> onSuccess

Callback on success
Action<Single> onProgress

Callback during API request
Action<ApiErrorFormat> onError

Callback on failure
Remarks

Usable scope: default

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

Get model version linked to download license

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

License ID
Int32 timeout

Timeout (seconds)
Action<Byte[]> onSuccess

Callback on success
Action<Single> onProgress

Callback during API request
Action<ApiErrorFormat> onError

Callback on failure
Remarks

Usable scope: default

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

Get hearted models (with related link data)

Declaration
public static void GetHearts(int count, Action<List<CharacterModel>, ApiLinksFormat> onSuccess, Action<ApiErrorFormat> onError)
Parameters
Type Name Description
Int32 count

No. of character models (MAX 100)
Action<List<CharacterModel>, ApiLinksFormat> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on failure
Remarks

Usable scope: default

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

Get hearted models

Declaration
public static void GetHearts(int count, Action<List<CharacterModel>> onSuccess, Action<ApiErrorFormat> onError)
Parameters
Type Name Description
Int32 count

No. of character models (MAX 100)
Action<List<CharacterModel>> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on failure
Remarks

Usable scope: default

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

Get user created characters (with related link data)

Declaration
public static void GetHearts(int count, string maxId, Action<List<CharacterModel>, ApiLinksFormat> onSuccess, Action<ApiErrorFormat> onError)
Parameters
Type Name Description
Int32 count

No. of character models (MAX 100)
String maxId

Highest model ID for paging
Action<List<CharacterModel>, ApiLinksFormat> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on error
Remarks

Usable scope: default

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

Get user created characters

Declaration
public static void GetHearts(int count, string maxId, Action<List<CharacterModel>> onSuccess, Action<ApiErrorFormat> onError)
Parameters
Type Name Description
Int32 count

No. of character models (MAX 100)
String maxId

Highest model ID for paging
Action<List<CharacterModel>> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on error
Remarks

Usable scope: default

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

Get VRoid Hub Highlights models (with related link data)

Declaration
public static void GetStaffPicks(int count, Action<List<StaffPicksCharacterModel>, ApiLinksFormat> onSuccess, Action<ApiErrorFormat> onError)
Parameters
Type Name Description
Int32 count

No. of character models (MAX 100)
Action<List<StaffPicksCharacterModel>, ApiLinksFormat> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on failure
Remarks

Usable scope: default

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

Get user artworks

Declaration
public static void GetUsersArtworks(User user, int count, Action<List<Artwork>, ApiLinksFormat> onSuccess, Action<ApiErrorFormat> onError)
Parameters
Type Name Description
User user

Target user
Int32 count

No. of artworks
Action<List<Artwork>, ApiLinksFormat> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on failure
Remarks

Usable scope: default

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

Get user artworks

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

Target user
Int32 count

No. of artworks
String maxId

Highest artwork ID for paging purposes
Action<List<Artwork>, ApiLinksFormat> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on failure
Remarks

Usable scope: default

Initialize(Client, ISdkConfig)

Initialize

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

Client to handle OAuth transmission
ISdkConfig config

VRoid SDK settings
See Also

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

Create new artwork from uploaded media

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

Parameters to send
Action<ArtworkDetail> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on error
Remarks

Usable scope: default

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

Upload new artwork image

Declaration
public static void PostArtworkMediaImage(PostArtworkMediaImagesParams requestParams, Action<ArtworkMedium> onSuccess, Action<float> onProgress, Action<ApiErrorFormat> onError)
Parameters
Type Name Description
PostArtworkMediaImagesParams requestParams

Parameters to send
Action<ArtworkMedium> onSuccess

Callback on success
Action<Single> onProgress

Callback called during upload
Action<ApiErrorFormat> onError

Callback on error
Remarks

Usable scope: default

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

Get multiple character models data up to specified ID

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

Character model IDs. Up to 100 max
Action<List<CharacterModel>> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on error
Remarks

Usable scope: default

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

Get multiple character model properties

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

Target character model IDs list
Action<List<CharacterModelProperty>> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on failure

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

Issue download license

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

Character model ID
Action<DownloadLicense> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on failure
Remarks

Usable scope: default

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

Add heart to model

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

Character model ID to add heart to
Action<EmptySerializer> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on failure
Remarks

Usable scope: heart