IAppWindow interface

Package:

@microsoft/teams-js

Represents a window or frame within the host app.

Methods

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

Method Details

addEventListener(string, Function)

Add a listener that will be called when an event is received from this AppWindow.

function addEventListener(type: string, listener: Function)

Parameters

type

string

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

listener

Function

The listener that will be called

postMessage(any, onCompleteFunctionType)

Send a message to the AppWindow.

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.