Class ExportControllerApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

ExportControllerApi

Implements

IExportControllerApi

IExportControllerApiSync

IExportControllerApiAsync

IApiAccessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public class ExportControllerApi : IExportControllerApi, IExportControllerApiSync, IExportControllerApiAsync, IApiAccessor

Constructors

View Source

ExportControllerApi()

Initializes a new instance of the ExportControllerApi class.

Declaration

public ExportControllerApi()

View Source

ExportControllerApi(Configuration)

Initializes a new instance of the ExportControllerApi class using Configuration object

Declaration

public ExportControllerApi(Configuration configuration)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

View Source

ExportControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

Initializes a new instance of the ExportControllerApi class using a Configuration object and client instance.

Declaration

public ExportControllerApi(ISynchronousClient client, IAsynchronousClient asyncClient, IReadableConfiguration configuration)

Parameters

Type	Name	Description
ISynchronousClient	client	The client interface for synchronous API access.
IAsynchronousClient	asyncClient	The client interface for asynchronous API access.
IReadableConfiguration	configuration	The configuration object.

View Source

ExportControllerApi(string)

Initializes a new instance of the ExportControllerApi class.

Declaration

public ExportControllerApi(string basePath)

Parameters

Type	Name	Description
string	basePath

Properties

View Source

AsynchronousClient

The client for accessing this underlying API asynchronously.

Declaration

public IAsynchronousClient AsynchronousClient { get; set; }

Property Value

Type	Description
IAsynchronousClient

View Source

Client

The client for accessing this underlying API synchronously.

Declaration

public ISynchronousClient Client { get; set; }

Property Value

Type	Description
ISynchronousClient

View Source

Configuration

Gets or sets the configuration object

Declaration

public IReadableConfiguration Configuration { get; set; }

Property Value

Type	Description
IReadableConfiguration	An instance of the Configuration

View Source

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
ExceptionFactory

Methods

View Source

ExportEntities(string, string, string, string, string, bool?, DateTime?, DateTime?, int)

Export inboxes link callable via browser

Declaration

public byte[] ExportEntities(string exportType, string apiKey, string outputFormat, string filter = null, string listSeparatorToken = null, bool? excludePreviouslyExported = null, DateTime? createdEarliestTime = null, DateTime? createdOldestTime = null, int operationIndex = 0)

Parameters

Type	Name	Description
string	exportType
string	apiKey
string	outputFormat
string	filter	(optional)
string	listSeparatorToken	(optional)
bool?	excludePreviouslyExported	(optional)
DateTime?	createdEarliestTime	(optional)
DateTime?	createdOldestTime	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
byte[]	byte[]

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

ExportEntitiesAsync(string, string, string, string, string, bool?, DateTime?, DateTime?, int, CancellationToken)

Export inboxes link callable via browser

Declaration

public Task<byte[]> ExportEntitiesAsync(string exportType, string apiKey, string outputFormat, string filter = null, string listSeparatorToken = null, bool? excludePreviouslyExported = null, DateTime? createdEarliestTime = null, DateTime? createdOldestTime = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	exportType
string	apiKey
string	outputFormat
string	filter	(optional)
string	listSeparatorToken	(optional)
bool?	excludePreviouslyExported	(optional)
DateTime?	createdEarliestTime	(optional)
DateTime?	createdOldestTime	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<byte[]>	Task of byte[]

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

ExportEntitiesWithHttpInfo(string, string, string, string, string, bool?, DateTime?, DateTime?, int)

Export inboxes link callable via browser

Declaration

public ApiResponse<byte[]> ExportEntitiesWithHttpInfo(string exportType, string apiKey, string outputFormat, string filter = null, string listSeparatorToken = null, bool? excludePreviouslyExported = null, DateTime? createdEarliestTime = null, DateTime? createdOldestTime = null, int operationIndex = 0)

Parameters

Type	Name	Description
string	exportType
string	apiKey
string	outputFormat
string	filter	(optional)
string	listSeparatorToken	(optional)
bool?	excludePreviouslyExported	(optional)
DateTime?	createdEarliestTime	(optional)
DateTime?	createdOldestTime	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<byte[]>	ApiResponse of byte[]

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

ExportEntitiesWithHttpInfoAsync(string, string, string, string, string, bool?, DateTime?, DateTime?, int, CancellationToken)

Export inboxes link callable via browser

Declaration

public Task<ApiResponse<byte[]>> ExportEntitiesWithHttpInfoAsync(string exportType, string apiKey, string outputFormat, string filter = null, string listSeparatorToken = null, bool? excludePreviouslyExported = null, DateTime? createdEarliestTime = null, DateTime? createdOldestTime = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	exportType
string	apiKey
string	outputFormat
string	filter	(optional)
string	listSeparatorToken	(optional)
bool?	excludePreviouslyExported	(optional)
DateTime?	createdEarliestTime	(optional)
DateTime?	createdOldestTime	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<byte[]>>	Task of ApiResponse (byte[])

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

View Source

GetExportLink(string, ExportOptions, string, int)

Get export link

Declaration

public ExportLink GetExportLink(string exportType, ExportOptions exportOptions, string apiKey = null, int operationIndex = 0)

Parameters

Type	Name	Description
string	exportType
ExportOptions	exportOptions
string	apiKey	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ExportLink	ExportLink

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetExportLinkAsync(string, ExportOptions, string, int, CancellationToken)

Get export link

Declaration

public Task<ExportLink> GetExportLinkAsync(string exportType, ExportOptions exportOptions, string apiKey = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	exportType
ExportOptions	exportOptions
string	apiKey	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ExportLink>	Task of ExportLink

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetExportLinkWithHttpInfo(string, ExportOptions, string, int)

Get export link

Declaration

public ApiResponse<ExportLink> GetExportLinkWithHttpInfo(string exportType, ExportOptions exportOptions, string apiKey = null, int operationIndex = 0)

Parameters

Type	Name	Description
string	exportType
ExportOptions	exportOptions
string	apiKey	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<ExportLink>	ApiResponse of ExportLink

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetExportLinkWithHttpInfoAsync(string, ExportOptions, string, int, CancellationToken)

Get export link

Declaration

public Task<ApiResponse<ExportLink>> GetExportLinkWithHttpInfoAsync(string exportType, ExportOptions exportOptions, string apiKey = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	exportType
ExportOptions	exportOptions
string	apiKey	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<ExportLink>>	Task of ApiResponse (ExportLink)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

Implements

IExportControllerApi

IExportControllerApiSync

IExportControllerApiAsync

IApiAccessor