LiveShareHost class

Package:

@microsoft/teams-js

Live Share host implementation for connecting to real-time collaborative sessions. Designed for use with the LiveShareClient class in the @microsoft/live-share package. Learn more at https://aka.ms/teamsliveshare

Remarks

The LiveShareClient class from Live Share uses the hidden API's to join/manage the session. To create a new LiveShareHost instance use the static LiveShareHost.create() function.

Methods

create()

Factories a new LiveShareHost instance for use with the LiveShareClient class in the @microsoft/live-share package.

Method Details

create()

Factories a new LiveShareHost instance for use with the LiveShareClient class in the @microsoft/live-share package.

static function create(): LiveShareHost

Returns

LiveShareHost

Remarks

app.initialize() must first be called before using this API. This API can only be called from meetingStage or sidePanel contexts.