Class FtpApi

Inheritance

System.Object

FtpApi

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Bitmovin.Api.Sdk.Encoding.Outputs.Ftp

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class FtpApi

Constructors

FtpApi(IBitmovinApiClientFactory)

Declaration

public FtpApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of FtpApi

Declaration

public static BitmovinApiBuilder<FtpApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<FtpApi>

Customdata

Declaration

public CustomdataApi Customdata { get; }

Property Value

Type	Description
CustomdataApi

Methods

CreateAsync(FtpOutput)

Create FTP Output

Declaration

public Task<FtpOutput> CreateAsync(FtpOutput ftpOutput)

Parameters

Type	Name	Description
FtpOutput	ftpOutput	The FTP output to be created

Returns

Type	Description
System.Threading.Tasks.Task<FtpOutput>

DeleteAsync(String)

Delete FTP Output

Declaration

public Task<FtpOutput> DeleteAsync(string outputId)

Parameters

Type	Name	Description
System.String	outputId	Id of the output (required)

Returns

Type	Description
System.Threading.Tasks.Task<FtpOutput>

GetAsync(String)

FTP Output Details

Declaration

public Task<FtpOutput> GetAsync(string outputId)

Parameters

Type	Name	Description
System.String	outputId	Id of the output (required)

Returns

Type	Description
System.Threading.Tasks.Task<FtpOutput>

ListAsync(Func<FtpApi.ListQueryParams, FtpApi.ListQueryParams>[])

List FTP Outputs

Declaration

public Task<PaginationResponse<FtpOutput>> ListAsync(params Func<FtpApi.ListQueryParams, FtpApi.ListQueryParams>[] queryParams)

Parameters

Type	Name	Description
System.Func<FtpApi.ListQueryParams, FtpApi.ListQueryParams>[]	queryParams	The query parameters for sorting, filtering and paging options (optional)

Returns

Type	Description
System.Threading.Tasks.Task<PaginationResponse<FtpOutput>>