Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note

Desk Phone API features described in this section are deprecated and supported only on the following models: D40, d45, d50, d60, d62, d65, d70

digium.event.fire

Description

Fire an event of the given eventName and pass your eventData onto any callback that may be observing the event. Note: the list of Digium eventNames cannot be fired except by the system.

Basic Example: 

Code Block
digium.event.fire(parameters);

Parameters

Name

Required

Type

Default

Description

eventName

Yes

string

String that identifies the event type. Event type can either be from this list if you are using digium.event.observe, or from your own list if you're using digium.event.fire to fire your own event. 

eventData

Yes

object

Object passed to any callbacks listening for this event. eventData can contain a 'callback' property that will be executed when an event named eventName.response (for example, contacts.forwardVM.response) is sent with the same messageId.

messageId

No

object

Unique ID for the message. If messageId is not specified one will be generated automatically.

Tip

A full list of system eventNames can be found here