Interface IApiKeysClient
Namespace: FastReport.Cloud
Assembly: FastReport.Cloud.SDK.dll
Syntax
public interface IApiKeysClientMethods
CreateApiKey(CreateApiKeyVM)
Create a new apikey, 5 apikeys for user. Hardcoded for ddos.
Declaration
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
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
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
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
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
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. |