@microsoft/live-share v1.4.0

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 @microsoft/live-share --save

or using Yarn:

yarn add @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 lerna to hoist and build all dependencies.

How to use this extension

• This package depends on Teams JS SDK. The version of @microsoft/teams-js you use in your app must match the one used in this project.

import { ... } from "fluid-framework";
import { TeamsFluidClient } from "@microsoft/live-share";
import * as microsoftTeams from "@microsoft/teams-js";

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

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

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

Code samples

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:

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 opencode@microsoft.com 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 secure@microsoft.com. 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.