Class DefaultApi

API with default scope

Callbacks are called asynchronously for all APIs

Anything with Async will be executed asynchronously, success result Task will be returned

Inheritance
Object
ApiBase
DefaultApi
Implements
Inherited Members
Namespace: Pixiv.VroidSdk.Api
Assembly: Pixiv.VroidSdk.dll
Syntax
public sealed class DefaultApi : ApiBase, IDownloadLicensePublishable, IModelDownloadable

Constructors

DefaultApi(Client)

Constructor

Declaration
public DefaultApi(Client client)
Parameters
Type Name Description
Client client

API request client

Methods

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

Invalidate download license

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

License ID to be invalidated
Action<EmptySerializer> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on failure
See Also

DeleteDownloadLicensesAsync(String)

Invalidate download license

Declaration
public async Task<EmptySerializer> DeleteDownloadLicensesAsync(string licenseId)
Parameters
Type Name Description
String licenseId

License ID to be invalidated
Returns
Type Description
Task<EmptySerializer>

Response null
Exceptions
Type Condition
ApiErrorFormat

API error
See Also

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

Get information of users currently logged in to VRoid Hub

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

Callback on success
Action<ApiErrorFormat> onError

Callback on error

GetAccountAsync()

Get information of users currently logged in to VRoid Hub

Declaration
public async Task<Account> GetAccountAsync()
Returns
Type Description
Task<Account>

Retrieved user data
Exceptions
Type Condition
ApiErrorFormat

API error

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

Get user created character models (with related link data)

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

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

Get user created character models

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

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

Get user created character models (with related link information)

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

Return models older than specified model ID
Action<List<CharacterModel>, ApiLinksFormat> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on error

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

Get user created character models

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

Return models older than specified model ID
Action<List<CharacterModel>> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on error

GetAccountCharacterModelsAsync(Int32, String)

Get user created character models (with related link data)

Declaration
public async Task<List<CharacterModel>> GetAccountCharacterModelsAsync(int count, string maxId = null)
Parameters
Type Name Description
Int32 count

No. of character models (MAX 100)
String maxId

Return models older than specified model ID
Returns
Type Description
Task<List<CharacterModel>>

Retrieved character models
Exceptions
Type Condition
ApiErrorFormat

API error

GetAccountCharacterModelsAsyncWithLink(Int32, String)

Get user created character models (with related link data)

Declaration
public async Task<WithLink<List<CharacterModel>>> GetAccountCharacterModelsAsyncWithLink(int count, string maxId = null)
Parameters
Type Name Description
Int32 count

No. of character models (MAX 100)
String maxId

Return models older than specified model ID
Returns
Type Description
Task<WithLink<List<CharacterModel>>>

Retrieved character models
Exceptions
Type Condition
ApiErrorFormat

API error

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

Get user created characters (with related link data)

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

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

Callback on success
Action<ApiErrorFormat> onError

Callback on error

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

Get user created characters

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

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

Callback on success
Action<ApiErrorFormat> onError

Callback on error

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

Get user created characters (with related link data)

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

No. of characters (MAX 100)
String maxId

Return characters older than specified character ID
Action<List<Character>, ApiLinksFormat> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on error

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

Get user created characters

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

No. of characters (MAX 100)
String maxId

Return characters older than specified character ID
Action<List<Character>> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on error

GetAccountCharactersAsync(Int32, String)

Get user created character models

Declaration
public async Task<List<Character>> GetAccountCharactersAsync(int count, string maxId = null)
Parameters
Type Name Description
Int32 count

No. of character models (MAX 100)
String maxId

Return models older than specified model ID
Returns
Type Description
Task<List<Character>>

Retrieved character models
Exceptions
Type Condition
ApiErrorFormat

API error

GetAccountCharactersAsyncWithLink(Int32, String)

Get user created characters (with related link data)

