Interface Environment

Hierarchy

EnvironmentProps
ContentfulEnvironmentAPI
DefaultElements<EnvironmentProps & MetaSys>
MetaSys<MetaSysProps>
- Environment

Index

Properties

name
sys

Properties

name

name: string

sys

sys: MetaSysProps

Methods

createAppInstallation

createAppInstallation(id: string, data: AppInstallationProps): Promise<AppInstallation>

Inherited from ContentfulEnvironmentAPI.createAppInstallation
- Defined in environment.d.ts:18
Parameters
- id: string
- data: AppInstallationProps
Returns Promise<AppInstallation>

createAsset

createAsset(data: AssetProps): Promise<Asset>

Inherited from ContentfulEnvironmentAPI.createAsset
- Defined in environment.d.ts:19
Parameters
- data: AssetProps
Returns Promise<Asset>

createAssetFromFiles

createAssetFromFiles(data: AssetFileProp): Promise<Asset>

Inherited from ContentfulEnvironmentAPI.createAssetFromFiles
- Defined in environment.d.ts:20
Parameters
- data: AssetFileProp
Returns Promise<Asset>

createAssetWithId

createAssetWithId(id: string, data: AssetProps): Promise<Asset>

Inherited from ContentfulEnvironmentAPI.createAssetWithId
- Defined in environment.d.ts:21
Parameters
- id: string
- data: AssetProps
Returns Promise<Asset>

createContentType

createContentType(data: ContentTypeProps): Promise<ContentType>

Inherited from ContentfulEnvironmentAPI.createContentType
- Defined in environment.d.ts:22
Parameters
- data: ContentTypeProps
Returns Promise<ContentType>

createContentTypeWithId

createContentTypeWithId(id: string, data: ContentTypeProps): Promise<ContentType>

Inherited from ContentfulEnvironmentAPI.createContentTypeWithId
- Defined in environment.d.ts:23
Parameters
- id: string
- data: ContentTypeProps
Returns Promise<ContentType>

createEntry

createEntry(contentTypeId: string, data: EntryProp): Promise<Entry>

Inherited from ContentfulEnvironmentAPI.createEntry
- Defined in environment.d.ts:24
Parameters
- contentTypeId: string
- data: EntryProp
Returns Promise<Entry>

createEntryWithId

createEntryWithId(contentTypeId: string, id: string, data: EntryProp): Promise<Entry>

Inherited from ContentfulEnvironmentAPI.createEntryWithId
- Defined in environment.d.ts:25
Parameters
- contentTypeId: string
- id: string
- data: EntryProp
Returns Promise<Entry>

createLocale

createLocale(data: CreateLocaleProps): Promise<Locale>

Inherited from ContentfulEnvironmentAPI.createLocale
- Defined in environment.d.ts:26
Parameters
- data: CreateLocaleProps
Returns Promise<Locale>

createUiExtension

createUiExtension(data: UIExtensionProps): Promise<UIExtension>

Inherited from ContentfulEnvironmentAPI.createUiExtension
- Defined in environment.d.ts:27
Parameters
- data: UIExtensionProps
Returns Promise<UIExtension>

createUiExtensionWithId

createUiExtensionWithId(id: string, data: UIExtensionProps): Promise<UIExtension>

Inherited from ContentfulEnvironmentAPI.createUiExtensionWithId
- Defined in environment.d.ts:28
Parameters
- id: string
- data: UIExtensionProps
Returns Promise<UIExtension>

createUpload

createUpload(data: { file: string | ArrayBuffer | Stream }): Promise<Upload>

Inherited from ContentfulEnvironmentAPI.createUpload
- Defined in environment.d.ts:29
Parameters
- data: { file: string | ArrayBuffer | Stream }
  - file: string | ArrayBuffer | Stream
Returns Promise<Upload>

delete

delete(): Promise<{}>

Inherited from ContentfulEnvironmentAPI.delete
- Defined in environment.d.ts:30
Returns Promise<{}>

getAppInstallation

getAppInstallation(id: string): Promise<AppInstallation>

Inherited from ContentfulEnvironmentAPI.getAppInstallation
- Defined in environment.d.ts:47
Parameters
- id: string
Returns Promise<AppInstallation>

