Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
155 changes: 155 additions & 0 deletions docs/api/classes/FragmentSwapExtensionService.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
[**@adobe/genstudio-extensibility-sdk**](../README.md)

***

[@adobe/genstudio-extensibility-sdk](../globals.md) / FragmentSwapExtensionService

# Class: FragmentSwapExtensionService

Manages swap field extension functionality for swapping field content

## Constructors

### new FragmentSwapExtensionService()

> **new FragmentSwapExtensionService**(): [`FragmentSwapExtensionService`](FragmentSwapExtensionService.md)

#### Returns

[`FragmentSwapExtensionService`](FragmentSwapExtensionService.md)

## Methods

### close()

> `static` **close**(`connection`: `any`): `void`

Closes the swap field extension dialog

#### Parameters

##### connection

`any`

The guest connection to the host

#### Returns

`void`

#### Throws

Error if connection is missing

***

### getExperience()

> `static` **getExperience**(`connection`: `any`): `Promise`\<[`Experience`](../interfaces/Experience.md)\>

Gets the current field context from the host

#### Parameters

##### connection

`any`

The guest connection to the host

#### Returns

`Promise`\<[`Experience`](../interfaces/Experience.md)\>

Promise<SwapFieldContext> The current field context

#### Throws

Error if connection is missing

***

### getGenerationContext()

> `static` **getGenerationContext**(`connection`: `any`): `Promise`\<[`GenerationContext`](../type-aliases/GenerationContext.md)\>

Gets the generation context from the host

#### Parameters

##### connection

`any`

The guest connection to the host

#### Returns

`Promise`\<[`GenerationContext`](../type-aliases/GenerationContext.md)\>

Promise<GenerationContext> The generation context

#### Throws

Error if connection is missing

***

### open()

> `static` **open**(`connection`: `any`, `extensionId`: `string`): `void`

Opens the swap field extension dialog

#### 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

***

### setSwapValue()

> `static` **setSwapValue**(`connection`: `any`, `value`: `string`): `void`

Sets the swap value for the field content

#### Parameters

##### connection

`any`

The guest connection to the host

##### value

`string`

The new value to write into the field

#### Returns

`void`

#### Throws

Error if connection is missing
127 changes: 127 additions & 0 deletions docs/api/classes/FragmentSwapExtensionServiceError.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
[**@adobe/genstudio-extensibility-sdk**](../README.md)

***

[@adobe/genstudio-extensibility-sdk](../globals.md) / FragmentSwapExtensionServiceError

# Class: FragmentSwapExtensionServiceError

## Extends

- `Error`

## Constructors

### new FragmentSwapExtensionServiceError()

> **new FragmentSwapExtensionServiceError**(`message`: `string`): [`FragmentSwapExtensionServiceError`](FragmentSwapExtensionServiceError.md)

#### Parameters

##### message

`string`

#### Returns

[`FragmentSwapExtensionServiceError`](FragmentSwapExtensionServiceError.md)

#### Overrides

`Error.constructor`

## Properties

### message

> **message**: `string`

#### Inherited from

`Error.message`

***

### name

> **name**: `string`

#### Inherited from

`Error.name`

***

### stack?

> `optional` **stack**: `string`

#### Inherited from

`Error.stack`

***

### prepareStackTrace()?

> `static` `optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`

Optional override for formatting stack traces

#### Parameters

##### err

`Error`

##### stackTraces

`CallSite`[]

#### Returns

`any`

#### See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

#### Inherited from

`Error.prepareStackTrace`

***

### stackTraceLimit

> `static` **stackTraceLimit**: `number`

#### Inherited from

`Error.stackTraceLimit`

## Methods

### captureStackTrace()

> `static` **captureStackTrace**(`targetObject`: `object`, `constructorOpt`?: `Function`): `void`

Create .stack property on a target object

#### Parameters

##### targetObject

`object`

##### constructorOpt?

`Function`

#### Returns

`void`

#### Inherited from

`Error.captureStackTrace`
3 changes: 3 additions & 0 deletions docs/api/globals.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
## Classes

- [ExtensionAuthError](classes/ExtensionAuthError.md)
- [FragmentSwapExtensionService](classes/FragmentSwapExtensionService.md)
- [FragmentSwapExtensionServiceError](classes/FragmentSwapExtensionServiceError.md)
- [ImportTemplateExtensionService](classes/ImportTemplateExtensionService.md)
- [ImportTemplateExtensionServiceError](classes/ImportTemplateExtensionServiceError.md)
- [PromptExtensionService](classes/PromptExtensionService.md)
Expand All @@ -24,6 +26,7 @@

- [Experience](interfaces/Experience.md)
- [ExperienceField](interfaces/ExperienceField.md)
- [FragmentSwapExtensionApi](interfaces/FragmentSwapExtensionApi.md)
- [ImportTemplateExtensionApi](interfaces/ImportTemplateExtensionApi.md)
- [PromptExtensionApi](interfaces/PromptExtensionApi.md)
- [SelectContentExtensionApi](interfaces/SelectContentExtensionApi.md)
Expand Down
77 changes: 77 additions & 0 deletions docs/api/interfaces/FragmentSwapExtensionApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
[**@adobe/genstudio-extensibility-sdk**](../README.md)

***

[@adobe/genstudio-extensibility-sdk](../globals.md) / FragmentSwapExtensionApi

# Interface: FragmentSwapExtensionApi

## Extends

- `VirtualApi`

## Indexable

\[`key`: `string`\]: `object` \| (...`args`: `unknown`[]) => `unknown`

## Properties

### api

> **api**: \{ `fragmentSwapExtension`: \{ `close`: () => `void`; `getExperience`: () => `Promise`\<[`Experience`](Experience.md)\>; `getGenerationContext`: () => `Promise`\<[`GenerationContext`](../type-aliases/GenerationContext.md)\>; `open`: (`extensionId`: `string`) => `void`; `setSwapValue`: (`value`: `string`) => `void`; \}; \}

#### fragmentSwapExtension

> **fragmentSwapExtension**: \{ `close`: () => `void`; `getExperience`: () => `Promise`\<[`Experience`](Experience.md)\>; `getGenerationContext`: () => `Promise`\<[`GenerationContext`](../type-aliases/GenerationContext.md)\>; `open`: (`extensionId`: `string`) => `void`; `setSwapValue`: (`value`: `string`) => `void`; \}

##### fragmentSwapExtension.close()

> **close**: () => `void`

###### Returns

`void`

##### fragmentSwapExtension.getExperience()

> **getExperience**: () => `Promise`\<[`Experience`](Experience.md)\>

###### Returns

`Promise`\<[`Experience`](Experience.md)\>

##### fragmentSwapExtension.getGenerationContext()

> **getGenerationContext**: () => `Promise`\<[`GenerationContext`](../type-aliases/GenerationContext.md)\>

###### Returns

`Promise`\<[`GenerationContext`](../type-aliases/GenerationContext.md)\>

##### fragmentSwapExtension.open()

> **open**: (`extensionId`: `string`) => `void`

###### Parameters

###### extensionId

`string`

###### Returns

`void`

##### fragmentSwapExtension.setSwapValue()

> **setSwapValue**: (`value`: `string`) => `void`

###### Parameters

###### value

`string`

###### Returns

`void`
Loading
Loading