Class UserSettingsClient

Inheritance

System.Object

UserSettingsClient

Implements

IUserSettingsClient

Namespace: FastReport.Cloud.Client

Assembly: FastReport.Cloud.SDK.dll

Syntax

public class UserSettingsClient : object, IUserSettingsClient

Constructors

UserSettingsClient(System.Net.Http.HttpClient)

Declaration

public UserSettingsClient(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

AcceptAgreements(AcceptAgreementsVM)

Use this endpoint to accept current version of service license agreement

Declaration

public virtual void AcceptAgreements(AcceptAgreementsVM body = null)

Parameters

Type	Name	Description
AcceptAgreementsVM	body

Exceptions

Type	Condition
ApiException	A server side error occurred.

AcceptAgreementsAsync(AcceptAgreementsVM, System.Threading.CancellationToken)

Use this endpoint to accept current version of service license agreement

Declaration

public virtual async System.Threading.Tasks.Task AcceptAgreementsAsync(AcceptAgreementsVM body = null, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
AcceptAgreementsVM	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	No Content

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetCurrentUserSettings()

Return current user settings.

Declaration

public virtual UserSettingsVM GetCurrentUserSettings()

Returns

Type	Description
UserSettingsVM	Succesfully returned

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetCurrentUserSettingsAsync(System.Threading.CancellationToken)

Return current user settings.

Declaration

public virtual async System.Threading.Tasks.Task<UserSettingsVM> GetCurrentUserSettingsAsync(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<UserSettingsVM>	Succesfully returned

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<UserSettingsClient.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<UserSettingsClient.ObjectResponseResult<T>>

Type Parameters

Name	Description
T

UpdateMySettings(UpdateUserSettingsVM)

Update settings of the current user

Declaration

public virtual UserSettingsVM UpdateMySettings(UpdateUserSettingsVM body = null)

Parameters

Type	Name	Description
UpdateUserSettingsVM	body

Returns

Type	Description
UserSettingsVM	Succesfully updated

Exceptions

Type	Condition
ApiException	A server side error occurred.

UpdateMySettingsAsync(UpdateUserSettingsVM, System.Threading.CancellationToken)

Update settings of the current user

Declaration

public virtual async System.Threading.Tasks.Task<UserSettingsVM> UpdateMySettingsAsync(UpdateUserSettingsVM body = null, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
UpdateUserSettingsVM	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<UserSettingsVM>	Succesfully updated

Exceptions

Type	Condition
ApiException	A server side error occurred.

Implements

IUserSettingsClient