Classes
- Class: ThingIt
Interfaces
@thing-it/client-api
- Table of contents
  - Classes
  - Interfaces
Classes
- Class: ThingIt
Interfaces
@thing-it/client-api
- Table of contents
  - Classes
  - Interfaces
Classes
Enums
- Enumeration: UsageEventState
  - Table of contents
  - Enumeration Members
Interfaces
@thing-it/client-api
- Table of contents

@thing-it/client-api / Exports

Classes
- Class: ThingIt
Interfaces
@thing-it/client-api
- Table of contents
  - Classes
  - Interfaces
Classes
- Class: ThingIt
Interfaces
@thing-it/client-api
- Table of contents
  - Classes
  - Interfaces

@thing-it/client-api / Exports

Classes
- Class: ThingIt
Interfaces
@thing-it/client-api
- Table of contents
  - Classes
  - Interfaces

@thing-it/client-api / Exports

Classes

@thing-it/client-api / Exports / ThingIt

Class: ThingIt

Export

Constructors

constructor

• new ThingIt(options)

Creates an instance of ThingIt.

Memberof

ThingIt

Parameters

Name	Type
`options`	`ClientOptions`

Defined in

client-api.ts:45

Properties

clientOptions

• Private clientOptions: ClientOptions

Defined in

client-api.ts:35

isExternalToken

• Private isExternalToken: boolean = false

Defined in

client-api.ts:37

tokenInfo

• Private tokenInfo: undefined | TokenInfo

Defined in

client-api.ts:36

Methods

executeMeshQuery

▸ executeMeshQuery(meshId, query, options?): Promise<any>

Execute a query on the input mesh

Memberof

ThingIt

Parameters

Name	Type
`meshId`	`string`
`query`	`any`
`options?`	`RequestOptions`

Returns

Promise<any>

Defined in

client-api.ts:269

get

▸ get(url, options): Promise<any>

Generic method to execute a GET request

Memberof

ThingIt

Parameters

Name	Type
`url`	`string`
`options`	`RequestOptions`

Returns

Promise<any>

Defined in

client-api.ts:208

getAccessToken

▸ Private getAccessToken(): undefined | string

Memberof

ThingIt

Returns

undefined | string

Defined in

client-api.ts:386

getCurrentDeskOccupancy

▸ getCurrentDeskOccupancy(meshId, buildingId, options?): Promise<any>

Get current desk occupancy in the input mesh and building

Memberof

ThingIt

Parameters

Name	Type
`meshId`	`string`
`buildingId`	`string`
`options?`	`RequestOptions`

Returns

Promise<any>

Defined in

client-api.ts:178

getCurrentSpaceOccupancy

▸ getCurrentSpaceOccupancy(meshId, buildingId, options?): Promise<any>

Get current space occupancy in the input mesh and building

Memberof

ThingIt

Parameters

Name	Type
`meshId`	`string`
`buildingId`	`string`
`options?`	`RequestOptions`

Returns

Promise<any>

Defined in

client-api.ts:147

getFullUrl

▸ Private getFullUrl(url): string

Memberof

ThingIt

Parameters

Name	Type
`url`	`string`

Returns

string

Defined in

client-api.ts:398

getHeaders

▸ Private getHeaders(options): Headers

Memberof

ThingIt

Parameters

Name	Type
`options`	`RequestOptions`

Returns

Headers

Defined in

client-api.ts:412

getUpdatedToken

▸ getUpdatedToken(): Promise<undefined | TokenInfo>

Get the updated access token

Memberof

ThingIt

Returns

Promise<undefined | TokenInfo>

Defined in

client-api.ts:327

initPostMessageListener

▸ Private initPostMessageListener(): void

Memberof

ThingIt

Returns

void

Defined in

client-api.ts:433

listBuildings

▸ listBuildings(meshId, options?): Promise<any>

List the buildings in the input mesh

Example

const meshId = 'ab12314';
const customer = '123123123';
thingIt = new ThingIt();
thingIt.listBuildings(meshId, {meshId, customer})

Memberof

ThingIt

Parameters

Name	Type
`meshId`	`string`
`options?`	`RequestOptions`

Returns

Promise<any>

Defined in

client-api.ts:67

listFloors

▸ listFloors(meshId, buildingId, options?): Promise<any>

List the floors in the input mesh and building

Memberof

ThingIt

Parameters

Name	Type
`meshId`	`string`
`buildingId`	`string`
`options?`	`RequestOptions`

Returns

Promise<any>

Defined in

client-api.ts:86

post

▸ post(url, body, options): Promise<any>