getAppInstallations

getAppInstallations(): Promise<Collection<AppInstallation>>

Inherited from ContentfulEnvironmentAPI.getAppInstallations
- Defined in environment.d.ts:48
Returns Promise<Collection<AppInstallation>>

getAsset

getAsset(id: string, query?: Record<string, any>): Promise<Asset>

Inherited from ContentfulEnvironmentAPI.getAsset
- Defined in environment.d.ts:31
Parameters
- id: string
- Optional query: Record<string, any>
Returns Promise<Asset>

getAssets

getAssets(query?: Record<string, any>): Promise<Collection<Asset>>

Inherited from ContentfulEnvironmentAPI.getAssets
- Defined in environment.d.ts:32
Parameters
- Optional query: Record<string, any>
Returns Promise<Collection<Asset>>

getContentType

getContentType(id: string): Promise<ContentType>

Inherited from ContentfulEnvironmentAPI.getContentType
- Defined in environment.d.ts:34
Parameters
- id: string
Returns Promise<ContentType>

getContentTypeSnapshots

getContentTypeSnapshots(contentTypeId: string, query?: QueryOptions): Promise<Collection<Snapshot<ContentTypeProps>>>

Inherited from ContentfulEnvironmentAPI.getContentTypeSnapshots
- Defined in environment.d.ts:35
Parameters
- contentTypeId: string
- Optional query: QueryOptions
Returns Promise<Collection<Snapshot<ContentTypeProps>>>

getContentTypes

getContentTypes(object?: QueryOptions): Promise<Collection<ContentType>>

Inherited from ContentfulEnvironmentAPI.getContentTypes
- Defined in environment.d.ts:33
Parameters
- Optional object: QueryOptions
Returns Promise<Collection<ContentType>>

getEditorInterfaceForContentType

getEditorInterfaceForContentType(contentTypeId: string): Promise<EditorInterface>

Inherited from ContentfulEnvironmentAPI.getEditorInterfaceForContentType
- Defined in environment.d.ts:39
Parameters
- contentTypeId: string
Returns Promise<EditorInterface>

getEntries

getEntries(object?: QueryOptions): Promise<Collection<Entry>>

Inherited from ContentfulEnvironmentAPI.getEntries
- Defined in environment.d.ts:41
Parameters
- Optional object: QueryOptions
Returns Promise<Collection<Entry>>

getEntry

getEntry(id: string): Promise<Entry>

Inherited from ContentfulEnvironmentAPI.getEntry
- Defined in environment.d.ts:40
Parameters
- id: string
Returns Promise<Entry>

getEntrySnapshots

getEntrySnapshots(id: string): Promise<Collection<Snapshot<EntryProp>>>

Inherited from ContentfulEnvironmentAPI.getEntrySnapshots
- Defined in environment.d.ts:42
Parameters
- id: string
Returns Promise<Collection<Snapshot<EntryProp>>>

getLocale

getLocale(id: string): Promise<Locale>

Inherited from ContentfulEnvironmentAPI.getLocale
- Defined in environment.d.ts:43
Parameters
- id: string
Returns Promise<Locale>

getLocales

getLocales(): Promise<Collection<Locale>>

Inherited from ContentfulEnvironmentAPI.getLocales
- Defined in environment.d.ts:44
Returns Promise<Collection<Locale>>

getUiExtension

getUiExtension(id: string): Promise<UIExtension>

Inherited from ContentfulEnvironmentAPI.getUiExtension
- Defined in environment.d.ts:45
Parameters
- id: string
Returns Promise<UIExtension>

getUiExtensions

getUiExtensions(): Promise<Collection<UIExtension>>

Inherited from ContentfulEnvironmentAPI.getUiExtensions
- Defined in environment.d.ts:46
Returns Promise<Collection<UIExtension>>

getUpload

getUpload(id: string): Promise<Upload>

Inherited from ContentfulEnvironmentAPI.getUpload
- Defined in environment.d.ts:49
Parameters
- id: string
Returns Promise<Upload>

toPlainObject

toPlainObject(): EnvironmentProps & MetaSys

Inherited from DefaultElements.toPlainObject
- Defined in generated/common-types.d.ts:2
Returns EnvironmentProps & MetaSys