Class IxcNetService

Namespace

IxcNet.Services

Assembly

IxcNet.dll

Serviço principal para interação com a API do IXC. Esta é uma classe parcial que contém os métodos core, de listagem e inserção.

public class IxcNetService

Inheritance

object

IxcNetService

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

IxcNetService(ILogger<IxcNetService>?)

Inicializa uma nova instância da classe IxcNetService.

public IxcNetService(ILogger<IxcNetService>? logger = null)

Parameters

logger ILogger<IxcNetService>

Opcional: Instância de logger para monitoramento.

IxcNetService(HttpClient, ILogger<IxcNetService>?)

Inicializa uma nova instância da classe IxcNetService com um HttpClient customizado.

public IxcNetService(HttpClient http, ILogger<IxcNetService>? logger = null)

Parameters

http HttpClient

A instância de HttpClient a ser utilizada.

logger ILogger<IxcNetService>

Opcional: Instância de logger para monitoramento.

Methods

Inserir<T>(T)

Insere um novo registro de um determinado modelo na API do IXC.

public Task<HttpStatusCode> Inserir<T>(T model) where T : INamedModel

Parameters

model T

O objeto do modelo a ser inserido.

Returns

Task<HttpStatusCode>

O HttpStatusCode retornado pela API.

Type Parameters

T

O tipo do modelo que deve implementar INamedModel.

Listar<T>(QueryBuilder)

Lista registros de um determinado modelo na API do IXC.

public Task<List<T>?> Listar<T>(QueryBuilder query) where T : INamedModel, new()

Parameters

query QueryBuilder

O objeto QueryBuilder contendo os filtros, ordenação e limite.

Returns

Task<List<T>>

Uma lista de objetos do tipo T, ou null em caso de erro.

Type Parameters

T

O tipo do modelo que deve implementar INamedModel e ter um construtor sem parâmetros.

Setup(string, string)

Configura as credenciais e o endereço base para as requisições à API do IXCSoft.

public void Setup(string host, string token)

Parameters

host string

O endereço do host do webservice (ex: provedor.ixcsoft.com.br).

token string

O token de API utilizado para autenticação Basic.