ContentReference | dc-extensions-sdk

Hierarchy

ContentReference

Index

Constructors

constructor

Properties

connection

Methods

Constructors

constructor

new ContentReference(connection: ClientConnection): ContentReference

- Defined in lib/components/ContentReference.ts:17
Content Link - Use to open the content browser.

Parameters
- connection: ClientConnection
  
  message-event-channel connection
Returns ContentReference

Properties

Private connection

connection: ClientConnection

message-event-channel connection

Methods

Private fetchReferences

fetchReferences(contentTypeIds: Array<string>, max?: number | null): Promise<any>

- Defined in lib/components/ContentReference.ts:62
Parameters
- contentTypeIds: Array<string>
- Optional max: number | null
Returns Promise<any>

get

get(contentTypeIds: Array<string>): Promise<ContentItemReference>

- Defined in lib/components/ContentReference.ts:58
This method will trigger a content browser. It returns a promise that will resolve to the chosen Content Reference.

Parameters
- contentTypeIds: Array<string>
  list of Content Type Ids to filter the Content Browser by.
  
  Example
```
const enums = sdk.field.schema.allOf[1].properties.contentType.enum;
const contentRef = await sdk.contentReference.get(enums);

console.log(contentRef);
```
Returns Promise<ContentItemReference>

getMultiple

getMultiple(contentTypeIds: Array<string>, options?: ContentReferenceOptions): Promise<ContentItemReference[]>

- Defined in lib/components/ContentReference.ts:39
This method will trigger a content browser. It returns a promise that will resolve to the chosen Content References.

Parameters
- contentTypeIds: Array<string>
  
  list of Content Type Ids to filter the Content Browser by.
- Default value options: ContentReferenceOptions = { max: null }
Returns Promise<ContentItemReference[]>

Generated using TypeDoc