Table of Contents

Class ApizrOptionalMediatorFileTransferExtensions

Namespace
Apizr.Optional.Extending
Assembly
Apizr.Integrations.FileTransfer.Optional.dll

Extensions for file transfer requests with optional result

public static class ApizrOptionalMediatorFileTransferExtensions
Inheritance
ApizrOptionalMediatorFileTransferExtensions
Inherited Members

Methods

SendDownloadOptionalQuery(IApizrOptionalMediator, FileInfo, Action<IApizrRequestOptionsBuilder>)

Send a download query to Apizr using MediatR for IDownloadApi with optional result

public static Task<Option<FileInfo, ApizrException>> SendDownloadOptionalQuery(this IApizrOptionalMediator apizrMediator, FileInfo fileInfo, Action<IApizrRequestOptionsBuilder> optionsBuilder = null)

Parameters

apizrMediator IApizrOptionalMediator

The extended mediator

fileInfo FileInfo

Some information about the file to download

optionsBuilder Action<IApizrRequestOptionsBuilder>

Some request options

Returns

Task<Option<FileInfo, ApizrException>>

SendDownloadOptionalQuery(IApizrOptionalMediator, FileInfo, IDictionary<string, object>, Action<IApizrRequestOptionsBuilder>)

Send a download query to Apizr using MediatR for IDownloadApi with a dictionary query parameters type and optional result

public static Task<Option<FileInfo, ApizrException>> SendDownloadOptionalQuery(this IApizrOptionalMediator apizrMediator, FileInfo fileInfo, IDictionary<string, object> downloadParams, Action<IApizrRequestOptionsBuilder> optionsBuilder = null)

Parameters

apizrMediator IApizrOptionalMediator

The extended mediator

fileInfo FileInfo

Some information about the file to download

downloadParams IDictionary<string, object>

Some custom query parameters

optionsBuilder Action<IApizrRequestOptionsBuilder>

Some request options

Returns

Task<Option<FileInfo, ApizrException>>

SendDownloadOptionalQueryFor<TDownloadApi>(IApizrOptionalMediator, FileInfo, Action<IApizrRequestOptionsBuilder>)

Send a download query to Apizr using MediatR for TDownloadApi with optional result

public static Task<Option<FileInfo, ApizrException>> SendDownloadOptionalQueryFor<TDownloadApi>(this IApizrOptionalMediator apizrMediator, FileInfo fileInfo, Action<IApizrRequestOptionsBuilder> optionsBuilder = null) where TDownloadApi : IDownloadApi

Parameters

apizrMediator IApizrOptionalMediator

The extended mediator

fileInfo FileInfo

Some information about the file to download

optionsBuilder Action<IApizrRequestOptionsBuilder>

Some request options

Returns

Task<Option<FileInfo, ApizrException>>

Type Parameters

TDownloadApi

The download api type

SendDownloadOptionalQueryFor<TDownloadApi>(IApizrOptionalMediator, FileInfo, IDictionary<string, object>, Action<IApizrRequestOptionsBuilder>)

Send a download query to Apizr using MediatR for TDownloadApi with a dictionary query parameters type and optional result

public static Task<Option<FileInfo, ApizrException>> SendDownloadOptionalQueryFor<TDownloadApi>(this IApizrOptionalMediator apizrMediator, FileInfo fileInfo, IDictionary<string, object> downloadParams, Action<IApizrRequestOptionsBuilder> optionsBuilder = null) where TDownloadApi : IDownloadApi

Parameters

apizrMediator IApizrOptionalMediator

The extended mediator

fileInfo FileInfo

Some information about the file to download

downloadParams IDictionary<string, object>

Some custom query parameters

optionsBuilder Action<IApizrRequestOptionsBuilder>

Some request options

Returns

Task<Option<FileInfo, ApizrException>>

Type Parameters

TDownloadApi

The download api type

SendDownloadOptionalQueryFor<TDownloadApi, TDownloadParams>(IApizrOptionalMediator, FileInfo, Action<IApizrRequestOptionsBuilder>)

Send a download query to Apizr using MediatR for TDownloadApi with optional result

public static Task<Option<FileInfo, ApizrException>> SendDownloadOptionalQueryFor<TDownloadApi, TDownloadParams>(this IApizrOptionalMediator apizrMediator, FileInfo fileInfo, Action<IApizrRequestOptionsBuilder> optionsBuilder = null) where TDownloadApi : IDownloadApi<TDownloadParams>

Parameters

apizrMediator IApizrOptionalMediator

The extended mediator

fileInfo FileInfo

