Skip navigation

Skip to main content

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 (and optionally updates) a specified part of the user's design.

Parameters

optionsDesignOpenOptions_2
Required

Options for configuring how the design is read.

Options for configuring how the current page of the design is read.

typestring
Required

The type of context.

The only valid value is "current_page".

Options for configuring how all pages of the design are read.

typestring
Required

The type of context.

The only valid value is "all_pages".

callbackDesignOpenCallback_2
Required

A callback for operating on the design.

A callback for operating on the current page of the design.

Parameters

sessionDesignEditing.CurrentPageSession
Required

Session received by the openDesign callback when opening the current page.

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

The only valid value is "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 session 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>

A callback for operating on all pages of the design.

Parameters

sessionDesignEditing.AllPagesSession
Required

Session received by the openDesign callback when opening all pages.

pageRefsDesignEditing.PageRefList
Required

References to all pages of the design.

For more information, see PageRefList.

helpersDesignEditing.AllPagesHelpers
Required

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

For more information, see AllPagesHelpers.

syncfunction
Required
  • 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>