Versions Compared

Key

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

digium.event.stopObserving

Description

Used to remove callbacks for an event. If callback is not passed in (which is a reference to the original observed callback), then all observed events are removed for the specified eventName.

 

Basic Example: 

 

Code Block
languagejs
 digium.event.stopObserving(parameters);

 

Parameters

 

NameRequiredTypeDefaultDescription
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. 

callback
No
object
 

Callback (OPTIONAL) to remove from the event listener. If this parameter is undefined, all callbacks registered to eventNamewill be removed.