ParentAppWindow class

Package:

@microsoft/teams-js

An object that is utilized to facilitate communication with a parent window that initiated the opening of current window. For instance, a dialog or task module would utilize it to transmit messages to the application that launched it.

Properties

Instance

Get the parent window instance.

Methods

addEventListener(string, addEventListnerFunctionType)	Add a listener that will be called when an event is received from the ParentAppWindow.
postMessage(any, onCompleteFunctionType)	Send a message to the ParentAppWindow.

Property Details

Instance

Get the parent window instance.

static IAppWindow Instance

Property Value

IAppWindow

Method Details

addEventListener(string, addEventListnerFunctionType)

Add a listener that will be called when an event is received from the ParentAppWindow.

function addEventListener(type: string, listener: addEventListnerFunctionType)

Parameters

type

string

The event to listen to. Currently the only supported type is 'message'.

listener

addEventListnerFunctionType

The listener that will be called

postMessage(any, onCompleteFunctionType)

Send a message to the ParentAppWindow.

function postMessage(message: any, onComplete?: onCompleteFunctionType)

Parameters

message

any

The message to send

onComplete

onCompleteFunctionType

The callback to know if the postMessage has been success/failed.