Class FileTransferOptionsBuilderExtensions

Namespace

Apizr

Assembly

Apizr.Integrations.FileTransfer.dll

File transfer builder extensions

public static class FileTransferOptionsBuilderExtensions

Inheritance

object

FileTransferOptionsBuilderExtensions

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Methods

AddDownloadManager(IApizrRegistryBuilder, Action<IApizrProperOptionsBuilder>)

Add a download manager for IDownloadApi

public static IApizrRegistryBuilder AddDownloadManager(this IApizrRegistryBuilder builder, Action<IApizrProperOptionsBuilder> optionsBuilder = null)

Parameters

builder IApizrRegistryBuilder

The builder to create the manager from

optionsBuilder Action<IApizrProperOptionsBuilder>

The builder defining some options

Returns

IApizrRegistryBuilder

AddDownloadManagerFor<TDownloadApi>(IApizrRegistryBuilder, Action<IApizrProperOptionsBuilder>)

Add a download manager for the provided download api derived from IDownloadApi

public static IApizrRegistryBuilder AddDownloadManagerFor<TDownloadApi>(this IApizrRegistryBuilder builder, Action<IApizrProperOptionsBuilder> optionsBuilder = null) where TDownloadApi : IDownloadApi<IDictionary<string, object>>

Parameters

builder IApizrRegistryBuilder

The builder to create the manager from

optionsBuilder Action<IApizrProperOptionsBuilder>

The builder defining some options

Returns

IApizrRegistryBuilder

Type Parameters

TDownloadApi

The download api interface to manage

AddDownloadManagerFor<TDownloadApi, TDownloadParams>(IApizrRegistryBuilder, Action<IApizrProperOptionsBuilder>)

Add a download manager for the provided download api derived from IDownloadApi{TDownloadParams}

public static IApizrRegistryBuilder AddDownloadManagerFor<TDownloadApi, TDownloadParams>(this IApizrRegistryBuilder builder, Action<IApizrProperOptionsBuilder> optionsBuilder = null) where TDownloadApi : IDownloadApi<TDownloadParams>

Parameters

builder IApizrRegistryBuilder

The builder to create the manager from

optionsBuilder Action<IApizrProperOptionsBuilder>

The builder defining some options

Returns

IApizrRegistryBuilder

Type Parameters

TDownloadApi

The download api interface to manage

TDownloadParams

The download query parameters type

AddDownloadManagerWith<TDownloadParams>(IApizrRegistryBuilder, Action<IApizrProperOptionsBuilder>)

Add a download manager for the built-in download api with TDownloadParams

public static IApizrRegistryBuilder AddDownloadManagerWith<TDownloadParams>(this IApizrRegistryBuilder builder, Action<IApizrProperOptionsBuilder> optionsBuilder = null)

Parameters

builder IApizrRegistryBuilder

The builder to create the manager from

optionsBuilder Action<IApizrProperOptionsBuilder>

The builder defining some options

Returns

IApizrRegistryBuilder

Type Parameters

TDownloadParams

The download query parameters type

AddTransferManager(IApizrRegistryBuilder, Action<IApizrProperOptionsBuilder>)

Add a transfer manager for ITransferApi

public static IApizrRegistryBuilder AddTransferManager(this IApizrRegistryBuilder builder, Action<IApizrProperOptionsBuilder> optionsBuilder = null)

Parameters

builder IApizrRegistryBuilder

The builder to create the manager from

optionsBuilder Action<IApizrProperOptionsBuilder>

The builder defining some options

Returns

IApizrRegistryBuilder

AddTransferManagerFor<TTransferApi>(IApizrRegistryBuilder, Action<IApizrProperOptionsBuilder>)

Add a transfer manager for the provided transfer api derived from ITransferApi

public static IApizrRegistryBuilder AddTransferManagerFor<TTransferApi>(this IApizrRegistryBuilder builder, Action<IApizrProperOptionsBuilder> optionsBuilder = null) where TTransferApi : ITransferApi<IDictionary<string, object>, HttpResponseMessage>

Parameters

builder IApizrRegistryBuilder

The builder to create the manager from

optionsBuilder Action<IApizrProperOptionsBuilder>

The builder defining some options

