Interface IUserSettingsClient

Namespace: FastReport.Cloud

Assembly: FastReport.Cloud.SDK.dll

Syntax

public interface IUserSettingsClient

Methods

AcceptAgreements(AcceptAgreementsVM)

Use this endpoint to accept current version of service license agreement

Declaration

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

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

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

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.

UpdateMySettings(UpdateUserSettingsVM)

Update settings of the current user

Declaration

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

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.