MediaPlugin

MediaPlugin.

Classes

MediaPlugableClass

Extends PlugableClass.

new MediaPlugableClass(): MediaPlugableClass

Returns MediaPlugableClass. Inherited from PlugableClass.constructor.

Property	Type
`delete`	<`ARGS`>(`args`: `ARGS`, `opts`?: `JobOptions`) => `Promise`<`DataOrError`<`IfArray`<`ARGS`, `Identified`>>>
`functions`	`FunctionRecord`
`insert`	<`ARGS`>(`args`: `ARGS`, `opts`?: `JobOptions`) => `Promise`<`DataOrError`<`IfArray`<`ARGS`, `Identified`>>>
`mash`	(`args`?: `MediaMashRequest`, `opts`?: `JobOptions`) => `Promise`<`DataOrError`<`StorableMedia`>>
`options`	`MediaPluginOptions`
`row`	(`args`: `Identified`, `opts`?: `JobOptions`) => `Promise`<`DataOrError`<`StoredMedia`>>
`select`	(`args`: `MediaSearchRequest`, `opts`?: `JobOptions`) => `Promise`<`DataOrError`<`MediaSearchResponse`>>
`update`	<`ARGS`>(`args`: `ARGS`, `opts`?: `JobOptions`) => `Promise`<`DataOrError`<`IfArray`<`ARGS`, `Identified`>>>

Methods

client(args): Promise<DataOrError<ClientAsset>>

Parameter	Type	Description
`args`	`StorableMedia`

Returns Promise<DataOrError<ClientAsset>>.

install(definition, …ids): void | Errored

Parameter	Type	Description
`definition`	`string` \| `Function` \| `StringTuple`
…`ids`	`string`[]

Returns void | Errored. Inherited from PlugableClass.install.

server(args): Promise<DataOrError<ServerAsset>>

Parameter	Type	Description
`args`	`StorableMedia`

Returns Promise<DataOrError<ServerAsset>>.

toString(): string

Returns string. Inherited from PlugableClass.toString.

Interfaces

MediaMashRequest

Property	Type
`byProperty?`	`string`

MediaPluginOptions

Property	Type
`defaultContainer`	`string`
`defaultContent`	`string`
`mediaMash?`	`string` \| `StorableMedia` \| `EndpointRequest`
`mediaSelect?`	`string` \| `EndpointRequest` \| `StoredMedia`[]

MediaRemoveRequest

Property	Type
`id`	`string`
`removeResources?`	`boolean`

MediaResource

Extends Resource.

Property	Type
`bytes?`	`number`
`createdAt?`	`string`
`decoded?`	`UnknownRecord`
`id`	`string`
`label?`	`string`
`projectId?`	`string`
`request`	`EndpointRequest`
`source`	`MediaType`
`type`	`ResourceType`
`updatedAt?`	`string`
`uploadedAt?`	`string`

MediaResourcesRow

Property	Type
`created_at`	`string`
`id`	`string`
`media_id`	`string`
`resource_id`	`string`
`user_id`	`string`

MediaSearchAltResponse

Property	Type
`caching?`	`Caching`
`data`	`StoredMedia`[]

MediaSearchRequest

Extends SearchRequest.

Property	Type
`column?`	`OrArray`<`string`>
`range?`	`OrArray`<`number`>
`sort?`	`OrArray`<`SearchSort`>
`source?`	`OrArray`<`string`>
`term?`	`OrArray`<`string`>
`type?`	`OrArray`<`MediaType`>

Type Aliases

MediaSearchResponse

MediaSearchResponse: StoredMedia[] | MediaSearchAltResponse

Variables

MediaPlugin

const MediaPlugin: MediaPlugableClass

Functions

clientColorImageMediaPlug

clientColorImageMediaPlug(args?, options?): Promise<DataOrError<Media>>

Parameter	Type
`args`?	`StorableMedia`
`options`?	`PrimitiveOrUndefined`