Generic method to execute a POST request

Memberof

ThingIt

Parameters

Name	Type
`url`	`string`
`body`	`any`
`options`	`RequestOptions`

Returns

Promise<any>

Defined in

client-api.ts:237

retrieveCurrentlyActiveBookings

▸ retrieveCurrentlyActiveBookings(meshId, buildingId, options?): Promise<any>

Retrieve currently active bookings in the input mesh and building

Memberof

ThingIt

Parameters

Name	Type
`meshId`	`string`
`buildingId`	`string`
`options?`	`RequestOptions`

Returns

Promise<any>

Defined in

client-api.ts:109

retrieveToken

▸ retrieveToken(): Promise<undefined | TokenInfo>

Retrieve the access token

Memberof

ThingIt

Returns

Promise<undefined | TokenInfo>

Defined in

client-api.ts:285

setToken

▸ setToken(tokenInfo): void

Set the token

Memberof

ThingIt

Parameters

Name	Type
`tokenInfo`	`TokenInfo`

Returns

void

Defined in

client-api.ts:370

Interfaces

@thing-it/client-api / Exports / AuthenticationInfo

Interface: AuthenticationInfo

Properties

apiKey

• Optional apiKey: string

Defined in

client-api.ts:6

clientId

• clientId: string

Defined in

client-api.ts:2

clientSecret

• clientSecret: string

Defined in

client-api.ts:3

password

• password: string

Defined in

client-api.ts:5

username

• username: string

Defined in

client-api.ts:4

@thing-it/client-api / Exports / ClientOptions

Interface: ClientOptions

Properties

authInfo
customer
host
mesh

Properties

authInfo

• Optional authInfo: AuthenticationInfo

Defined in

client-api.ts:10

customer

• Optional customer: string

Defined in

client-api.ts:12

host

• host: string

Defined in

client-api.ts:11

mesh

• Optional mesh: string

Defined in

client-api.ts:13

@thing-it/client-api / Exports / RequestOptions

Interface: RequestOptions

Properties

customer
mesh

Properties

customer

• customer: string

Defined in

client-api.ts:24

mesh

• mesh: string

Defined in

client-api.ts:25

@thing-it/client-api / Exports / TokenInfo

Interface: TokenInfo

Properties

access_token
expires_in
refresh_token
token_type

Properties

access_token

• access_token: string

Defined in

client-api.ts:17

expires_in

• expires_in: number

Defined in

client-api.ts:19

refresh_token

• refresh_token: string

Defined in

client-api.ts:20

token_type

• token_type: string

Defined in

client-api.ts:18

@thing-it/client-api / Exports

@thing-it/client-api

Classes

ThingIt

Interfaces

AuthenticationInfo
ClientOptions
RequestOptions
TokenInfo

Classes

@thing-it/client-api / Exports / ThingIt

Class: ThingIt

Export

Constructors

constructor

Properties

clientOptions
isExternalToken
tokenInfo

Methods

executeMeshQuery
get
getAccessToken
getCurrentDeskOccupancy
getCurrentSpaceOccupancy
getFullUrl
getHeaders
getUpdatedToken
initPostMessageListener
isApiReady
listBuildings
listFloors
post
postMessage
retrieveCurrentlyActiveBookings
retrieveToken
route
setToken

Constructors

constructor

• new ThingIt(options)

Creates an instance of ThingIt.

Memberof

ThingIt

Parameters

Name	Type
`options`	`ClientOptions`

Defined in

client-api.ts:45

Properties

clientOptions

• Private clientOptions: ClientOptions

Defined in

client-api.ts:35

isExternalToken

• Private isExternalToken: boolean = false

Defined in

client-api.ts:37

tokenInfo

• Private tokenInfo: undefined | TokenInfo

Defined in

client-api.ts:36

Methods

executeMeshQuery

▸ executeMeshQuery(meshId, query, options?): Promise<any>

Execute a query on the input mesh

Memberof

ThingIt

Parameters

Name	Type
`meshId`	`string`
`query`	`any`
`options?`	`RequestOptions`

Returns

Promise<any>

Defined in

client-api.ts:269

get

▸ get(url, options): Promise<any>

Generic method to execute a GET request

Memberof

ThingIt

Parameters

Name	Type
`url`	`string`
`options`	`RequestOptions`

Returns

Promise<any>

Defined in

client-api.ts:208

getAccessToken

▸ Private getAccessToken(): undefined | string

Memberof

ThingIt

Returns

undefined | string

Defined in

client-api.ts:428

getCurrentDeskOccupancy