Declaration
public async Task<WithLink<List<Character>>> GetAccountCharactersAsyncWithLink(int count, string maxId = null)
Parameters
Type Name Description
Int32 count

No. of characters (MAX 100)
String maxId

Return characters older than specified character ID
Returns
Type Description
Task<WithLink<List<Character>>>

Retrieved models
Exceptions
Type Condition
ApiErrorFormat

API error

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

Get user artwork details (with related link data)

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

Target artwork ID
Action<ArtworkDetail> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on failure

GetArtworksAsync(String)

Get user artwork details (with related link data)

Declaration
public async Task<ArtworkDetail> GetArtworksAsync(string artworkId)
Parameters
Type Name Description
String artworkId

Target artwork ID
Returns
Type Description
Task<ArtworkDetail>

Retrieved artwork details
Exceptions
Type Condition
ApiErrorFormat

API error

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

Get details of model linked to character

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

Target character model ID
Action<CharacterModelDetail> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on error

GetCharacterModelsAsync(String)

Get details of model linked to character

Declaration
public async Task<CharacterModelDetail> GetCharacterModelsAsync(string characterModelId)
Parameters
Type Name Description
String characterModelId

Target character model ID
Returns
Type Description
Task<CharacterModelDetail>

Retrieved model details
Exceptions
Type Condition
ApiErrorFormat

API error

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

Get character model properties

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

Target character model ID
Action<CharacterModelProperty> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on failure

GetCharacterModelsPropertyAsync(String)

Get character model properties

Declaration
public async Task<CharacterModelProperty> GetCharacterModelsPropertyAsync(string characterModelId)
Parameters
Type Name Description
String characterModelId

Target character model ID
Returns
Type Description
Task<CharacterModelProperty>

Character model properties
Exceptions
Type Condition
ApiErrorFormat

API error

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

Get character

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

Character ID
Action<CharacterDetail> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on error

GetCharactersAsync(String)

Get character

Declaration
public async Task<CharacterDetail> GetCharactersAsync(string characterId)
Parameters
Type Name Description
String characterId

Character ID
Returns
Type Description
Task<CharacterDetail>

Character
Exceptions
Type Condition
ApiErrorFormat

API error

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

Get models linked to character (with related link data)

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

Target character ID
Int32 count

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

Callback on success
Action<ApiErrorFormat> onError

Callback on error

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

Get models linked to character

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

Target character ID
Int32 count

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

Callback on success
Action<ApiErrorFormat> onError

Callback on error

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

Get models linked to character

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

Target character ID
Int32 count

No. of characters (MAX 100)
String maxId

Return characters older than specified character ID
Action<List<CharacterModel>, ApiLinksFormat> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on error

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

Get models linked to character

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

Target character ID
Int32 count

No. of characters (MAX 100)
String maxId

Return characters older than specified character ID
Action<List<CharacterModel>> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on error

GetCharactersModelsAsync(String, Int32, String)

Get models linked to character

Declaration
public async Task<List<CharacterModel>> GetCharactersModelsAsync(string characterId, int count, string maxId = null)
Parameters
Type Name Description
String characterId

Target character ID
Int32 count

No. of characters (MAX 100)
String maxId

Return characters older than specified character ID
Returns
Type Description
Task<List<CharacterModel>>

List of models
Exceptions
Type Condition
ApiErrorFormat

API error

GetCharactersModelsAsyncWithLink(String, Int32, String)

Get models linked to character (with related link data)

Declaration
public async Task<WithLink<List<CharacterModel>>> GetCharactersModelsAsyncWithLink(string characterId, int count, string maxId = null)
Parameters
Type Name Description
String characterId

Target character ID
Int32 count

No. of characters (MAX 100)
String maxId

Return characters older than specified character ID
Returns
Type Description
Task<WithLink<List<CharacterModel>>>

List of models
Exceptions
Type Condition
ApiErrorFormat

API error

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

Get license information for model download

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

License ID
Action<DownloadLicense> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on error

