Companion API
chevron down
 

Companion API

Variable: me

Type: Companion

The Companion API provides information about the running companion application, access to permissions, and oAuth access tokens.

import { me } from "companion";
console.log("Application ID: " + me.applicationId);
if (!me.permissions.granted("access_internet")) {
   console.log("We're not allowed to access the internet :-(");
}

Interface: Companion

The Companion interface provides information about the running companion application, access to permissions, environment information and oAuth access tokens.

Properties

readonly applicationId

string

Application identifier under which the current application is running.

readonly buildId

string

Application build identifier under which the current application is running.

readonly host

Host

Information about the environment in which the companion runs

readonly permissions

Permissions

Permissions that have been granted or denied to the application.