Returns

IApizrRegistryBuilder

Type Parameters

TTransferApi

The transfer api interface to manage

AddTransferManagerFor<TTransferApi, TDownloadParams>(IApizrRegistryBuilder, Action<IApizrProperOptionsBuilder>)

Add a transfer manager for the provided transfer api derived from ITransferApi{TDownloadParams}

public static IApizrRegistryBuilder AddTransferManagerFor<TTransferApi, TDownloadParams>(this IApizrRegistryBuilder builder, Action<IApizrProperOptionsBuilder> optionsBuilder = null) where TTransferApi : ITransferApi<TDownloadParams, HttpResponseMessage>

Parameters

builder IApizrRegistryBuilder

The builder to create the manager from

optionsBuilder Action<IApizrProperOptionsBuilder>

The builder defining some options

Returns

IApizrRegistryBuilder

Type Parameters

TTransferApi

The transfer api interface to manage

TDownloadParams

The download query parameters type

AddTransferManagerFor<TTransferApi, TDownloadParams, TUploadApiResultData>(IApizrRegistryBuilder, Action<IApizrProperOptionsBuilder>)

Add a transfer manager for the provided transfer api derived from ITransferApi{TDownloadParams}

public static IApizrRegistryBuilder AddTransferManagerFor<TTransferApi, TDownloadParams, TUploadApiResultData>(this IApizrRegistryBuilder builder, Action<IApizrProperOptionsBuilder> optionsBuilder = null) where TTransferApi : ITransferApi<TDownloadParams, TUploadApiResultData>

Parameters

builder IApizrRegistryBuilder

The builder to create the manager from

optionsBuilder Action<IApizrProperOptionsBuilder>

The builder defining some options

Returns

IApizrRegistryBuilder

Type Parameters

TTransferApi

The transfer api interface to manage

TDownloadParams

The download query parameters type

TUploadApiResultData

The upload api return type

AddTransferManagerWith<TDownloadParams, TUploadApiResultData>(IApizrRegistryBuilder, Action<IApizrProperOptionsBuilder>)

Add a transfer manager for the built-in transfer api with TDownloadParams and TUploadApiResultData

public static IApizrRegistryBuilder AddTransferManagerWith<TDownloadParams, TUploadApiResultData>(this IApizrRegistryBuilder builder, Action<IApizrProperOptionsBuilder> optionsBuilder = null)

Parameters

builder IApizrRegistryBuilder

The builder to create the manager from

optionsBuilder Action<IApizrProperOptionsBuilder>

The builder defining some options

Returns

IApizrRegistryBuilder

Type Parameters

TDownloadParams

The download query parameters type

TUploadApiResultData

The upload api return type

AddUploadManager(IApizrRegistryBuilder, Action<IApizrProperOptionsBuilder>)

Add an upload manager for IUploadApi

public static IApizrRegistryBuilder AddUploadManager(this IApizrRegistryBuilder builder, Action<IApizrProperOptionsBuilder> optionsBuilder = null)

Parameters

builder IApizrRegistryBuilder

The builder to create the manager from

optionsBuilder Action<IApizrProperOptionsBuilder>

The builder defining some options

Returns

IApizrRegistryBuilder

AddUploadManagerFor<TUploadApi>(IApizrRegistryBuilder, Action<IApizrProperOptionsBuilder>)

Add an upload manager for the provided upload api derived from IUploadApi

public static IApizrRegistryBuilder AddUploadManagerFor<TUploadApi>(this IApizrRegistryBuilder builder, Action<IApizrProperOptionsBuilder> optionsBuilder = null) where TUploadApi : IUploadApi<HttpResponseMessage>

Parameters

builder IApizrRegistryBuilder

The builder to create the manager from

optionsBuilder Action<IApizrProperOptionsBuilder>

The builder defining some options

Returns

IApizrRegistryBuilder

Type Parameters

TUploadApi

The upload api interface to manage

AddUploadManagerFor<TUploadApi, TUploadApiResultData>(IApizrRegistryBuilder, Action<IApizrProperOptionsBuilder>)

Add an upload manager for the provided upload api derived from IUploadApi

