AllPagesHelpers

API reference for the AllPagesHelpers type.

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.

Helpers for use when reading all pages of the design.

Methods

openPagefunction

Required

Parameters

pageRefPageRef

Required

A reference to a page.

For more information, see PageRef.

callbackDesignOpenPageCallback<Page>

Required

A callback for operating on a page of the design.

Parameters

responseDesignEditing.OpenPageResult<Page>

Required

Result received by the openPage callback.

pageDesignEditing.Page

Required

The 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".

helpersPageHelpers

Required

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

For more information, see PageHelpers.

Returns

Promise<void>

Returns

The response from openPage indicating whether the callback was executed. This is a Promise that resolves with the following object:

The response from openPage if the callback was executed.

statusstring

The only valid value is "executed".

The response from openPage if the callback was not executed.

statusstring

The only valid value is "skipped".

reasonstring

Reason that the callback was not executed.