Client

Client

Signal bot client class.

Constructor

new Client(settingsopt)

Source:

Construct a Client.

Parameters:
Name Type Attributes Description
settings Object <optional>

The settings for the Client.

Properties
Name Type Attributes Description
dbus Object <optional>

D-Bus settings.

Properties
Name Type Attributes Default Description
connectionCheckInterval number <optional>
 5000

How frequently the connection should be checked, in milliseconds.
destination string <optional>
 org.asamk.Signal

D-Bus destination for signal-cli daemon.
type string <optional>
 system

D-Bus type. Can be system or session.

Extends

  • EventEmitter

Members

(readonly) conversations :ConversationManager

Source:

The ConversationManager belonging to this Client.

Type:

(readonly) user :ClientUser

Source:

The ClientUser belonging to this Client.

Type:

Methods

(async) connect() → {Promise.<undefined>}

Source:

Connect to the signal-cli daemon over D-Bus.

Returns:
Type
Promise.<undefined>

Events

disconnect

Source:

Disconnect event. Fires when the D-Bus connection is disconnected. The connect method must be called again afterwards in order to reconnect.

error

Source:

Error event. Fires when an error occurs.

Type:
  • Error

message

Source:

Message event. Fires when a message is received.

Type: