genstudio-extensibility-sdk

@adobe/genstudio-extensibility-sdk

---

@adobe/genstudio-extensibility-sdk / ValidationExtensionService

Class: ValidationExtensionService

Manages experience data conversion and retrieval

Constructors

new ValidationExtensionService()

new ValidationExtensionService(): ValidationExtensionService

Returns

ValidationExtensionService

Methods

getExperiences()

static getExperiences(connection: any): Promise<Experience[]>

Fetches experiences from the connection

Parameters

connection

any

The guest connection to the host

Returns

Promise<Experience[]>

Promise<Experience[]> Array of converted experiences

Throws

Error if connection is missing

In non-HTML canvas, variants are flattened into Experience and returned. Use getExperiencesWithVariants instead.

---

getGenerationContext()

static getGenerationContext(connection: any): Promise<GenerationContext>

Gets the generation context from the connection

Parameters

connection

any

The guest connection to the host

Returns

Promise<GenerationContext>

The generation context

Throws

Error if connection is missing

---

open()

static open(connection: any, extensionId: string): void

Opens the validation extension

Parameters

connection

any

The guest connection to the host

extensionId

string

The ID of the extension to open

Returns

void

Throws

Error if connection is missing

---

updateField()

static updateField(connection: any, fieldUpdate: FieldUpdate): void

Updates a field value on the canvas.

Parameters

connection

any

The guest connection to the host

fieldUpdate

FieldUpdate

The field update payload describing which field to change and the new value

Returns

void

Throws

Error if connection is missing

This site is open source. Improve this page.