public static IApizrRegistryBuilder AddUploadManagerFor<TUploadApi, TUploadApiResultData>(this IApizrRegistryBuilder builder, Action<IApizrProperOptionsBuilder> optionsBuilder = null) where TUploadApi : IUploadApi<TUploadApiResultData>

Parameters

builder IApizrRegistryBuilder

The builder to create the manager from

optionsBuilder Action<IApizrProperOptionsBuilder>

The builder defining some options

Returns

IApizrRegistryBuilder

Type Parameters

TUploadApi

The upload api interface to manage

TUploadApiResultData

The upload api return type

AddUploadManagerWith<TUploadApiResultData>(IApizrRegistryBuilder, Action<IApizrProperOptionsBuilder>)

Add an upload manager for the built-in upload api with TUploadApiResultData

public static IApizrRegistryBuilder AddUploadManagerWith<TUploadApiResultData>(this IApizrRegistryBuilder builder, Action<IApizrProperOptionsBuilder> optionsBuilder = null)

Parameters

builder IApizrRegistryBuilder

The builder to create the manager from

optionsBuilder Action<IApizrProperOptionsBuilder>

The builder defining some options

Returns

IApizrRegistryBuilder

Type Parameters

TUploadApiResultData

The upload api return type

CreateDownloadManager(IApizrBuilder, Action<IApizrManagerOptionsBuilder>)

Create a download manager for IDownloadApi (you must at least provide a base url thanks to the options builder)

public static IApizrDownloadManager CreateDownloadManager(this IApizrBuilder builder, Action<IApizrManagerOptionsBuilder> optionsBuilder = null)

Parameters

builder IApizrBuilder

The builder to create the manager from

optionsBuilder Action<IApizrManagerOptionsBuilder>

The builder defining some options

Returns

IApizrDownloadManager

CreateDownloadManagerFor<TDownloadApi>(IApizrBuilder, Action<IApizrManagerOptionsBuilder>)

Create a download manager for the provided download api derived from IDownloadApi

public static IApizrDownloadManager<TDownloadApi> CreateDownloadManagerFor<TDownloadApi>(this IApizrBuilder builder, Action<IApizrManagerOptionsBuilder> optionsBuilder = null) where TDownloadApi : IDownloadApi<IDictionary<string, object>>

Parameters

builder IApizrBuilder

The builder to create the manager from

optionsBuilder Action<IApizrManagerOptionsBuilder>

The builder defining some options

Returns

IApizrDownloadManager<TDownloadApi>

Type Parameters

TDownloadApi

The download api interface to manage

CreateDownloadManagerFor<TDownloadApi, TDownloadParams>(IApizrBuilder, Action<IApizrManagerOptionsBuilder>)

Create a download manager for the provided download api derived from IDownloadApi{TDownloadParams}

public static IApizrDownloadManager<TDownloadApi, TDownloadParams> CreateDownloadManagerFor<TDownloadApi, TDownloadParams>(this IApizrBuilder builder, Action<IApizrManagerOptionsBuilder> optionsBuilder = null) where TDownloadApi : IDownloadApi<TDownloadParams>

Parameters

builder IApizrBuilder

The builder to create the manager from

optionsBuilder Action<IApizrManagerOptionsBuilder>

The builder defining some options

Returns

IApizrDownloadManager<TDownloadApi, TDownloadParams>

Type Parameters

TDownloadApi

The download api interface to manage

TDownloadParams

The download query parameters type

CreateDownloadManagerWith<TDownloadParams>(IApizrBuilder, Action<IApizrManagerOptionsBuilder>)

Create a download manager for the built-in download api with TDownloadParams

public static IApizrDownloadManagerWith<TDownloadParams> CreateDownloadManagerWith<TDownloadParams>(this IApizrBuilder builder, Action<IApizrManagerOptionsBuilder> optionsBuilder = null)

Parameters

builder IApizrBuilder

The builder to create the manager from

optionsBuilder Action<IApizrManagerOptionsBuilder>

The builder defining some options

Returns

IApizrDownloadManagerWith<TDownloadParams>

Type Parameters

TDownloadParams

The download query parameters type

CreateTransferManager(IApizrBuilder, Action<IApizrManagerOptionsBuilder>)

