Interface IContactsClient

Namespace: FastReport.Cloud

Assembly: FastReport.Cloud.SDK.dll

Syntax

public interface IContactsClient

Methods

Create(CreateContactVM)

Creates new contact

Declaration

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

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

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 was deleted

Exceptions

Type	Condition
ApiException	A server side error occurred.

Get(String)

Returns contact group by id

Declaration

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

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

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

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

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

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.

Update(String, UpdateContactVM)

Updates contact by id

Declaration

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

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.