Returns Promise<DataOrError<Media>>.

clientDeleteMediaPlug

clientDeleteMediaPlug<ARGS>(args, opts?): Promise<DataOrError<IfArray<ARGS, Identified>>>

Type Parameter	Description
`ARGS` extends `OrArray`<`Identified`>

Parameter	Type	Description
`args`	`ARGS`
`opts`?	`JobOptions`

Returns Promise<DataOrError<IfArray<ARGS, Identified>>>.

clientInsertMediaPlug

clientInsertMediaPlug<ARGS>(args, opts?): Promise<DataOrError<IfArray<ARGS, Identified>>>

Type Parameter	Description
`ARGS` extends `OrArray`<`StorableMedia`>

Parameter	Type	Description
`args`	`ARGS`
`opts`?	`JobOptions`

Returns Promise<DataOrError<IfArray<ARGS, Identified>>>.

clientMashMediaPlug

clientMashMediaPlug(args?, opts?): Promise<DataOrError<StorableMedia>>

Parameter	Type	Description
`args`?	`MediaMashRequest`
`opts`?	`JobOptions`

Returns Promise<DataOrError<StorableMedia>>.

clientMashVideoMediaPlug

clientMashVideoMediaPlug(args?, options?): Promise<DataOrError<Media>>

Parameter	Type
`args`?	`StorableMedia`
`options`?	`PrimitiveOrUndefined`

Returns Promise<DataOrError<Media>>.

clientRawAudioMediaPlug

clientRawAudioMediaPlug(args?, options?): Promise<DataOrError<Media>>

Parameter	Type
`args`?	`StorableMedia`
`options`?	`PrimitiveOrUndefined`

Returns Promise<DataOrError<Media>>.

clientRawImageMediaPlug

clientRawImageMediaPlug(args?, options?): Promise<DataOrError<Media>>

Parameter	Type
`args`?	`StorableMedia`
`options`?	`PrimitiveOrUndefined`

Returns Promise<DataOrError<Media>>.

clientRawVideoMediaPlug

clientRawVideoMediaPlug(args?, options?): Promise<DataOrError<Media>>

Parameter	Type
`args`?	`StorableMedia`
`options`?	`PrimitiveOrUndefined`

Returns Promise<DataOrError<Media>>.

clientRowMediaPlug

clientRowMediaPlug(args, opts?): Promise<DataOrError<StoredMedia>>

Parameter	Type	Description
`args`	`Identified`
`opts`?	`JobOptions`

Returns Promise<DataOrError<StoredMedia>>.

clientSelectMediaPlug

clientSelectMediaPlug(args, opts?): Promise<DataOrError<MediaSearchResponse>>

Parameter	Type	Description
`args`	`MediaSearchRequest`
`opts`?	`JobOptions`

Returns Promise<DataOrError<MediaSearchResponse>>.

clientShapeImageMediaPlug

clientShapeImageMediaPlug(args?, options?): Promise<DataOrError<Media>>

Parameter	Type
`args`?	`StorableMedia`
`options`?	`PrimitiveOrUndefined`

Returns Promise<DataOrError<Media>>.

clientTextImageMediaPlug

clientTextImageMediaPlug(args?, options?): Promise<DataOrError<Media>>

Parameter	Type
`args`?	`StorableMedia`
`options`?	`PrimitiveOrUndefined`

Returns Promise<DataOrError<Media>>.

clientUpdateMediaPlug

clientUpdateMediaPlug<ARGS>(args, opts?): Promise<DataOrError<IfArray<ARGS, Identified>>>

Type Parameter	Description
`ARGS` extends `OrArray`<`StoredMedia`>

Parameter	Type	Description
`args`	`ARGS`
`opts`?	`JobOptions`

Returns Promise<DataOrError<IfArray<ARGS, Identified>>>.

serverColorImageMediaPlug