Create a transfer manager for ITransferApi (you must at least provide a base url thanks to the options builder)

public static IApizrTransferManager CreateTransferManager(this IApizrBuilder builder, Action<IApizrManagerOptionsBuilder> optionsBuilder = null)

Parameters

builder IApizrBuilder

The builder to create the manager from

optionsBuilder Action<IApizrManagerOptionsBuilder>

The builder defining some options

Returns

IApizrTransferManager

CreateTransferManagerFor<TTransferApi>(IApizrBuilder, Action<IApizrManagerOptionsBuilder>)

Create a transfer manager for the provided transfer api derived from ITransferApi

public static IApizrTransferManager<TTransferApi> CreateTransferManagerFor<TTransferApi>(this IApizrBuilder builder, Action<IApizrManagerOptionsBuilder> optionsBuilder = null) where TTransferApi : ITransferApi<IDictionary<string, object>, HttpResponseMessage>

Parameters

builder IApizrBuilder

The builder to create the manager from

optionsBuilder Action<IApizrManagerOptionsBuilder>

The builder defining some options

Returns

IApizrTransferManager<TTransferApi>

Type Parameters

TTransferApi

The transfer api interface to manage

CreateTransferManagerFor<TTransferApi, TDownloadParams>(IApizrBuilder, Action<IApizrManagerOptionsBuilder>)

Create a transfer manager for the provided transfer api derived from ITransferApi{TDownloadParams}

public static IApizrTransferManager<TTransferApi, TDownloadParams> CreateTransferManagerFor<TTransferApi, TDownloadParams>(this IApizrBuilder builder, Action<IApizrManagerOptionsBuilder> optionsBuilder = null) where TTransferApi : ITransferApi<TDownloadParams, HttpResponseMessage>

Parameters

builder IApizrBuilder

The builder to create the manager from

optionsBuilder Action<IApizrManagerOptionsBuilder>

The builder defining some options

Returns

IApizrTransferManager<TTransferApi, TDownloadParams>

Type Parameters

TTransferApi

The transfer api interface to manage

TDownloadParams

The download query parameters type

CreateTransferManagerFor<TTransferApi, TDownloadParams, TUploadApiResultData>(IApizrBuilder, Action<IApizrManagerOptionsBuilder>)

Create a transfer manager for the provided transfer api derived from ITransferApi{TDownloadParams}

public static IApizrTransferManager<TTransferApi, TDownloadParams, TUploadApiResultData> CreateTransferManagerFor<TTransferApi, TDownloadParams, TUploadApiResultData>(this IApizrBuilder builder, Action<IApizrManagerOptionsBuilder> optionsBuilder = null) where TTransferApi : ITransferApi<TDownloadParams, TUploadApiResultData>

Parameters

builder IApizrBuilder

The builder to create the manager from

optionsBuilder Action<IApizrManagerOptionsBuilder>

The builder defining some options

Returns

IApizrTransferManager<TTransferApi, TDownloadParams, TUploadApiResultData>

Type Parameters

TTransferApi

The transfer api interface to manage

TDownloadParams

The download query parameters type

TUploadApiResultData

The upload api result type

CreateTransferManagerWith<TDownloadParams, TUploadApiResultData>(IApizrBuilder, Action<IApizrManagerOptionsBuilder>)

Create a transfer manager for the built-in transfer api with TDownloadParams and TUploadApiResultData

public static IApizrTransferManagerWith<TDownloadParams, TUploadApiResultData> CreateTransferManagerWith<TDownloadParams, TUploadApiResultData>(this IApizrBuilder builder, Action<IApizrManagerOptionsBuilder> optionsBuilder = null)

Parameters

builder IApizrBuilder

The builder to create the manager from

optionsBuilder Action<IApizrManagerOptionsBuilder>

The builder defining some options

Returns

IApizrTransferManagerWith<TDownloadParams, TUploadApiResultData>

Type Parameters

TDownloadParams

The download query parameters type

TUploadApiResultData

The upload api result type

CreateUploadManager(IApizrBuilder, Action<IApizrManagerOptionsBuilder>)

Create an upload manager for IUploadApi (you must at least provide a base url thanks to the options builder)

