Show / Hide Table of Contents

Class HeartApi

API with heart scope

Callbacks are called asynchronously for all APIs

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

Inheritance
Object
ApiBase
HeartApi
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 HeartApi : ApiBase

Constructors

HeartApi(Client)

Constructor

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

API request client

Methods

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

Remove heart from model

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

Target model

Action<EmptySerializer> onSuccess

Callback on success

Action<ApiErrorFormat> onError

Callback on failure

DeleteHeartsAsync(String)

Remove heart from model

Declaration
public async Task<EmptySerializer> DeleteHeartsAsync(string characterModelId)
Parameters
Type Name Description
String characterModelId

Target model

Returns
Type Description
Task<EmptySerializer>

Response null

Exceptions
Type Condition
ApiErrorFormat

API error

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

Add heart to model

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

Target model

Action<EmptySerializer> onSuccess

Callback on success

Action<ApiErrorFormat> onError

Callback on failure

PostHeartsAsync(String)

Add heart to model

Declaration
public async Task<EmptySerializer> PostHeartsAsync(string characterModelId)
Parameters
Type Name Description
String characterModelId

Target model

Returns
Type Description
Task<EmptySerializer>

Response null

Exceptions
Type Condition
ApiErrorFormat
In This Article
Back to top Generated by DocFX