Interface IContactGroupsClient
Namespace: FastReport.Cloud
Assembly: FastReport.Cloud.SDK.dll
Syntax
public interface IContactGroupsClientMethods
Create(CreateContactGroupVM)
Creates contact group
Declaration
ContactGroupVM Create(CreateContactGroupVM body = null)Parameters
| Type | Name | Description |
|---|---|---|
| CreateContactGroupVM | body |
Returns
| Type | Description |
|---|---|
| ContactGroupVM | Contact group was created |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
CreateAsync(CreateContactGroupVM, System.Threading.CancellationToken)
Creates contact group
Declaration
System.Threading.Tasks.Task<ContactGroupVM> CreateAsync(CreateContactGroupVM body = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| CreateContactGroupVM | 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<ContactGroupVM> | Contact group was created |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
Delete(String)
Removes contact by id
Declaration
void Delete(string id)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
DeleteAsync(String, System.Threading.CancellationToken)
Removes contact by id
Declaration
System.Threading.Tasks.Task DeleteAsync(string id, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | |
| 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 | Contact group was deleted |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
Get(String)
Returns contact group by id
Declaration
ContactGroupVM Get(string id)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id |
Returns
| Type | Description |
|---|---|
| ContactGroupVM | Contact group was found |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetAsync(String, System.Threading.CancellationToken)
Returns contact group by id
Declaration
System.Threading.Tasks.Task<ContactGroupVM> GetAsync(string id, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | |
| 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<ContactGroupVM> | Contact group was found |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetList(String, Nullable<Int32>, Nullable<Int32>)
Returns contact groups by subscriptionId
Declaration
ContactGroupsVM GetList(string subscriptionId, int? skip = null, int? take = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | subscriptionId | |
| System.Nullable<System.Int32> | skip | |
| System.Nullable<System.Int32> | take |
Returns
| Type | Description |
|---|---|
| ContactGroupsVM | Contact groups were found |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetListAsync(String, Nullable<Int32>, Nullable<Int32>, System.Threading.CancellationToken)
Returns contact groups by subscriptionId
Declaration
System.Threading.Tasks.Task<ContactGroupsVM> GetListAsync(string subscriptionId, int? skip = null, int? take = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | subscriptionId | |
| System.Nullable<System.Int32> | skip | |
| System.Nullable<System.Int32> | 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<ContactGroupsVM> | Contact groups were found |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
Update(String, UpdateContactGroupVM)
Updates contact group by id
Declaration
ContactGroupVM Update(string id, UpdateContactGroupVM body = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | |
| UpdateContactGroupVM | body |
Returns
| Type | Description |
|---|---|
| ContactGroupVM | Contact group was updated |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
UpdateAsync(String, UpdateContactGroupVM, System.Threading.CancellationToken)
Updates contact group by id
Declaration
System.Threading.Tasks.Task<ContactGroupVM> UpdateAsync(string id, UpdateContactGroupVM body = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | |
| UpdateContactGroupVM | 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<ContactGroupVM> | Contact group was updated |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |