Skip navigation

Skip to main content

On September 25th, 2024, we released v2 of the Apps SDK. To learn what’s new and how to upgrade, see Migration FAQ and Migration guide.
API reference
Intents: design
API reference

openDesign

API reference for the openDesign method.
This version of the API is a preview. Preview APIs are unstable and may change without warning. You can't release public apps using this API until it's stable.

Reads a specified part of the user's design and returns all elements in that part.

Parameters

optionsDesignContextOptions
Required

Options for configuring how the design is read.

typestring
Required

The type of context.

This must be "current_page".

callbackDesignOpenCallback
Required

A callback for operating on the design.

Parameters

sessionDesignEditing.CurrentPageResult
Required

The result of reading part of a design.

pageDesignEditing.Page
Required

The current page of the design.

A page with either fixed or unbounded dimensions.

For more information, see AbsolutePage.

Represents something that's not supported by the Apps SDK.

typestringRead-only
Required

This must be "unsupported".

helpersDesignEditing.PageHelpers
Required

These are various utilities that allow apps to do more complex operations on the page.

For more information, see PageHelpers.

syncfunction
Required

Saves any changes made during the session while keeping the transaction open.

  • Any changes in the session are only reflected in the design after this method is called.
  • Once this method is called, further changes in the session can still be made.

Returns

Promise<void>

Returns

Promise<void>

Returns

Promise<void>