serverColorImageMediaPlug(args?, options?): Promise<DataOrError<Media>>

Parameter	Type
`args`?	`StorableMedia`
`options`?	`PrimitiveOrUndefined`

Returns Promise<DataOrError<Media>>.

serverDeleteMediaPlug

serverDeleteMediaPlug<ARGS>(args, opts?): Promise<DataOrError<IfArray<ARGS, Identified>>>

Type Parameter	Description
`ARGS` extends `OrArray`<`Identified`>

Parameter	Type	Description
`args`	`ARGS`
`opts`?	`JobOptions`

Returns Promise<DataOrError<IfArray<ARGS, Identified>>>.

serverInsertMediaPlug

serverInsertMediaPlug<ARGS>(args, opts?): Promise<DataOrError<IfArray<ARGS, Identified>>>

Type Parameter	Description
`ARGS` extends `OrArray`<`StorableMedia`>

Parameter	Type	Description
`args`	`ARGS`
`opts`?	`JobOptions`

Returns Promise<DataOrError<IfArray<ARGS, Identified>>>.

serverMashMediaPlug

serverMashMediaPlug(args?, opts?): Promise<DataOrError<StorableMedia>>

Parameter	Type	Description
`args`?	`MediaMashRequest`
`opts`?	`JobOptions`

Returns Promise<DataOrError<StorableMedia>>.

serverMashVideoMediaPlug

serverMashVideoMediaPlug(object): Promise<DataOrError<Media>>

Parameter	Type
`object`	`MashVideoArgs`

Returns Promise<DataOrError<Media>>.

serverRawAudioMediaPlug

serverRawAudioMediaPlug(args?, options?): Promise<DataOrError<Media>>

Parameter	Type
`args`?	`StorableMedia`
`options`?	`PrimitiveOrUndefined`

Returns Promise<DataOrError<Media>>.

serverRawImageMediaPlug

serverRawImageMediaPlug(args?, options?): Promise<DataOrError<Media>>

Parameter	Type
`args`?	`StorableMedia`
`options`?	`PrimitiveOrUndefined`

Returns Promise<DataOrError<Media>>.

serverRawVideoMediaPlug

serverRawVideoMediaPlug(args?, options?): Promise<DataOrError<Media>>

Parameter	Type
`args`?	`StorableMedia`
`options`?	`PrimitiveOrUndefined`

Returns Promise<DataOrError<Media>>.

serverRowMediaPlug

serverRowMediaPlug(args, opts?): Promise<DataOrError<StoredMedia>>

Parameter	Type	Description
`args`	`Identified`
`opts`?	`JobOptions`

Returns Promise<DataOrError<StoredMedia>>.

serverSelectMediaPlug

serverSelectMediaPlug(args, opts?): Promise<DataOrError<MediaSearchResponse>>

Parameter	Type	Description
`args`	`MediaSearchRequest`
`opts`?	`JobOptions`

Returns Promise<DataOrError<MediaSearchResponse>>.

serverShapeImageMediaPlug

serverShapeImageMediaPlug(args?, options?): Promise<DataOrError<Media>>

Parameter	Type
`args`?	`StorableMedia`
`options`?	`PrimitiveOrUndefined`

Returns Promise<DataOrError<Media>>.

serverTextImageMediaPlug

serverTextImageMediaPlug(args?, options?): Promise<DataOrError<Media>>

Parameter	Type
`args`?	`StorableMedia`
`options`?	`PrimitiveOrUndefined`

Returns Promise<DataOrError<Media>>.

serverUpdateMediaPlug

serverUpdateMediaPlug<ARGS>(args, opts?): Promise<DataOrError<IfArray<ARGS, Identified>>>

Type Parameter	Description
`ARGS` extends `OrArray`<`StoredMedia`>

Parameter	Type	Description
`args`	`ARGS`
`opts`?	`JobOptions`

Returns Promise<DataOrError<IfArray<ARGS, Identified>>>.