Class FinishedApi

Inheritance

System.Object

FinishedApi

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.Notifications.Webhooks.Encoding.Encodings.Finished

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class FinishedApi

Constructors

FinishedApi(IBitmovinApiClientFactory)

Declaration

public FinishedApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of FinishedApi

Declaration

public static BitmovinApiBuilder<FinishedApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<FinishedApi>

Customdata

Declaration

public CustomdataApi Customdata { get; }

Property Value

Type	Description
CustomdataApi

Methods

CreateAsync(Webhook)

Add 'Encoding Finished' Webhook

Declaration

public Task<Webhook> CreateAsync(Webhook webhook)

Parameters

Type	Name	Description
Webhook	webhook	The 'Encoding Finished' Webhook to be added. A maximum number of 5 webhooks is allowed

Returns

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

CreateByEncodingIdAsync(String, Webhook)

Add 'Encoding Finished' Webhook for a specific Encoding

Declaration

public Task<Webhook> CreateByEncodingIdAsync(string encodingId, Webhook webhook)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding (required)
Webhook	webhook	The 'Encoding Finished' Webhook to be added. A maximum number of 5 webhooks per Encoding is allowed

Returns

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

DeleteByEncodingIdAndWebhookIdAsync(String, String)

Delete 'Encoding Finished' Webhook for a specific Encoding

Declaration

public Task<BitmovinResponse> DeleteByEncodingIdAndWebhookIdAsync(string encodingId, string webhookId)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding (required)
System.String	webhookId	Id of the webhook (required)

Returns

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

DeleteByWebhookIdAsync(String)

Delete 'Encoding Finished' Webhook

Declaration

public Task<BitmovinResponse> DeleteByWebhookIdAsync(string webhookId)

Parameters

Type	Name	Description
System.String	webhookId	Id of the webhook (required)

Returns

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

GetByEncodingIdAndWebhookIdAsync(String, String)

'Encoding Finished' Webhook Details for a specific Encoding

Declaration

public Task<Webhook> GetByEncodingIdAndWebhookIdAsync(string encodingId, string webhookId)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding (required)
System.String	webhookId	Id of the webhook (required)

Returns

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

GetByWebhookIdAsync(String)

'Encoding Finished' Webhook Details

Declaration

public Task<Webhook> GetByWebhookIdAsync(string webhookId)

Parameters

Type	Name	Description
System.String	webhookId	Id of the webhook (required)

Returns

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

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

List 'Encoding Finished' Webhooks

Declaration

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

Parameters

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

Returns

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

ListByEncodingIdAsync(String, Func<FinishedApi.ListByEncodingIdQueryParams, FinishedApi.ListByEncodingIdQueryParams>[])

List 'Encoding Finished' Webhooks for a specific Encoding

Declaration

public Task<PaginationResponse<Webhook>> ListByEncodingIdAsync(string encodingId, params Func<FinishedApi.ListByEncodingIdQueryParams, FinishedApi.ListByEncodingIdQueryParams>[] queryParams)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding (required)
System.Func<FinishedApi.ListByEncodingIdQueryParams, FinishedApi.ListByEncodingIdQueryParams>[]	queryParams	The query parameters for sorting, filtering and paging options (optional)

Returns

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