Some information about the file to download

optionsBuilder Action<IApizrRequestOptionsBuilder>

Some request options

Returns

Task<Option<FileInfo, ApizrException>>

Type Parameters

TDownloadApi

The download api type

TDownloadParams

The query parameters type

SendDownloadOptionalQueryFor<TDownloadApi, TDownloadParams>(IApizrOptionalMediator, FileInfo, TDownloadParams, Action<IApizrRequestOptionsBuilder>)

Send a download query to Apizr using MediatR for TDownloadApi with a custom query parameters type and optional result

public static Task<Option<FileInfo, ApizrException>> SendDownloadOptionalQueryFor<TDownloadApi, TDownloadParams>(this IApizrOptionalMediator apizrMediator, FileInfo fileInfo, TDownloadParams downloadParams, Action<IApizrRequestOptionsBuilder> optionsBuilder = null) where TDownloadApi : IDownloadApi<TDownloadParams>

Parameters

apizrMediator IApizrOptionalMediator

The extended mediator

fileInfo FileInfo

Some information about the file to download

downloadParams TDownloadParams

Some custom query parameters

optionsBuilder Action<IApizrRequestOptionsBuilder>

Some request options

Returns

Task<Option<FileInfo, ApizrException>>

Type Parameters

TDownloadApi

The download api type

TDownloadParams

The query parameters type

SendDownloadWithOptionalQueryWith<TDownloadParams>(IApizrOptionalMediator, FileInfo, Action<IApizrRequestOptionsBuilder>)

Send a download query to Apizr using MediatR with TDownloadParams and optional result

public static Task<Option<FileInfo, ApizrException>> SendDownloadWithOptionalQueryWith<TDownloadParams>(this IApizrOptionalMediator apizrMediator, FileInfo fileInfo, Action<IApizrRequestOptionsBuilder> optionsBuilder = null)

Parameters

apizrMediator IApizrOptionalMediator

The extended mediator

fileInfo FileInfo

Some information about the file to download

optionsBuilder Action<IApizrRequestOptionsBuilder>

Some request options

Returns

Task<Option<FileInfo, ApizrException>>

Type Parameters

TDownloadParams

The query parameters type

SendDownloadWithOptionalQuery<TDownloadParams>(IApizrOptionalMediator, FileInfo, TDownloadParams, Action<IApizrRequestOptionsBuilder>)

Send a download query to Apizr using MediatR with TDownloadParams and optional result

public static Task<Option<FileInfo, ApizrException>> SendDownloadWithOptionalQuery<TDownloadParams>(this IApizrOptionalMediator apizrMediator, FileInfo fileInfo, TDownloadParams downloadParams, Action<IApizrRequestOptionsBuilder> optionsBuilder = null)

Parameters

apizrMediator IApizrOptionalMediator

The extended mediator

fileInfo FileInfo

Some information about the file to download

downloadParams TDownloadParams

Some custom query parameters

optionsBuilder Action<IApizrRequestOptionsBuilder>

Some request options

Returns

Task<Option<FileInfo, ApizrException>>

Type Parameters

TDownloadParams

The query parameters type

SendUploadOptionalCommand(IApizrOptionalMediator, ByteArrayPart, Action<IApizrRequestOptionsBuilder>)

Send a upload command to Apizr using MediatR for IUploadApi from file bytes data with optional result

public static Task<Option<HttpResponseMessage, ApizrException>> SendUploadOptionalCommand(this IApizrOptionalMediator apizrMediator, ByteArrayPart byteArrayPart, Action<IApizrRequestOptionsBuilder> optionsBuilder = null)

Parameters

apizrMediator IApizrOptionalMediator

The extended mediator

byteArrayPart ByteArrayPart

The file bytes data

optionsBuilder Action<IApizrRequestOptionsBuilder>

Some request options

Returns

Task<Option<HttpResponseMessage, ApizrException>>

SendUploadOptionalCommand(IApizrOptionalMediator, FileInfoPart, Action<IApizrRequestOptionsBuilder>)

Send a upload command to Apizr using MediatR for IUploadApi from file info data with optional result

public static Task<Option<HttpResponseMessage, ApizrException>> SendUploadOptionalCommand(this IApizrOptionalMediator apizrMediator, FileInfoPart fileInfoPart, Action<IApizrRequestOptionsBuilder> optionsBuilder = null)

Parameters

apizrMediator IApizrOptionalMediator

The extended mediator

fileInfoPart FileInfoPart

The file info data

optionsBuilder Action<IApizrRequestOptionsBuilder>

Some request options

Returns

