Identifier for this bot, defaults to SyncBot.
Add a new type of ServiceEmitter to the client. Should the ServiceEmitter already exist on the client with the handle/name, this will do nothing.
The name of the ServiceEmitter to add.
The constructed or pre-existing ServiceEmitter or void on failure.
Add a new type of ServiceListener to the client. Should the ServiceListener already exist on the client with the handle/name, this will do nothing.
The name of the ServiceListener to add.
The constructed or pre-existing ServiceListener or void on failure.
Pass a transmission context to the emitter.
Standardised transmission context to emit.
Promise that will resolve to the id of the created message.
Connect two threads with comments about each other.
Event with the two threads specified.
What to connect, must be thread.
Resolves when connection is stored.
Create a function that will route a data payload to the specified room.
Definition of a flow to listen to.
Definition of a flow to emit to.
Function that routes the payload.
Dispatch to the specified emitter. This method exists as a shortcut to avoid having to retrieve a specific emitter before sending to it.
The ServiceEmitRequest to use. This will be dispatched to all ServiceEmitters.
An array of ServiceEmitResponses from all the ServiceEmitters.
Dispatch to a specific ServiceEmitter. This method exists as a shortcut to avoid having to retrieve a specific emitter before sending to it.
The handle of the ServiceEmitter to dispatch to.
Emitter appropriate data to send.
Data returned from the service represented by the ServiceEmitter.
Retrieve or create a data hub that can retrieve a user's data.
Name of the hub to seek.
Instantiation data for the hub.
Object which implements the data hub abstract.
Find a particular attached ServiceEmitter based upon its name.
Handle of the ServiceEmitter instance to find (name if no handle was set).
Instance of the ServiceEmitter found, or void if not found.
Find a particular attached ServiceListener based upon its handle.
Handle of the ServiceListener instance to find (name if no handle was set).
Instance of the ServiceListener found, or void if not found.
Retrieve or create a service that can understand the generic message format.
Name of the service to seek.
Instantiation data for the service.
Object which implements the generic message abstract.
Retrieve the binary path for the Node dependencies.
A string containing the absolute path.
Report an error back to the source of the event.
error to report.
source event that should be reflected into target context.
This should be called when something really goes wrong, and in-app reports fail.
Error to report.
Event that caused the error.
Record to the console some details from the event.
Event to record, will only pass on safe information.
Process a configuration file from YAML into a nested object.
The configuration file as a string.
The configuration object or void.
Awaken services and register the event processors.
Definition of a flow to listen to.
Definition of a flow to emit to.
Retrieve a ProcBotConfiguration file from a ServiceEmitter or inbuilt route.
An object detailing the service to retrieve the configuration file from, and its location.
A Promise containing configuration object should one have been found, or void.
Pass a tag creation context to the emitter.
Standardised transmission context to emit.
Promise that will resolve once the tags are sent.
Use the configuration to provide the detail requested.
Event to scrutinise and mutate.
Property to search for, must be 'user'.
Resolves to the found property.
Use the configuration or the source data to provide the detail requested.
Event to scrutinise and mutate.
Property to search for, must be 'user'.
Resolves to the found property.
Use the thread history to provide the detail requested.
Event to scrutinise and mutate.
Property to search for, must be 'thread'.
Resolves to the found property.
Use the hub service to provide the detail requested.
Event to scrutinise and mutate.
Property to search for, must be 'token'.
Resolves to the found property.
Use the source to provide the detail requested.
Event to scrutinise and mutate.
Property to search for, must be 'user'.
Resolves to the found property.
Use the environment SYNCBOT_SYSTEM_MESSAGE_ACCOUNTS to provide the detail requested.
Event to scrutinise and mutate.
Property to search for, must be 'user' or 'token'.
Resolves to the found property.
Returns an array of the tokens in a provided context
Context to data mine for tokens
Generated using TypeDoc
Creates a SyncBot using SYNCBOT_MAPPINGS and SYNCBOT_HUB_SERVICE from the environment.