▸ getCurrentDeskOccupancy(meshId, buildingId, options?): Promise<any>

Get current desk occupancy in the input mesh and building

Memberof

ThingIt

Parameters

Name	Type
`meshId`	`string`
`buildingId`	`string`
`options?`	`RequestOptions`

Returns

Promise<any>

Defined in

client-api.ts:178

getCurrentSpaceOccupancy

▸ getCurrentSpaceOccupancy(meshId, buildingId, options?): Promise<any>

Get current space occupancy in the input mesh and building

Memberof

ThingIt

Parameters

Name	Type
`meshId`	`string`
`buildingId`	`string`
`options?`	`RequestOptions`

Returns

Promise<any>

Defined in

client-api.ts:147

getFullUrl

▸ Private getFullUrl(url): string

Memberof

ThingIt

Parameters

Name	Type
`url`	`string`

Returns

string

Defined in

client-api.ts:440

getHeaders

▸ Private getHeaders(options): Headers

Memberof

ThingIt

Parameters

Name	Type
`options`	`RequestOptions`

Returns

Headers

Defined in

client-api.ts:454

getUpdatedToken

▸ getUpdatedToken(): Promise<undefined | TokenInfo>

Get the updated access token

Memberof

ThingIt

Returns

Promise<undefined | TokenInfo>

Defined in

client-api.ts:327

initPostMessageListener

▸ Private initPostMessageListener(): void

Memberof

ThingIt

Returns

void

Defined in

client-api.ts:475

isApiReady

▸ isApiReady(): Promise<boolean>

Check if the API is ready for use

Memberof

ThingIt

Returns

Promise<boolean>

Defined in

client-api.ts:400

listBuildings

▸ listBuildings(meshId, options?): Promise<any>

List the buildings in the input mesh

Example

const meshId = 'ab12314';
const customer = '123123123';
thingIt = new ThingIt();
thingIt.listBuildings(meshId, {meshId, customer})

Memberof

ThingIt

Parameters

Name	Type
`meshId`	`string`
`options?`	`RequestOptions`

Returns

Promise<any>

Defined in

client-api.ts:67

listFloors

▸ listFloors(meshId, buildingId, options?): Promise<any>

List the floors in the input mesh and building

Memberof

ThingIt

Parameters

Name	Type
`meshId`	`string`
`buildingId`	`string`
`options?`	`RequestOptions`

Returns

Promise<any>

Defined in

client-api.ts:86

post

▸ post(url, body, options): Promise<any>

Generic method to execute a POST request

Memberof

ThingIt

Parameters

Name	Type
`url`	`string`
`body`	`any`
`options`	`RequestOptions`

Returns

Promise<any>

Defined in

client-api.ts:237

postMessage

▸ Private postMessage(message): void

Memberof

ThingIt

Parameters

Name	Type
`message`	`any`

Returns

void

Defined in

client-api.ts:501

retrieveCurrentlyActiveBookings

▸ retrieveCurrentlyActiveBookings(meshId, buildingId, options?): Promise<any>

Retrieve currently active bookings in the input mesh and building

Memberof

ThingIt

Parameters

Name	Type
`meshId`	`string`
`buildingId`	`string`
`options?`	`RequestOptions`

Returns

Promise<any>

Defined in

client-api.ts:109

retrieveToken

▸ retrieveToken(): Promise<undefined | TokenInfo>

Retrieve the access token

Memberof

ThingIt

Returns

Promise<undefined | TokenInfo>

Defined in

client-api.ts:285

route

▸ route(routeId, params): void

Navigates to the specified kiosk route

Memberof

ThingIt

Parameters

Name	Type
`routeId`	`string`
`params`	`Object`

Returns

void

Defined in

client-api.ts:371

setToken

▸ setToken(tokenInfo): void

Set the token

Memberof

ThingIt

Parameters

Name	Type
`tokenInfo`	`TokenInfo`

Returns

void

Defined in

client-api.ts:385

Interfaces

@thing-it/client-api / Exports / AuthenticationInfo

Interface: AuthenticationInfo

Properties

apiKey
clientId
clientSecret
password
username

Properties

apiKey

• Optional apiKey: string

Defined in

client-api.ts:6

clientId

• clientId: string

Defined in

client-api.ts:2

clientSecret

• clientSecret: string

Defined in

client-api.ts:3

password

• password: string

Defined in

client-api.ts:5

username

• username: string

Defined in

client-api.ts:4

@thing-it/client-api / Exports / ClientOptions

Interface: ClientOptions

Properties

