Usage

Import it

import { Engage, InitConfig, TagUserInfo } from "teamviewer-engage-sdk";

Initialization

You may initialize the library any time during the life of your application.

Engage.initPlugin({ initConfig: init });

let init = new InitConfig(
  "tenantId",
  "token",
  "serverURL", 
  "cdnServerURL", 
  chatOverlayVisibility: Bool,
  "overlayBackgroundColor(<Hex Color Code> - optional)",
  "controlsColor(<Hex Color Code> - optiona)");

Engage.startCoBrowse()

To stop co-browsing you should use

Engage.stopCoBrowse()

To tag a user you must enter the user info first

let userInfo = new TagUserInfo("id", "email", "firstName", "lastName", [
    "labels",
  ]);

Engage.tagUser({ tagUserInfo: userInfo })

To clear a user you should use

Engage.clearUser()
← InstallationReference →