Class ApiKeysClient

Inheritance
System.Object
ApiKeysClient
Implements
Namespace: FastReport.Cloud.Client
Assembly: FastReport.Cloud.SDK.dll
Syntax
public class ApiKeysClient : object, IApiKeysClient

Constructors

ApiKeysClient(System.Net.Http.HttpClient)

Declaration
public ApiKeysClient(System.Net.Http.HttpClient httpClient)
Parameters
Type Name Description
System.Net.Http.HttpClient httpClient

Properties

JsonSerializerSettings

Declaration
protected Newtonsoft.Json.JsonSerializerSettings JsonSerializerSettings { get; }
Property Value
Type Description
Newtonsoft.Json.JsonSerializerSettings

PrepareRequestCallback

Declaration
public Action<System.Net.Http.HttpClient, System.Net.Http.HttpRequestMessage, string> PrepareRequestCallback { get; set; }
Property Value
Type Description
Action<System.Net.Http.HttpClient, System.Net.Http.HttpRequestMessage, System.String>

ReadResponseAsString

Declaration
public bool ReadResponseAsString { get; set; }
Property Value
Type Description
System.Boolean

Methods

CreateApiKey(CreateApiKeyVM)

Create a new apikey, 5 apikeys for user. Hardcoded for ddos.

Declaration
public virtual ApiKeyVM CreateApiKey(CreateApiKeyVM body)
Parameters
Type Name Description
CreateApiKeyVM body
Returns
Type Description
ApiKeyVM

Succesfully created
Exceptions
Type Condition
ApiException

A server side error occurred.

CreateApiKeyAsync(CreateApiKeyVM, System.Threading.CancellationToken)

Create a new apikey, 5 apikeys for user. Hardcoded for ddos.

Declaration
public virtual async System.Threading.Tasks.Task<ApiKeyVM> CreateApiKeyAsync(CreateApiKeyVM body, System.Threading.CancellationToken cancellationToken = null)
Parameters
Type Name Description
CreateApiKeyVM body
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Type Description
System.Threading.Tasks.Task<ApiKeyVM>

Succesfully created
Exceptions
Type Condition
ApiException

A server side error occurred.

DeleteApiKey(DeleteApiKeyVM)

Delete an apikey

Declaration
public virtual void DeleteApiKey(DeleteApiKeyVM body)
Parameters
Type Name Description
DeleteApiKeyVM body
Exceptions
Type Condition
ApiException

A server side error occurred.

DeleteApiKeyAsync(DeleteApiKeyVM, System.Threading.CancellationToken)

Delete an apikey

Declaration
public virtual async System.Threading.Tasks.Task DeleteApiKeyAsync(DeleteApiKeyVM body, System.Threading.CancellationToken cancellationToken = null)
Parameters
Type Name Description
DeleteApiKeyVM body
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Type Description
System.Threading.Tasks.Task

Succesfully deleted
Exceptions
Type Condition
ApiException

A server side error occurred.

GetApiKeys()

Returns list with all apikeys of current user

Declaration
public virtual ApiKeysVM GetApiKeys()
Returns
Type Description
ApiKeysVM

Succesfully retured
Remarks

Always work, it should make only 200 response (except if user is not authorized).

Exceptions
Type Condition
ApiException

A server side error occurred.

GetApiKeysAsync(System.Threading.CancellationToken)

Returns list with all apikeys of current user

Declaration
public virtual async System.Threading.Tasks.Task<ApiKeysVM> GetApiKeysAsync(System.Threading.CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Type Description
System.Threading.Tasks.Task<ApiKeysVM>

Succesfully retured
Remarks

Always work, it should make only 200 response (except if user is not authorized).

Exceptions
Type Condition
ApiException

A server side error occurred.

ReadObjectResponseAsync<T>(System.Net.Http.HttpResponseMessage, System.Collections.Generic.IReadOnlyDictionary<String, System.Collections.Generic.IEnumerable<String>>, System.Threading.CancellationToken)

Declaration
protected virtual async System.Threading.Tasks.Task<ApiKeysClient.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(System.Net.Http.HttpResponseMessage response, System.Collections.Generic.IReadOnlyDictionary<string, System.Collections.Generic.IEnumerable<string>> headers, System.Threading.CancellationToken cancellationToken)
Parameters
Type Name Description
System.Net.Http.HttpResponseMessage response
System.Collections.Generic.IReadOnlyDictionary<System.String, System.Collections.Generic.IEnumerable<System.String>> headers
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<ApiKeysClient.ObjectResponseResult<T>>
Type Parameters
Name Description
T

Implements