authInfo
customer
host
mesh

Properties

authInfo

• Optional authInfo: AuthenticationInfo

Defined in

client-api.ts:10

customer

• Optional customer: string

Defined in

client-api.ts:12

host

• host: string

Defined in

client-api.ts:11

mesh

• Optional mesh: string

Defined in

client-api.ts:13

@thing-it/client-api / Exports / RequestOptions

Interface: RequestOptions

Properties

customer
mesh

Properties

customer

• customer: string

Defined in

client-api.ts:24

mesh

• mesh: string

Defined in

client-api.ts:25

@thing-it/client-api / Exports / TokenInfo

Interface: TokenInfo

Properties

access_token
expires_in
refresh_token
token_type

Properties

access_token

• access_token: string

Defined in

client-api.ts:17

expires_in

• expires_in: number

Defined in

client-api.ts:19

refresh_token

• refresh_token: string

Defined in

client-api.ts:20

token_type

• token_type: string

Defined in

client-api.ts:18

@thing-it/client-api / Exports

@thing-it/client-api

Classes

ThingIt

Interfaces

AuthenticationInfo
ClientOptions
RequestOptions
TokenInfo

Classes

@thing-it/client-api / Exports / ThingIt

Class: ThingIt

Export

Implements

ServerAPI

Constructors

constructor

Properties

clientOptions
isExternalToken
tokenInfo
usageEventAPI

Methods

broadcastScreenshot
broadcastUserInteraction
executeMeshQuery
get
getAccessToken
getCurrentDeskOccupancy
getCurrentSpaceOccupancy
getFullUrl
getHeaders
getUpdatedToken
initPostMessageListener
isApiReady
listBuildings
listFloors
post
postMessage
retrieveCurrentlyActiveBookings
retrieveToken
route
setToken
startUsageEvent

Constructors

constructor

• new ThingIt(options)

Creates an instance of ThingIt.

Memberof

ThingIt

Parameters

Name	Type
`options`	`ClientOptions`

Defined in

client-api.ts:51

Properties

clientOptions

• Private clientOptions: ClientOptions

Defined in

client-api.ts:36

isExternalToken

• Private isExternalToken: boolean = false

Defined in

client-api.ts:41

tokenInfo

• Private tokenInfo: undefined | TokenInfo

Defined in

client-api.ts:40

usageEventAPI

• Private usageEventAPI: UsageEventAPI

Defined in

client-api.ts:43

Methods

broadcastScreenshot

▸ broadcastScreenshot(dataUrl): void

Broadcasts screenshot event to parent context

Memberof

ThingIt

Parameters

Name	Type
`dataUrl`	`string`

Returns

void

Defined in

client-api.ts:460

broadcastUserInteraction

▸ broadcastUserInteraction(): void

Broadcasts a user interaction event to any parent context

Memberof

ThingIt

Returns

void

Defined in

client-api.ts:446

executeMeshQuery

▸ executeMeshQuery(meshId, query, options?): Promise<any>

Execute a query on the input mesh

Memberof

ThingIt

Parameters

Name	Type
`meshId`	`string`
`query`	`any`
`options?`	`RequestOptions`

Returns

Promise<any>

Defined in

client-api.ts:285

get

▸ get(url, options): Promise<any>

Generic method to execute a GET request

Memberof

ThingIt

Parameters

Name	Type
`url`	`string`
`options`	`RequestOptions`

Returns

Promise<any>

Implementation of

ServerAPI.get

Defined in

client-api.ts:224

getAccessToken

▸ Private getAccessToken(): undefined | string

Memberof

ThingIt

Returns

undefined | string

Defined in

client-api.ts:479

getCurrentDeskOccupancy

▸ getCurrentDeskOccupancy(meshId, buildingId, options?): Promise<any>

Get current desk occupancy in the input mesh and building

Memberof

ThingIt

Parameters

Name	Type
`meshId`	`string`
`buildingId`	`string`
`options?`	`RequestOptions`

Returns

Promise<any>

Defined in

client-api.ts:193

getCurrentSpaceOccupancy

▸ getCurrentSpaceOccupancy(meshId, buildingId, options?): Promise<any>

Get current space occupancy in the input mesh and building

Memberof

ThingIt

Parameters

Name	Type
`meshId`	`string`
`buildingId`	`string`
`options?`	`RequestOptions`

Returns

Promise<any>

Defined in

client-api.ts:161

getFullUrl

▸ Private getFullUrl(url, base): string

Memberof

ThingIt

Parameters

Name	Type
`url`	`string`
`base`	`string`

Returns

