Class ErrorApi

Inheritance

System.Object

ErrorApi

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.Error

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class ErrorApi

Constructors

ErrorApi(IBitmovinApiClientFactory)

Declaration

public ErrorApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of ErrorApi

Declaration

public static BitmovinApiBuilder<ErrorApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<ErrorApi>

Customdata

Declaration

public CustomdataApi Customdata { get; }

Property Value

Type	Description
CustomdataApi

Methods

CreateAsync(Webhook)

Add 'Encoding Error' Webhook

Declaration

public Task<Webhook> CreateAsync(Webhook webhook)

Parameters

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

Returns

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

CreateByEncodingIdAsync(String, Webhook)

Add Error 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 Error' 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 Error' 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 Error' 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 Error' 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 Error' 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<ErrorApi.ListQueryParams, ErrorApi.ListQueryParams>[])

List 'Encoding Error' Webhooks

Declaration

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

Parameters

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

Returns

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

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

List 'Encoding Error' Webhooks for a specific Encoding

Declaration

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

Parameters

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

Returns

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