GetDownloadLicensesAsync(String)

Get license information for model download

Declaration
public async Task<DownloadLicense> GetDownloadLicensesAsync(string licenseId)
Parameters
Type Name Description
String licenseId

License ID
Returns
Type Description
Task<DownloadLicense>

License information for model download
Exceptions
Type Condition
ApiErrorFormat

API error

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

Get binary data from download license

Declaration
public void GetDownloadLicensesDownload(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 download
Action<ApiErrorFormat> onError

Callback on error

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

Get binary data from download license

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

License ID
Int32 timeout

Request timeout (seconds)
Action<Byte[]> onSuccess

Callback on success
Action<Single> onProgress

Callback during API request
Action<ApiErrorFormat> onError

Callback on failure

GetDownloadLicensesDownloadAsync(String, Action<Single>)

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

Declaration
public Task<byte[]> GetDownloadLicensesDownloadAsync(string licenseId, Action<float> onProgress)
Parameters
Type Name Description
String licenseId

License ID
Action<Single> onProgress

Callback during download
Returns
Type Description
Task<Byte[]>

Downloaded model byte array
Exceptions
Type Condition
ApiErrorFormat

API error

GetDownloadLicensesDownloadAsync(String, Int32, Action<Single>)

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

Declaration
public async Task<byte[]> GetDownloadLicensesDownloadAsync(string licenseId, int timeout, Action<float> onProgress)
Parameters
Type Name Description
String licenseId

License ID
Int32 timeout

Timeout (seconds)
Action<Single> onProgress

Callback during API request
Returns
Type Description
Task<Byte[]>

Downloaded model byte array
Exceptions
Type Condition
ApiErrorFormat

API error

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

Get hearted models (with related link data)

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

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

Get hearted models

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

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

Get hearted models (with related link data)

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

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

Callback on success
Action<ApiErrorFormat> onError

Callback on failure

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

Get hearted models

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

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

Callback on success
Action<ApiErrorFormat> onError

Callback on failure

GetHeartsAsync(Int32, String)

Get hearted models

Declaration
public async Task<List<CharacterModel>> GetHeartsAsync(int count, string maxId = null)
Parameters
Type Name Description
Int32 count

No. of character models (MAX 100)
String maxId

Max model ID for paging
Returns
Type Description
Task<List<CharacterModel>>

Hearted models list
Exceptions
Type Condition
ApiErrorFormat

API error

GetHeartsAsyncWithLink(Int32, String)

Get hearted models (with related link data)

Declaration
public async Task<WithLink<List<CharacterModel>>> GetHeartsAsyncWithLink(int count, string maxId = null)
Parameters
Type Name Description
Int32 count

No. of character models (MAX 100)
String maxId

Max model ID for paging
Returns
Type Description
Task<WithLink<List<CharacterModel>>>

Hearted models list
Exceptions
Type Condition
ApiErrorFormat

API error

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

Get VRoid Hub Highlights models (with related link data)

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

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

Get VRoid Hub Highlights models

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

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

Callback on success
Action<ApiErrorFormat> onError

Callback on failure

GetStaffPicksAsync(Int32)

Get VRoid Hub Highlights

Declaration
public async Task<List<StaffPicksCharacterModel>> GetStaffPicksAsync(int count)
Parameters
Type Name Description
Int32 count

No. of character models (MAX 100)
Returns
Type Description
Task<List<StaffPicksCharacterModel>>

Highlights models
Exceptions
Type Condition
ApiErrorFormat

API error

GetStaffPicksAsyncWithLink(Int32)

Get VRoid Hub Highlights models (with related link data)

Declaration
public async Task<WithLink<List<StaffPicksCharacterModel>>> GetStaffPicksAsyncWithLink(int count)
Parameters
Type Name Description
Int32 count

No. of character models (MAX 100)
Returns
Type Description
Task<WithLink<List<StaffPicksCharacterModel>>>

Highlights models
Exceptions
Type Condition
ApiErrorFormat

API error

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

Get user artworks (with related link data)

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

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

Get user artworks

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

Target user
Int32 count

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

Callback on success
Action<ApiErrorFormat> onError

Callback on failure

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

Get user artworks (with related link data)

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

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

Callback on success
Action<ApiErrorFormat> onError

Callback on failure

GetUsersArtworksAsync(User, Int32, String)

Get user artworks

Declaration
public async Task<List<Artwork>> GetUsersArtworksAsync(User user, int count, string maxId = null)
Parameters
Type Name Description
User user

Target user
Int32 count

No. of artworks
String maxId

Max artwork ID for paging
Returns
Type Description
Task<List<Artwork>>

Retrieved artwork list
Exceptions
Type Condition
ApiErrorFormat

API error

GetUsersArtworksAsyncWithLink(User, Int32, String)

Get user artworks (with related link data)

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

Target user
Int32 count

No. of artworks
String maxId

Max artwork ID for paging
Returns
Type Description
Task<WithLink<List<Artwork>>>

Retrieved artwork list
Exceptions
Type Condition
ApiErrorFormat

API error

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

Upload new image

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

Parameters
Action<ArtworkMedium> onSuccess

Callback on success
Action<Single> onProgress

Callback during upload
Action<ApiErrorFormat> onError

Callback on error

PostArtworkMediaImagesAsync(PostArtworkMediaImagesParams, Action<Single>)

Upload new artwork

Declaration
public async Task<ArtworkMedium> PostArtworkMediaImagesAsync(PostArtworkMediaImagesParams requestParams, Action<float> onProgress)
Parameters
Type Name Description
PostArtworkMediaImagesParams requestParams

Parameters
Action<Single> onProgress

Callback during upload
Returns
Type Description
Task<ArtworkMedium>

Uploaded artwork image
Exceptions
Type Condition
ApiErrorFormat

API error

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

Post artwork

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

Parameters
Action<ArtworkDetail> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on error

PostArtworksAsync(PostArtworksParams)

Post artwork

Declaration
public async Task<ArtworkDetail> PostArtworksAsync(PostArtworksParams requestParams)
Parameters
Type Name Description
PostArtworksParams requestParams

Parameters
Returns
Type Description
Task<ArtworkDetail>

Uploaded artwork image
Exceptions
Type Condition
ApiErrorFormat

API error

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

Get all models linked with character

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

List of target character model IDs
Action<List<CharacterModel>> onSuccess

Callback on success
Action<ApiErrorFormat> onError

Callback on error

PostCharacterModelsBatchAsync(String[])

Get multiple character model details

Declaration
public async Task<List<CharacterModel>> PostCharacterModelsBatchAsync(string[] characterModelIds)
Parameters
Type Name Description
String[] characterModelIds

Target character model IDs
Returns
Type Description
Task<List<CharacterModel>>

Character model details list
Exceptions
Type Condition
ApiErrorFormat

API error

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

Get multiple character model properties

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

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

Callback on success
Action<ApiErrorFormat> onError

Callback on failure

PostCharacterModelsPropertiesBatchAsync(List<String>)

Get multiple character model properties

Declaration
public async Task<List<CharacterModelProperty>> PostCharacterModelsPropertiesBatchAsync(List<string> characterModelIds)
Parameters
Type Name Description
List<String> characterModelIds

Target character model list
Returns
Type Description
Task<List<CharacterModelProperty>>

Character model properties list
Exceptions
Type Condition
ApiErrorFormat

API error

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

Issue download license

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

PostDownloadLicensesAsync(String)

Issue download license

Declaration
public async Task<DownloadLicense> PostDownloadLicensesAsync(string characterModelId)
Parameters
Type Name Description
String characterModelId

Character model ID
Returns
Type Description
Task<DownloadLicense>

Downlaod license
Exceptions
Type Condition
ApiErrorFormat

API error

Implements