Interface IGroupUsersClient
Namespace: FastReport.Cloud
Assembly: FastReport.Cloud.SDK.dll
Syntax
public interface IGroupUsersClientMethods
AddUserToGroup(String, String)
Add user to the group by identifier
Declaration
void AddUserToGroup(string id, string userId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | Identifier of group |
| System.String | userId | Identifier of user |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
AddUserToGroupAsync(String, String, System.Threading.CancellationToken)
Add user to the group by identifier
Declaration
System.Threading.Tasks.Task AddUserToGroupAsync(string id, string userId, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | Identifier of group |
| System.String | userId | Identifier of user |
| 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 retured |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetUsersInGroup(String, Nullable<Int32>, Nullable<Int32>)
Returns users in the group by identifier
Declaration
GroupUsersVM GetUsersInGroup(string id, int? skip = null, int? take = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | Identifier of group |
| System.Nullable<System.Int32> | skip | how many to skip |
| System.Nullable<System.Int32> | take | how many to take |
Returns
| Type | Description |
|---|---|
| GroupUsersVM | Succesfully retured |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetUsersInGroupAsync(String, Nullable<Int32>, Nullable<Int32>, System.Threading.CancellationToken)
Returns users in the group by identifier
Declaration
System.Threading.Tasks.Task<GroupUsersVM> GetUsersInGroupAsync(string id, int? skip = null, int? take = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | Identifier of group |
| System.Nullable<System.Int32> | skip | how many to skip |
| System.Nullable<System.Int32> | take | how many to take |
| 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<GroupUsersVM> | Succesfully retured |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
LeaveFromGroup(String)
Leave from the group
Declaration
void LeaveFromGroup(string id)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | Identifier of group |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
LeaveFromGroupAsync(String, System.Threading.CancellationToken)
Leave from the group
Declaration
System.Threading.Tasks.Task LeaveFromGroupAsync(string id, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | Identifier of group |
| 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 removed |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
RemoveFromGroup(String, String)
Remove user from the group by identifier
Declaration
void RemoveFromGroup(string id, string userId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | Identifier of group |
| System.String | userId | Identifier of user |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
RemoveFromGroupAsync(String, String, System.Threading.CancellationToken)
Remove user from the group by identifier
Declaration
System.Threading.Tasks.Task RemoveFromGroupAsync(string id, string userId, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | Identifier of group |
| System.String | userId | Identifier of user |
| 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 removed |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |