Skip to main content

Class: MediaDocumentService

Defined in: service/MediaDocumentService.ts:73

Backwards-compatible class form. New code should call mediaDocumentService(client).

Constructors​

Constructor​

new MediaDocumentService(client): MediaDocumentService

Defined in: service/MediaDocumentService.ts:75

Parameters​

client​

GraphQLClient

Returns​

MediaDocumentService

Methods​

createMediaDocument()​

createMediaDocument(input): Promise<MediaDocument>

Defined in: service/MediaDocumentService.ts:90

Creates a new media document

Parameters​

input​

MediaDocumentInput

Media document creation input

Returns​

Promise<MediaDocument>

deleteMediaDocument()​

deleteMediaDocument(variables): Promise<DeleteMediaDocumentResponse>

Defined in: service/MediaDocumentService.ts:100

Deletes a media document

Parameters​

variables​

MediaDocumentDeleteVariables

Media document ID

Returns​

Promise<DeleteMediaDocumentResponse>

getMediaDocument()​

getMediaDocument(variables): Promise<MediaDocument>

Defined in: service/MediaDocumentService.ts:80

Retrieves a specific media document

Parameters​

variables​

MediaDocumentVariables

Media document ID

Returns​

Promise<MediaDocument>

getMediaDocuments()​

getMediaDocuments(variables): Promise<PaginatedMediaDocumentResponse>

Defined in: service/MediaDocumentService.ts:85

Retrieves media documents with pagination

Parameters​

variables​

MediaDocumentsVariables

Search input parameters

Returns​

Promise<PaginatedMediaDocumentResponse>

updateMediaDocument()​

updateMediaDocument(input): Promise<MediaDocument>

Defined in: service/MediaDocumentService.ts:95

Updates an existing media document

Parameters​

input​

UpdateMediaDocumentInput

Media document update input

Returns​

Promise<MediaDocument>