Converse converse.js

API Documentation

Class: TimedHandler

TimedHandler()

PrivateClass: Strophe.TimedHandler 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 Strophe.Connection.addTimedHandler() and Strophe.Connection.deleteTimedHandler().

Constructor

new TimedHandler()

PrivateConstructor: Strophe.TimedHandler Create and initialize a new Strophe.TimedHandler object.

Parameters: (Integer) period - The number of milliseconds to wait before the handler is called. (Function) handler - The callback to run when the handler fires. This function should take no arguments.

Returns: A new Strophe.TimedHandler object.

Source:

Methods

reset()

PrivateFunction: reset Reset the last called time for the Strophe.TimedHandler.

Source:

run()

PrivateFunction: run Run the callback for the Strophe.TimedHandler.

Returns: true if the Strophe.TimedHandler should be called again, and false otherwise.

Source:

toString()

PrivateFunction: toString Get a string representation of the Strophe.TimedHandler object.

Returns: The string representation.

Source: