Class Index | Minimal

Classes


Class jabberwerx.Rendezvousable

A mixin for participating in a jabberwerx.Rendezvous.

Class Summary
Constructor Attributes Constructor Name and Description
 
Field Summary
Field Attributes Field Name and Description
<static>  
jabberwerx.Rendezvousable.rendezvousContext
The current rendezvous context object.
Method Summary
Method Attributes Method Name and Description
<static>  
jabberwerx.Rendezvousable.finishRendezvous()

Ends this controller's rendezvous processing.

<static>  
jabberwerx.Rendezvousable.startRendezvous(ctx)

Starts this controller's rendezvous processing.

Class Detail
jabberwerx.Rendezvousable()
See:
jabberwerx.JWBase.mixin
Field Detail
<static> {jabberwerx.Rendezvous} jabberwerx.Rendezvousable.rendezvousContext
The current rendezvous context object.
Method Detail
<static> jabberwerx.Rendezvousable.finishRendezvous()

Ends this controller's rendezvous processing. This method calls jabberwerx.Rendezvous.finish on the set context (if any), then removes the context.

Mixins MAY override this method to perform known completion logic, but MUST call "this._super()" or the behavior is undefined.


<static> {Boolean} jabberwerx.Rendezvousable.startRendezvous(ctx)

Starts this controller's rendezvous processing. This method remembers the context Rendezvous object, then returns false

Mixins SHOULD override this method to perform the actual startup logic, and MUST call "this._super(ctx)" or the behavior is undefined.

Parameters:
{jabberwerx.Rendezvous} ctx
The rendezvous context
Returns:
{Boolean} true if this controller's rendezvous work is in progress

Documentation generated by JsDoc Toolkit 2.4.0 on Wed Apr 02 2014 13:23:42 GMT-0600 (MDT)