Class ContentfulMediaStore

Hierarchy

ContentfulMediaStore

Implements

MediaStore

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ContentfulMediaStore(ContentfulClient: ContentfulClient, options: ContentfulMediaStoreOptions): ContentfulMediaStore

- Defined in packages/tinacms-contentful/src/Media/media-store.ts:24
Parameters
- ContentfulClient: ContentfulClient
- options: ContentfulMediaStoreOptions
Returns ContentfulMediaStore

Properties

accept

accept: string = "*"

actions

actions: any[] = ...

locale

locale: string

Methods

delete

delete(media: ContentfulMedia): Promise<void>

Implementation of MediaStore.delete
- Defined in packages/tinacms-contentful/src/Media/media-store.ts:82
Deletes a media file from Contentful by deleting the related Asset

Parameters
- media: ContentfulMedia
  
  The media file to delete
Returns Promise<void>

list

list(options?: MediaListOptions): Promise<MediaList>

Implementation of MediaStore.list
- Defined in packages/tinacms-contentful/src/Media/media-store.ts:99
Returns a list of media types to fetch, or the media corresponding to a selected type

Parameters
- Optional options: MediaListOptions
Returns Promise<MediaList>

A media list to display

persist

persist(files: MediaUploadOptions[]): Promise<ContentfulMedia[]>

Implementation of MediaStore.persist
- Defined in packages/tinacms-contentful/src/Media/media-store.ts:53
Write media store files back to Contenful as Assets

Parameters
- files: MediaUploadOptions[]
  
  Array of media files to write back
Returns Promise<ContentfulMedia[]>

Array of newly created media files

previewSrc

previewSrc(src: string): Promise<string>

Implementation of MediaStore.previewSrc
- Defined in packages/tinacms-contentful/src/Media/media-store.ts:73
Returns the URL to the media files

Parameters
- src: string
Returns Promise<string>

Path to media file

setFilter

setFilter(query: any): void

- Defined in packages/tinacms-contentful/src/Media/media-store.ts:41
Set the filter to run on media

Parameters
- query: any
Returns void

Generated using TypeDoc