Class MediaManager

Index

Constructors

Methods

get getContent getFile insert query

Constructors

constructor

new MediaManager(params: MediaManagerOptions): MediaManager
Parameters
- params: MediaManagerOptions
Returns MediaManager
- Defined in MediaManager.ts:23

Methods

get

get(id: string): Promise<null | MediaEntry>
Parameters
- id: string
  id in MediaEntry
Returns Promise<null | MediaEntry>
The MediaEntry, or null if ID does not map to a media entry on GCS.
- Defined in MediaManager.ts:231

getContent

getContent(id: string, variant?: undefined | string): ReadableStream
Parameters
- id: string
  id in MediaEntry
- variant: undefined | string = DEFAULT_ORIGINAL_VARIANT_NAME
  Maps to VariantSetting.name. Defaults to original.
Returns ReadableStream
a ReadableStream of file content from GCS.
- Defined in MediaManager.ts:271

getFile

getFile(id: string, variant?: undefined | string): File
Returns the GCS File for the specified id and variant.

Note that this API does not check if the file actually exist on GCS; you may use the exists method provided by GCS File to check by yourself.
Parameters
- id: string
  id in MediaEntry
- variant: undefined | string = DEFAULT_ORIGINAL_VARIANT_NAME
  Maps to VariantSetting.name. Defaults to original.
Returns File
- Defined in MediaManager.ts:262

insert

insert(__namedParameters: InsertOptions): Promise<MediaEntry>
Parameters
- __namedParameters: InsertOptions
Returns Promise<MediaEntry>
- Defined in MediaManager.ts:141

query

query(options: QueryOptions): Promise<SearchResult>
Parameters
- options: QueryOptions
Returns Promise<SearchResult>
- Defined in MediaManager.ts:98