EtherFaxClient Class
A full-featured class library that simplifies programming with etherFAX.
public class EtherFaxClientCONSTRUCTORS
| Name | Description | |
|---|---|---|
| :small_blue_diamond: | EtherFaxClient() | Initializes a new instance of the EtherFaxClient class. |
| :small_blue_diamond: | EtherFaxClient(string *apikey*) | Initializes a new instance of the EtheFaxClient class and sets the *apikey* for authorization. |
| :small_blue_diamond: | EtherFaxClient(string *user*, string *password*) | Initializes a new instance of the EtherFaxClient class and sets the username and password used for authorization. |
| :small_blue_diamond: | EtherFaxClient(HttpClientHandler *handler*) | Initializes a new instance of the EtherFaxClient class and specifies the HttpClientHandler to be used as a proxy. |
PROPERTIES
| Name | Description | |
|---|---|---|
| :fa-file-text-o: | Logger | Gets/sets the ILogger used for error logging. |
| :fa-file-text-o: | ServiceAddress | Gets/sets the current service base address. |
| :fa-file-text-o: | StatusCode | Returns the HTTP status code of the last operation. |
| :fa-file-text-o: | Timeout | Gets/sets the web client timeout. If unspecified, the default HTTP client timeout is used. |
| :fa-file-text-o: | Version | Gets/sets the rest API version (the default value is 3). |
METHODS
| Name | Description | |
|---|---|---|
| :small_blue_diamond: | GetFax(Guid *jobId*) GetFaxAsync(Guid *jobId*) | Gets (downloads) the specified fax id including the fax image. |
| :small_blue_diamond: | GetFaxAccount() GetFaxAccountAsync() | Returns information about the current account. |
| :small_blue_diamond: | GetFaxStatus(Guid *jobId*) GetFaxStatusAsync(Guid *jobId*) | Get fax status for single job id. |
| :small_blue_diamond: |
GetFaxStatus(List |
Get fax status for multiple job ids at once. |
| :small_blue_diamond: | GetNextUnreadFax(bool *download*) GetNextUnreadFaxAsync(bool *download*) | Gets (downloads) the next available fax waiting on the service. |
| :small_blue_diamond: | GetPendingFaxes() GetPendingFaxesAsync() | Returns the number of pending faxes for this account. |
| :small_blue_diamond: | GetRouteInfo(string *route*) GetRouteInfoAsync(string *route*) | Returns information for the specified route/number. |
| :small_blue_diamond: | GetUnreadFaxCount() GetUnreadFaxCountAsync() | Returns the number of unread faxes for this account. |
| :small_blue_diamond: | GetUnreadFaxList(int *count*) GetUnreadFaxListAsync(int *count*) | Returns a list of unread faxes (information only) up to count. If count is 0, all unread faxes are returned. |
| :small_blue_diamond: | SendFax(FaxSend *fax*) SendFaxAsync(FaxSend *fax*) | Sends the fax to the etherFAX service and returns the result to the caller. |
| :small_blue_diamond: | SetCredentials(string *apikey*) | Sets the credentials using an api-key, authorization token. |
| :small_blue_diamond: | SetCredentials(string *user*, string *password*) | Sets the credentials using a user name + password. |
| :small_blue_diamond: | SetFaxReceived(Guid *jobId*, FaxResult? *result*) SetFaxReceivedAsync(Guid *jobId*, FaxResult? *result*) | Sets/marks the specified fax as received, with an optional final status for in-network faxes (SEN). |
| :small_blue_diamond: | SetPublicKey(string *pkinfo*) SetPublicKeyAsync(string *pkinfo*) | Uploads the public key contents (PEM format) to the account. |
| :small_blue_diamond: | StartPushListener() StartPushListenerAsync() | Starts the push notification listener service. |
| :small_blue_diamond: | StopPushListener() StopPushListenerAsync() | Stops the push listener and disposes push related resources. |
Updated about 1 month ago