Show / Hide Table of Contents

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

Methods

CreateAsync(Webhook)

Add 'Manifest Finished Successfully' Webhook (All Manifests)

Declaration
public Task<Webhook> CreateAsync(Webhook webhook)
Parameters
Type Name Description
Webhook webhook

Add a new webhook notification if a manifest creation finished successfully. A maximum number of 5 webhooks is allowed

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

CreateByManifestIdAsync(String, Webhook)

Add 'Manifest Finished Successfully' Webhook Notification (Specific Manifest)

Declaration
public Task<Webhook> CreateByManifestIdAsync(string manifestId, Webhook webhook)
Parameters
Type Name Description
System.String manifestId

Id of the manifest resource (required)

Webhook webhook

The webhook notifications object. A maximum number of 5 webhooks per Manifest is allowed

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

DeleteAsync(String)

Delete Manifest Finished Webhook

Declaration
public Task<BitmovinResponse> DeleteAsync(string notificationId)
Parameters
Type Name Description
System.String notificationId

Id of the webhook notification (required)

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

UpdateAsync(String, Webhook)

Replace Manifest Finished Webhook Notification

Declaration
public Task<Webhook> UpdateAsync(string notificationId, Webhook webhook)
Parameters
Type Name Description
System.String notificationId

Id of the webhook notification (required)

Webhook webhook

The webhook notification with the updated values

Returns
Type Description
System.Threading.Tasks.Task<Webhook>
Back to top Generated by DocFX