Communicator

The communicator is the means by which the Javascript Adaptor talks to Sketchup

Out of the box there are 2 supported communication channels.

Communication via iFrame post message (when an iFrame is detected)
Communication via the window.sketchup object (when launched from Desktop or a Ruby extension)

Implements

TenantParent

Constructor

new Communicator(options, tenants): Communicator

Parameters

Parameter	Type
`options`	`Partial`<`CommunicatorOptions`>
`tenants`	`Tenant`[]

Returns

Communicator

Properties

options

options: CommunicatorOptions

Methods

debug()

debug(…args): void

Parameters

Parameter	Type
…`args`	`unknown`[]

Returns

void

destroy()

abstract destroy(): void

Should remove any bindings and destroy this communicator

Returns

void

registerChannel()

abstract registerChannel(channelName, consumer): void

Registers a channel name and a function to consume data from that channel

This is called internally by the bootstrapping mechanism

Parameters

Parameter	Type	Description
`channelName`	`string`	the channel to register
`consumer`	(`data`) => `void`	the consumer

Returns

void

registerTenantIFrame()

registerTenantIFrame(options): void

Registers a tenant to this communicator. This allows child iFrames to use the JSA directly

Parameters

Parameter	Type	Description
`options`	`TenantOptions`	the tenant options

Returns

void

removeChannel()

abstract removeChannel(channelName): void

Removes a channel by name. Called during disconnection to ensure that there are no dangling callback executions

Parameters

Parameter	Type	Description
`channelName`	`string`	the channel to remove

Returns

void

removeTenant()

removeTenant(tenant): void

Removes the tenant from this communicator

Parameters

Parameter	Type	Description
`tenant`	`Tenant`	the tenant

Returns

void

Implementation of

TenantParent.removeTenant

sendOnChannel()

abstract sendOnChannel(channelName, data, tenantID?): void

Sends a message on a given channel

Parameters

Parameter	Type	Description
`channelName`	`string`	the name of the channel
`data`	`unknown`	the data that should be sent
`tenantID?`	`string`	the ID of the tenant (if any)

Returns

void

Implementation of

TenantParent.sendOnChannel

updateOptions()

updateOptions(options): void

Parameters

Parameter	Type
`options`	`Partial`<`CommunicatorOptions`>

Returns

void