Interface IUserProfileClient
Namespace: FastReport.Cloud
Assembly: FastReport.Cloud.SDK.dll
Syntax
public interface IUserProfileClient
Methods
GetMyProfile()
Return current profile of the current user
Declaration
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
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
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
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. |
UpdateMyProfile(UpdateUserProfileVM)
Update profile of the current user
Declaration
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
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. |