Class UserProfileClient

Inheritance

System.Object

UserProfileClient

Implements

IUserProfileClient

Namespace: FastReport.Cloud.Client

Assembly: FastReport.Cloud.SDK.dll

Syntax

public class UserProfileClient : object, IUserProfileClient

Constructors

UserProfileClient(System.Net.Http.HttpClient)

Declaration

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

GetMyProfile()

Return current profile of the current user

Declaration

public virtual UserProfileVM GetMyProfile()

Returns

Type	Description
UserProfileVM	Succesfully returned

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetMyProfileAsync(System.Threading.CancellationToken)

Return current profile of the current user

Declaration

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetUserProfile(String)

Return user profile by user identifier.
If the user did not provide information about himself or blocked, then the endpoint will return an empty model. (only id)

Declaration

public virtual UserProfileVM GetUserProfile(string userId)

Parameters

Type	Name	Description
System.String	userId

Returns

Type	Description
UserProfileVM	Succesfully returned

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetUserProfileAsync(String, System.Threading.CancellationToken)

Return user profile by user identifier.
If the user did not provide information about himself or blocked, then the endpoint will return an empty model. (only id)

Declaration

public virtual async System.Threading.Tasks.Task<UserProfileVM> GetUserProfileAsync(string userId, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	userId
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<UserProfileVM>	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<UserProfileClient.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<UserProfileClient.ObjectResponseResult<T>>

Type Parameters

Name	Description
T

UpdateMyProfile(UpdateUserProfileVM)

Update profile of the current user

Declaration

public virtual void UpdateMyProfile(UpdateUserProfileVM body = null)

Parameters

Type	Name	Description
UpdateUserProfileVM	body

Remarks

This method is only allowed for local sign in via intranet

Exceptions

Type	Condition
ApiException	A server side error occurred.

UpdateMyProfileAsync(UpdateUserProfileVM, System.Threading.CancellationToken)

Update profile of the current user

Declaration

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

Parameters

Type	Name	Description
UpdateUserProfileVM	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 updated

Remarks

This method is only allowed for local sign in via intranet

Exceptions

Type	Condition
ApiException	A server side error occurred.

Implements

IUserProfileClient