Share via

PageInfo interface

  • Reference
Package:
@microsoft/teams-js

Represents Page information.

Properties

frameContext

The context where page url is loaded (content, task, setting, remove, sidePanel)
id

The developer-defined unique ID for the page this content points to.
isBackgroundLoad

Indicates whether the page is being loaded in the background as part of an opt-in performance enhancement.
isFullScreen

Indication whether the page is in full-screen mode.
isMultiWindow

Indication whether the page is in a pop out window
renderingSurface

The mode or surface where the page is rendered (e.g. sidePanel, meetingStage, etc.) This will be used by the app developers in future to know where in the host the app is rendered instead of the frameContext.
sourceOrigin

Source origin from where the page is opened
subPageId

The developer-defined unique ID for the sub-page this content points to. This field should be used to restore to a specific state within a page, such as scrolling to or activating a specific piece of content.

Property Details

frameContext

The context where page url is loaded (content, task, setting, remove, sidePanel)

frameContext: FrameContexts

Property Value

FrameContexts

id

The developer-defined unique ID for the page this content points to.

id: string

Property Value

string

isBackgroundLoad

Indicates whether the page is being loaded in the background as part of an opt-in performance enhancement.

isBackgroundLoad?: boolean

Property Value

boolean

isFullScreen

Indication whether the page is in full-screen mode.

isFullScreen?: boolean

Property Value

boolean

isMultiWindow

Indication whether the page is in a pop out window

isMultiWindow?: boolean

Property Value

boolean

renderingSurface

The mode or surface where the page is rendered (e.g. sidePanel, meetingStage, etc.) This will be used by the app developers in future to know where in the host the app is rendered instead of the frameContext.

renderingSurface?: copilotSidePanel

Property Value

copilotSidePanel

sourceOrigin

Source origin from where the page is opened

sourceOrigin?: string

Property Value

string

subPageId

The developer-defined unique ID for the sub-page this content points to. This field should be used to restore to a specific state within a page, such as scrolling to or activating a specific piece of content.

subPageId?: string

Property Value

string