string

Defined in

client-api.ts:491

getHeaders

▸ Private getHeaders(options): Headers

Memberof

ThingIt

Parameters

Name	Type
`options`	`RequestOptions`

Returns

Headers

Defined in

client-api.ts:505

getUpdatedToken

▸ getUpdatedToken(): Promise<undefined | TokenInfo>

Get the updated access token

Memberof

ThingIt

Returns

Promise<undefined | TokenInfo>

Defined in

client-api.ts:343

initPostMessageListener

▸ Private initPostMessageListener(): void

Memberof

ThingIt

Returns

void

Defined in

client-api.ts:526

isApiReady

▸ isApiReady(): Promise<boolean>

Check if the API is ready for use

Memberof

ThingIt

Returns

Promise<boolean>

Defined in

client-api.ts:416

listBuildings

▸ listBuildings(meshId, options?): Promise<any>

List the buildings in the input mesh

Example

const meshId = 'ab12314';
const customer = '123123123';
thingIt = new ThingIt();
thingIt.listBuildings(meshId, {meshId, customer})

Memberof

ThingIt

Parameters

Name	Type
`meshId`	`string`
`options?`	`RequestOptions`

Returns

Promise<any>

Defined in

client-api.ts:78

listFloors

▸ listFloors(meshId, buildingId, options?): Promise<any>

List the floors in the input mesh and building

Memberof

ThingIt

Parameters

Name	Type
`meshId`	`string`
`buildingId`	`string`
`options?`	`RequestOptions`

Returns

Promise<any>

Defined in

client-api.ts:97

post

▸ post(url, body, options): Promise<any>

Generic method to execute a POST request

Memberof

ThingIt

Parameters

Name	Type
`url`	`string`
`body`	`any`
`options`	`RequestOptions`

Returns

Promise<any>

Implementation of

ServerAPI.post

Defined in

client-api.ts:253

postMessage

▸ Private postMessage(message): void

Memberof

ThingIt

Parameters

Name	Type
`message`	`any`

Returns

void

Defined in

client-api.ts:552

retrieveCurrentlyActiveBookings

▸ retrieveCurrentlyActiveBookings(meshId, buildingId, options?): Promise<any>

Retrieve currently active bookings in the input mesh and building

Memberof

ThingIt

Parameters

Name	Type
`meshId`	`string`
`buildingId`	`string`
`options?`	`RequestOptions`

Returns

Promise<any>

Defined in

client-api.ts:123

retrieveToken

▸ retrieveToken(): Promise<undefined | TokenInfo>

Retrieve the access token

Memberof

ThingIt

Returns

Promise<undefined | TokenInfo>

Defined in

client-api.ts:301

route

▸ route(routeId, params): void

Navigates to the specified kiosk route

Memberof

ThingIt

Parameters

Name	Type
`routeId`	`string`
`params`	`Object`

Returns

void

Defined in

client-api.ts:387

setToken

▸ setToken(tokenInfo): void

Set the token

Memberof

ThingIt

Parameters

Name	Type
`tokenInfo`	`TokenInfo`

Returns

void

Defined in

client-api.ts:401

startUsageEvent

▸ startUsageEvent(path, timeout?): UsageEvent

Parameters

Name	Type	Default value
`path`	`string`	`undefined`
`timeout`	`number`	`10000`

Returns

UsageEvent

Defined in

client-api.ts:437

@thing-it/client-api / Exports / UsageEvent

Class: UsageEvent

Constructors

constructor

Properties

agent
customer
data
device
deviceModel
deviceOperatingSystem
duration
eventId
mesh
namePath
parentId
sessionId
softwareVersion
start
state
ts
usageEventAPI
user
view

Methods

abort
addData
complete

Constructors

constructor

• new UsageEvent(usageEventAPI, ts, eventId, parentId, customer, mesh, user, device, deviceModel, deviceOperatingSystem, sessionId, view, softwareVersion, agent, path)

Parameters

Name	Type
`usageEventAPI`	`UsageEventAPI`
`ts`	`string`
`eventId`	`string`
`parentId`	`undefined` \| `string`
`customer`	`undefined` \| `string`
`mesh`	`undefined` \| `string`
`user`	`undefined` \| `string`
`device`	`undefined` \| `string`
`deviceModel`	`undefined` \| `string`
`deviceOperatingSystem`	`undefined` \| `string`
`sessionId`	`undefined` \| `string`
`view`	`undefined` \| `string`
`softwareVersion`	`undefined` \| `string`
`agent`	`undefined` \| `string`
`path`	`string`