Class WatchFoldersApi
Inheritance
System.Object
WatchFoldersApi
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.WatchFolders
Assembly: Bitmovin.Api.Sdk.dll
Syntax
public class WatchFoldersApiConstructors
WatchFoldersApi(IBitmovinApiClientFactory)
Declaration
public WatchFoldersApi(IBitmovinApiClientFactory apiClientFactory)Parameters
| Type | Name | Description |
|---|---|---|
| IBitmovinApiClientFactory | apiClientFactory |
Properties
Builder
Fluent builder for creating an instance of WatchFoldersApi
Declaration
public static BitmovinApiBuilder<WatchFoldersApi> Builder { get; }Property Value
| Type | Description |
|---|---|
| BitmovinApiBuilder<WatchFoldersApi> |
Methods
CreateAsync(WatchFolder)
Create Watch Folder
Declaration
public Task<WatchFolder> CreateAsync(WatchFolder watchFolder)Parameters
| Type | Name | Description |
|---|---|---|
| WatchFolder | watchFolder | The Watch Folder to be created |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<WatchFolder> |
DeleteAsync(String)
Delete Watch Folder
Declaration
public Task<BitmovinResponse> DeleteAsync(string watchFolderId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | watchFolderId | Id of the Watch Folder (required) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<BitmovinResponse> |
GetAsync(String)
Watch Folder details
Declaration
public Task<WatchFolder> GetAsync(string watchFolderId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | watchFolderId | Id of the Watch Folder (required) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<WatchFolder> |
ListAsync(Func<WatchFoldersApi.ListQueryParams, WatchFoldersApi.ListQueryParams>[])
List all Watch Folders
Declaration
public Task<PaginationResponse<WatchFolder>> ListAsync(params Func<WatchFoldersApi.ListQueryParams, WatchFoldersApi.ListQueryParams>[] queryParams)Parameters
| Type | Name | Description |
|---|---|---|
| System.Func<WatchFoldersApi.ListQueryParams, WatchFoldersApi.ListQueryParams>[] | queryParams | The query parameters for sorting, filtering and paging options (optional) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<PaginationResponse<WatchFolder>> |
StartAsync(String)
Start Watch Folder
Declaration
public Task<BitmovinResponse> StartAsync(string watchFolderId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | watchFolderId | Id of the Watch Folder (required) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<BitmovinResponse> |
StopAsync(String)
Stop Watch Folder
Declaration
public Task<BitmovinResponse> StopAsync(string watchFolderId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | watchFolderId | Id of the Watch Folder (required) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<BitmovinResponse> |