public static IApizrUploadManager CreateUploadManager(this IApizrBuilder builder, Action<IApizrManagerOptionsBuilder> optionsBuilder)

Parameters

builder IApizrBuilder

The builder to create the manager from

optionsBuilder Action<IApizrManagerOptionsBuilder>

The builder defining some options

Returns

IApizrUploadManager

CreateUploadManagerFor<TUploadApi>(IApizrBuilder, Action<IApizrManagerOptionsBuilder>)

Create an upload manager for the provided upload api derived from IUploadApi

public static IApizrUploadManager<TUploadApi> CreateUploadManagerFor<TUploadApi>(this IApizrBuilder builder, Action<IApizrManagerOptionsBuilder> optionsBuilder = null) where TUploadApi : IUploadApi<HttpResponseMessage>

Parameters

builder IApizrBuilder

The builder to create the manager from

optionsBuilder Action<IApizrManagerOptionsBuilder>

The builder defining some options

Returns

IApizrUploadManager<TUploadApi>

Type Parameters

TUploadApi

The upload api interface to manage

CreateUploadManagerFor<TUploadApi, TUploadApiResultData>(IApizrBuilder, Action<IApizrManagerOptionsBuilder>)

Create an upload manager for the provided upload api derived from IUploadApi

public static IApizrUploadManager<TUploadApi, TUploadApiResultData> CreateUploadManagerFor<TUploadApi, TUploadApiResultData>(this IApizrBuilder builder, Action<IApizrManagerOptionsBuilder> optionsBuilder = null) where TUploadApi : IUploadApi<TUploadApiResultData>

Parameters

builder IApizrBuilder

The builder to create the manager from

optionsBuilder Action<IApizrManagerOptionsBuilder>

The builder defining some options

Returns

IApizrUploadManager<TUploadApi, TUploadApiResultData>

Type Parameters

TUploadApi

The upload api interface to manage

TUploadApiResultData

The upload api result type

CreateUploadManagerWith<TUploadApiResultData>(IApizrBuilder, Action<IApizrManagerOptionsBuilder>)

Create an upload manager for the built-in upload api with TUploadApiResultData

public static IApizrUploadManagerWith<TUploadApiResultData> CreateUploadManagerWith<TUploadApiResultData>(this IApizrBuilder builder, Action<IApizrManagerOptionsBuilder> optionsBuilder = null)

Parameters

builder IApizrBuilder

The builder to create the manager from

optionsBuilder Action<IApizrManagerOptionsBuilder>

The builder defining some options

Returns

IApizrUploadManagerWith<TUploadApiResultData>

Type Parameters

TUploadApiResultData

The upload api result type

WithDynamicPath<T>(T, string)

Tells Apizr to set the ending of the request uri with the provided path

public static T WithDynamicPath<T>(this T builder, string dynamicPath) where T : IApizrRequestOptionsBuilderBase

Parameters

builder T

dynamicPath string

The path ending the request uri

Returns

T

Type Parameters

T

WithProgress<TBuilder>(TBuilder)

Enables transfer progress reporting with Apizr (you should provide a progress callback or reporter at request time)

public static TBuilder WithProgress<TBuilder>(this TBuilder builder) where TBuilder : IApizrGlobalSharedOptionsBuilderBase

Parameters

builder TBuilder

Returns

TBuilder

Type Parameters

TBuilder

WithProgress<TBuilder>(TBuilder, IApizrProgress)

Tells Apizr to report any transfer progress

public static TBuilder WithProgress<TBuilder>(this TBuilder builder, IApizrProgress progress) where TBuilder : IApizrGlobalSharedOptionsBuilderBase

Parameters

builder TBuilder

progress IApizrProgress

The progress reporter

Returns

TBuilder

Type Parameters

TBuilder

WithProgress<TBuilder>(TBuilder, Action<ApizrProgressEventArgs>)

Tells Apizr to report any transfer progress

public static TBuilder WithProgress<TBuilder>(this TBuilder builder, Action<ApizrProgressEventArgs> onProgress) where TBuilder : IApizrGlobalSharedOptionsBuilderBase

Parameters

builder TBuilder

onProgress Action<ApizrProgressEventArgs>

The action called back on any progress

Returns

TBuilder

Type Parameters

TBuilder