Task<Option<HttpResponseMessage, ApizrException>>

SendUploadOptionalCommand(IApizrOptionalMediator, StreamPart, Action<IApizrRequestOptionsBuilder>)

Send a upload command to Apizr using MediatR for IUploadApi from file stream data with optional result

public static Task<Option<HttpResponseMessage, ApizrException>> SendUploadOptionalCommand(this IApizrOptionalMediator apizrMediator, StreamPart streamPart, Action<IApizrRequestOptionsBuilder> optionsBuilder = null)

Parameters

apizrMediator IApizrOptionalMediator

The extended mediator

streamPart StreamPart

The file stream data

optionsBuilder Action<IApizrRequestOptionsBuilder>

Some request options

Returns

Task<Option<HttpResponseMessage, ApizrException>>

SendUploadOptionalCommandFor<TUploadApi>(IApizrOptionalMediator, ByteArrayPart, Action<IApizrRequestOptionsBuilder>)

Send a upload command to Apizr using MediatR for TUploadApi from file bytes data with optional result

public static Task<Option<HttpResponseMessage, ApizrException>> SendUploadOptionalCommandFor<TUploadApi>(this IApizrOptionalMediator apizrMediator, ByteArrayPart byteArrayPart, Action<IApizrRequestOptionsBuilder> optionsBuilder = null) where TUploadApi : IUploadApi

Parameters

apizrMediator IApizrOptionalMediator

The extended mediator

byteArrayPart ByteArrayPart

The file bytes data

optionsBuilder Action<IApizrRequestOptionsBuilder>

Some request options

Returns

Task<Option<HttpResponseMessage, ApizrException>>

Type Parameters

TUploadApi

The upload api type

SendUploadOptionalCommandFor<TUploadApi>(IApizrOptionalMediator, FileInfoPart, Action<IApizrRequestOptionsBuilder>)

Send a upload command to Apizr using MediatR for TUploadApi from file info data with optional result

public static Task<Option<HttpResponseMessage, ApizrException>> SendUploadOptionalCommandFor<TUploadApi>(this IApizrOptionalMediator apizrMediator, FileInfoPart fileInfoPart, Action<IApizrRequestOptionsBuilder> optionsBuilder = null) where TUploadApi : IUploadApi

Parameters

apizrMediator IApizrOptionalMediator

The extended mediator

fileInfoPart FileInfoPart

The file info data

optionsBuilder Action<IApizrRequestOptionsBuilder>

Some request options

Returns

Task<Option<HttpResponseMessage, ApizrException>>

Type Parameters

TUploadApi

The upload api type

SendUploadOptionalCommandFor<TUploadApi>(IApizrOptionalMediator, StreamPart, Action<IApizrRequestOptionsBuilder>)

Send a upload command to Apizr using MediatR for TUploadApi from file stream data with optional result

public static Task<Option<HttpResponseMessage, ApizrException>> SendUploadOptionalCommandFor<TUploadApi>(this IApizrOptionalMediator apizrMediator, StreamPart streamPart, Action<IApizrRequestOptionsBuilder> optionsBuilder = null) where TUploadApi : IUploadApi

Parameters

apizrMediator IApizrOptionalMediator

The extended mediator

streamPart StreamPart

The file stream data

optionsBuilder Action<IApizrRequestOptionsBuilder>

Some request options

Returns

Task<Option<HttpResponseMessage, ApizrException>>

Type Parameters

TUploadApi

The upload api type

SendUploadOptionalCommandFor<TUploadApi, TUploadApiResultData>(IApizrOptionalMediator, ByteArrayPart, Action<IApizrRequestOptionsBuilder>)

Send a upload command to Apizr using MediatR for TUploadApi from file bytes data with optional result

public static Task<Option<TUploadApiResultData, ApizrException>> SendUploadOptionalCommandFor<TUploadApi, TUploadApiResultData>(this IApizrOptionalMediator apizrMediator, ByteArrayPart byteArrayPart, Action<IApizrRequestOptionsBuilder> optionsBuilder = null) where TUploadApi : IUploadApi<TUploadApiResultData>

Parameters

apizrMediator IApizrOptionalMediator

The extended mediator

byteArrayPart ByteArrayPart

The file bytes data

optionsBuilder Action<IApizrRequestOptionsBuilder>

Some request options

Returns

Task<Option<TUploadApiResultData, ApizrException>>

Type Parameters

TUploadApi

The upload api type

TUploadApiResultData

The upload api result data type

