Class ContactsClient
Inheritance
System.Object
ContactsClient
Implements
Namespace: FastReport.Cloud.Client
Assembly: FastReport.Cloud.SDK.dll
Syntax
public class ContactsClient : object, IContactsClientConstructors
ContactsClient(System.Net.Http.HttpClient)
Declaration
public ContactsClient(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 |
ReadResponseAsString
Declaration
public bool ReadResponseAsString { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Methods
Create(CreateContactVM)
Creates new contact
Declaration
public virtual ContactVM Create(CreateContactVM body = null)Parameters
| Type | Name | Description |
|---|---|---|
| CreateContactVM | body |
Returns
| Type | Description |
|---|---|
| ContactVM | Contact was created |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
CreateAsync(CreateContactVM, System.Threading.CancellationToken)
Creates new contact
Declaration
public virtual async System.Threading.Tasks.Task<ContactVM> CreateAsync(CreateContactVM body = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| CreateContactVM | 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<ContactVM> | Contact was created |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
Delete(String)
Removes contact by id
Declaration
public virtual 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
public virtual async 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 was deleted |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
Get(String)
Returns contact group by id
Declaration
public virtual ContactVM Get(string id)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id |
Returns
| Type | Description |
|---|---|
| ContactVM | Contact was found |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetAsync(String, System.Threading.CancellationToken)
Returns contact group by id
Declaration
public virtual async System.Threading.Tasks.Task<ContactVM> 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<ContactVM> | Contact was found |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetByGroup(String, Nullable<Int32>, Nullable<Int32>)
Returns contacts by group id
Declaration
public virtual ContactsVM GetByGroup(string groupId, int? skip = null, int? take = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | groupId | |
| System.Nullable<System.Int32> | skip | |
| System.Nullable<System.Int32> | take |
Returns
| Type | Description |
|---|---|
| ContactsVM | Contacts were found |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetByGroupAsync(String, Nullable<Int32>, Nullable<Int32>, System.Threading.CancellationToken)
Returns contacts by group id
Declaration
public virtual async System.Threading.Tasks.Task<ContactsVM> GetByGroupAsync(string groupId, int? skip = null, int? take = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | groupId | |
| 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<ContactsVM> | Contacts were found |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetList(String, Nullable<Int32>, Nullable<Int32>, String)
Allows to search for contacts
Declaration
public virtual ContactsVM GetList(string subscriptionId, int? skip = null, int? take = null, string searchPattern = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | subscriptionId | |
| System.Nullable<System.Int32> | skip | |
| System.Nullable<System.Int32> | take | |
| System.String | searchPattern |
Returns
| Type | Description |
|---|---|
| ContactsVM | Contacts were found |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetListAsync(String, Nullable<Int32>, Nullable<Int32>, String, System.Threading.CancellationToken)
Allows to search for contacts
Declaration
public virtual async System.Threading.Tasks.Task<ContactsVM> GetListAsync(string subscriptionId, int? skip = null, int? take = null, string searchPattern = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | subscriptionId | |
| System.Nullable<System.Int32> | skip | |
| System.Nullable<System.Int32> | take | |
| System.String | searchPattern | |
| 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<ContactsVM> | Contacts were found |
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<ContactsClient.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<ContactsClient.ObjectResponseResult<T>> |
Type Parameters
| Name | Description |
|---|---|
| T |
Update(String, UpdateContactVM)
Updates contact by id
Declaration
public virtual ContactVM Update(string id, UpdateContactVM body = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | |
| UpdateContactVM | body |
Returns
| Type | Description |
|---|---|
| ContactVM | Contact was updated |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
UpdateAsync(String, UpdateContactVM, System.Threading.CancellationToken)
Updates contact by id
Declaration
public virtual async System.Threading.Tasks.Task<ContactVM> UpdateAsync(string id, UpdateContactVM body = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | |
| UpdateContactVM | 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<ContactVM> | Contact was updated |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |