@microsoft/live-share

Microsoft Live Share

Easily create a collaboration app in Teams with Fluid Framework.

You can find our API reference documentation at aka.ms/livesharedocs.

Installing

To add the latest version of the SDK to your application using NPM:

npm install fluid-framework @fluidframework/azure-client @microsoft/live-share --save

or using Yarn:

yarn add fluid-framework @fluidframework/azure-client @microsoft/live-share

Building the extension

After cloning the GitHub repository, navigate to the root folder and perform:

npm install
npm run build

This will use npm workspaces to hoist and build all dependencies.

How to use this extension

• Teams apps that use this package depend on Teams JS SDK. The version of @microsoft/teams-js you use in your app must match the one used in this project (see the below version compatibility chart).

import { ... } from "fluid-framework";
import { LiveShareClient } from "@microsoft/live-share";
import { app, LiveShareHost } from "@microsoft/teams-js";

// Initialize Teams Client SDK
await app.initialize();

// Define Fluid schema
const schema = {
    // Your initial SharedObject for your app
    initialObjects: {
        exampleMap: SharedMap,
        ...,
    },
};
// create space based on Teams context
const host = LiveShareHost.create();
const client = new LiveShareClient(host);
const { container } = await client.joinContainer(schema);

...
// listen to and send events on container.initialObjects.<DDS>
...

Features

Live Share has several features that make building collaborative apps easier than ever, including:

• LiveShareClient: Connect to a Fluid container associated with a Microsoft Teams meeting.
• LivePresence: Track who is using your app during a meeting and associate custom metadata for each user (e.g., camera position).
• LiveState: Synchronize a JSON-serializable value for maintaining consistent application state across clients.
• LiveTimer: Build a collaborative countdown timer.
• LiveEvent: Send one-time, stateless JSON-serializable values to each user in the session.
• LiveFollowMode (beta): Easily integrate features to present to all, follow specific users, and suspend/resume following.

Code samples

Sample name	Description	Javascript
Dice Roller	Enable all connected clients to roll a dice and view the result.	View
Agile Poker	Enable all connected clients to play an Agile Poker planning activity.	View

Package Compatibility

The Live Share SDK contains dependencies for @microsoft/teams-js and fluid-framework packages among others. Both of these packages are sensitive to the package version your app any libraries use. You will likely run into issues if the package version your app uses doesn't match the version other libraries you depend on use.

It is critical that your app use the package dependencies listed in the table below. Lookup the version of the @microsoft/live-share you're using and set any other dependencies in your package.json file to match:

@microsoft/live-share	@microsoft/teams-js	fluid-framework	@microsoft/live-share-*	@fluidframework/azure-client	@microsoft/TeamsFx	@microsoft/TeamsFx-react
^1.0.0	^2.11.0	^1.2.3	^1.0.0	^1.0.0	^2.5.0	^2.5.0

Contributing

There are several ways you can contribute to this project:

• Submit bugs and help us verify fixes as they are checked in.
• Review the source code changes.
• Engage with other Live Share developers on StackOverflow.
• Contribute bug fixes.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [e-mail] with any additional questions or comments.

Reporting Security Issues

Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) at [e-mail]. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the MSRC PGP key, can be found in the Security TechCenter.

Copyright (c) Microsoft Corporation. All rights reserved.

Licensed under a special Microsoft License.