SendUploadOptionalCommandFor<TUploadApi, TUploadApiResultData>(IApizrOptionalMediator, FileInfoPart, Action<IApizrRequestOptionsBuilder>)

Send a upload command to Apizr using MediatR for TUploadApi from file info data with optional result

public static Task<Option<TUploadApiResultData, ApizrException>> SendUploadOptionalCommandFor<TUploadApi, TUploadApiResultData>(this IApizrOptionalMediator apizrMediator, FileInfoPart fileInfoPart, Action<IApizrRequestOptionsBuilder> optionsBuilder = null) where TUploadApi : IUploadApi<TUploadApiResultData>

Parameters

apizrMediator IApizrOptionalMediator

The extended mediator

fileInfoPart FileInfoPart

The file info data

optionsBuilder Action<IApizrRequestOptionsBuilder>

Some request options

Returns

Task<Option<TUploadApiResultData, ApizrException>>

Type Parameters

TUploadApi

The upload api type

TUploadApiResultData

The upload api result data type

SendUploadOptionalCommandFor<TUploadApi, TUploadApiResultData>(IApizrOptionalMediator, StreamPart, Action<IApizrRequestOptionsBuilder>)

Send a upload command to Apizr using MediatR for TUploadApi from file stream data with optional result

public static Task<Option<TUploadApiResultData, ApizrException>> SendUploadOptionalCommandFor<TUploadApi, TUploadApiResultData>(this IApizrOptionalMediator apizrMediator, StreamPart streamPart, Action<IApizrRequestOptionsBuilder> optionsBuilder = null) where TUploadApi : IUploadApi<TUploadApiResultData>

Parameters

apizrMediator IApizrOptionalMediator

The extended mediator

streamPart StreamPart

The file stream data

optionsBuilder Action<IApizrRequestOptionsBuilder>

Some request options

Returns

Task<Option<TUploadApiResultData, ApizrException>>

Type Parameters

TUploadApi

The upload api type

TUploadApiResultData

The upload api result data type

SendUploadWithOptionalCommand<TUploadApiResultData>(IApizrOptionalMediator, ByteArrayPart, Action<IApizrRequestOptionsBuilder>)

Send a upload command to Apizr using MediatR with TUploadApiResultData from file bytes data with optional result

public static Task<Option<TUploadApiResultData, ApizrException>> SendUploadWithOptionalCommand<TUploadApiResultData>(this IApizrOptionalMediator apizrMediator, ByteArrayPart byteArrayPart, Action<IApizrRequestOptionsBuilder> optionsBuilder = null)

Parameters

apizrMediator IApizrOptionalMediator

The extended mediator

byteArrayPart ByteArrayPart

The file bytes data

optionsBuilder Action<IApizrRequestOptionsBuilder>

Some request options

Returns

Task<Option<TUploadApiResultData, ApizrException>>

Type Parameters

TUploadApiResultData

The upload api result data type

SendUploadWithOptionalCommand<TUploadApiResultData>(IApizrOptionalMediator, FileInfoPart, Action<IApizrRequestOptionsBuilder>)

Send a upload command to Apizr using MediatR with TUploadApiResultData from file info data with optional result

public static Task<Option<TUploadApiResultData, ApizrException>> SendUploadWithOptionalCommand<TUploadApiResultData>(this IApizrOptionalMediator apizrMediator, FileInfoPart fileInfoPart, Action<IApizrRequestOptionsBuilder> optionsBuilder = null)

Parameters

apizrMediator IApizrOptionalMediator

The extended mediator

fileInfoPart FileInfoPart

The file info data

optionsBuilder Action<IApizrRequestOptionsBuilder>

Some request options

Returns

Task<Option<TUploadApiResultData, ApizrException>>

Type Parameters

TUploadApiResultData

The upload api result data type

SendUploadWithOptionalCommand<TUploadApiResultData>(IApizrOptionalMediator, StreamPart, Action<IApizrRequestOptionsBuilder>)

Send a upload command to Apizr using MediatR with TUploadApiResultData from file stream data with optional result

public static Task<Option<TUploadApiResultData, ApizrException>> SendUploadWithOptionalCommand<TUploadApiResultData>(this IApizrOptionalMediator apizrMediator, StreamPart streamPart, Action<IApizrRequestOptionsBuilder> optionsBuilder = null)

Parameters

apizrMediator IApizrOptionalMediator

The extended mediator

streamPart StreamPart

The file stream data

optionsBuilder Action<IApizrRequestOptionsBuilder>

Some request options

Returns

Task<Option<TUploadApiResultData, ApizrException>>

Type Parameters

TUploadApiResultData

The upload api result data type