Class CustomXmlElementsApi

Hierarchy

BaseAPI
- CustomXmlElementsApi

Index

Constructors

constructor

Properties

restClient

Methods

Constructors

constructor

new CustomXmlElementsApi(configuration: Configuration): CustomXmlElementsApi

Overrides BaseAPI.constructor
- Defined in encoding/manifests/dash/periods/customXmlElements/CustomXmlElementsApi.ts:15
Parameters
- configuration: Configuration
Returns CustomXmlElementsApi

Properties

Protected restClient

restClient: RestClient

Methods

create

create(manifestId: string, periodId: string, customXmlElement: CustomXmlElement): Promise<CustomXmlElement>

- Defined in encoding/manifests/dash/periods/customXmlElements/CustomXmlElementsApi.ts:29
Parameters
- manifestId: string
- periodId: string
- Optional customXmlElement: CustomXmlElement
Returns Promise<CustomXmlElement>

delete

delete(manifestId: string, periodId: string, customXmlElementId: string): Promise<BitmovinResponse>

- Defined in encoding/manifests/dash/periods/customXmlElements/CustomXmlElementsApi.ts:47
Parameters
- manifestId: string
- periodId: string
- customXmlElementId: string
Returns Promise<BitmovinResponse>

get

get(manifestId: string, periodId: string, customXmlElementId: string): Promise<CustomXmlElement>

- Defined in encoding/manifests/dash/periods/customXmlElements/CustomXmlElementsApi.ts:66
Parameters
- manifestId: string
- periodId: string
- customXmlElementId: string
Returns Promise<CustomXmlElement>

list

list(manifestId: string, periodId: string, queryParameters: CustomXmlElementListQueryParams | function): Promise<PaginationResponse<CustomXmlElement>>

- Defined in encoding/manifests/dash/periods/customXmlElements/CustomXmlElementsApi.ts:85
Parameters
- manifestId: string
- periodId: string
- Optional queryParameters: CustomXmlElementListQueryParams | function
Returns Promise<PaginationResponse<CustomXmlElement>>

Generated using TypeDoc