Show / Hide Table of Contents

Class ResponseUtil

APIレスポンスのユーティリティクラス

Inheritance
Object
ResponseUtil
Inherited Members
Object.Equals(Object)
Object.Equals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Object.ReferenceEquals(Object, Object)
Object.ToString()
Namespace: Pixiv.VroidSdk.Utility
Assembly: Pixiv.VroidSdk.dll
Syntax
public static class ResponseUtil

Methods

ConvertErrorResponse(IHttpResponse)

APIエラーレスポンスをApiErrorFormat形式に変換する

Declaration
public static ApiErrorFormat ConvertErrorResponse(IHttpResponse response)
Parameters
Type Name Description
IHttpResponse response

変換対象のエラーレスポンス

Returns
Type Description
ApiErrorFormat

変換後のエラー

ConvertResponse<T>(IApiRequestable, IHttpResponse)

APIエラーレスポンスをWithLink<DataType>形式に変換する

Declaration
public static WithLink<T> ConvertResponse<T>(IApiRequestable client, IHttpResponse response)
Parameters
Type Name Description
IApiRequestable client

コードリフレッシュを行うクライアント

IHttpResponse response

変換対象のレスポンス

Returns
Type Description
WithLink<T>

変換後のレスポンス

Type Parameters
Name Description
T

レスポンスの型

OnHttpRequestFailed(IApiRequestable, Action<Account>, Action<ApiErrorFormat>)

HTTP APIのコールバックのユーティリティメソッド

Declaration
public static Action<HttpRequestFailedException> OnHttpRequestFailed(IApiRequestable client, Action<Account> onRefreshCode, Action<ApiErrorFormat> onError)
Parameters
Type Name Description
IApiRequestable client

コードリフレッシュを行うクライアント

Action<Account> onRefreshCode

コードのリフレッシュが完了した場合に呼び出される

Action<ApiErrorFormat> onError

エラーを処理しきれなかった場合に呼び出される

Returns
Type Description
Action<HttpRequestFailedException>

通信エラーを処理するAction

Remarks

APIのエラーコールバックにこのメソッドの返り値を渡すことで、コードリフレッシュを自動で行う

OnHttpRequestFailedForceRefreshAsync(HttpRequestFailedException, IApiRequestable)

通信エラーを処理するユーティリティメソッド

Declaration
public static Task<Account> OnHttpRequestFailedForceRefreshAsync(HttpRequestFailedException errorFormat, IApiRequestable client)
Parameters
Type Name Description
HttpRequestFailedException errorFormat

発生した通信エラー

IApiRequestable client

コードリフレッシュを行うクライアント

Returns
Type Description
Task<Account>

コードリフレッシュの結果

Remarks

コードのリフレッシュを内部で行う。 コードリフレッシュに失敗したり、このメソッドで処理できないエラーの場合は例外を送出する

In This Article
Back to top Generated by DocFX