Converse converse.js

API Documentation

Class: TimedHandler

Strophe.TimedHandler(period, handler)

Private helper class for managing timed handlers.

A Strophe.TimedHandler encapsulates a user provided callback that should be called after a certain period of time or at regular intervals. The return value of the callback determines whether the Strophe.TimedHandler will continue to fire.

Users will not use Strophe.TimedHandler objects directly, but instead they will use addTimedHandler() and deleteTimedHandler().

Constructor

new TimedHandler(period, handler)

Create and initialize a new Strophe.TimedHandler object.

Parameters:
Name Type Description
period number

The number of milliseconds to wait before the handler is called.
handler function

The callback to run when the handler fires. This function should take no arguments.
Source:

Methods

reset()

Reset the last called time for the Strophe.TimedHandler.

Source:

run() → {boolean}

Run the callback for the Strophe.TimedHandler.

Source:
Returns:

Returns the result of running the handler, which is true if the Strophe.TimedHandler should be called again, and false otherwise.

Type
boolean

toString() → {string}

Get a string representation of the Strophe.TimedHandler object.

Source:
Returns:
Type
string