@adobe/genstudio-uix-sdk
Version:
GenStudio UI Extensibility SDK
65 lines (64 loc) • 2.57 kB
TypeScript
import { Asset } from "../asset/Asset";
export declare class ExtensionRegistrationError extends Error {
constructor(message: string);
}
/**
* Manages extension registration
*/
export declare class ExtensionRegistrationService {
/**
* open the create add on bar
* @param guestConnection - the guest connection
* @param appExtensionId - the app extension id
*
* example:
const ExtensionRegistration = (): React.JSX.Element => {
const init = async (): Promise<void> => {
const guestConnection = await register({
id: extensionId,
methods: {
createAddOnBar: {
addToggle: async (appExtensionId: string): Promise<ToggleItem[]> => {
return [
{
appMetaData: getAppMetadata(appExtensionId),
onClick: async () => {
await openCreateAddOnBar(guestConnection, appExtensionId);
},
}]
}
}
}
}
return <ExtensionRegistration />
}
*/
static openCreateAddOnBar(guestConnection: any, appExtensionId: string): any;
/**
* open the add context add on bar
* @param guestConnection - the guest connection
* @param appExtensionId - the app extension id
*/
static openAddContextAddOnBar(guestConnection: any, appExtensionId: string): any;
/**
* close the add context add on dialog
* @param guestConnection - the guest connection
*/
static closeAddContextAddOnBar(guestConnection: any): any;
/**
* set the selected assets
* @param guestConnection - the guest connection
* @param extensionId - the extension id of the content select content add ons, this id will be used to identify the content select content add ons
* @param assets - the selected assets
*/
static selectContentExtensionSetSelectedAssets(guestConnection: any, extensionId: string, assets: Asset[]): any;
/**
* sync the selected assets
* @param guestConnection - the guest connection
* @returns the selected assets and the total count of left assets
*/
static selectContentExtensionSync(guestConnection: any): Promise<{
selectedAssets: Asset[];
selectionLimit: number;
}>;
}