Smart Polling

event  1.0.0

Smart Polling > event > Subscriber
Search:
 
Filters

Class Subscriber

Stores the subscriber information to be used when the event fires.

Constructor

Subscriber ( fn , context , args* )
Parameters:
fn <Function> The wrapped function to execute
context <Object> The value of the keyword 'this' in the listener
args* <Array> 0..n additional arguments to supply the listener

Properties

args - Array

Optional additional arguments supplied to subscribe(). If present, these will be appended to the arguments supplied to fire()

context - Object

Optional 'this' keyword for the listener

fn - Function

The callback that will be execute when the event fires This is wrapped by Y.rbind if obj was supplied.

id - String

Unique subscriber id

wrappedFn - Function

} fn bound to obj with additional arguments applied via Y.rbind

Methods

contains

boolean contains ( fn , context )
Returns true if the fn and obj match this objects properties. Used by the unsubscribe method to match the right subscriber.
Parameters:
fn <Function> the function to execute
context <Object> optional 'this' keyword for the listener
Returns: boolean
true if the supplied arguments match this subscriber's signature.

notify

void notify ( defaultContext , args , ce )
Executes the subscriber.
Parameters:
defaultContext <object> The execution context if not overridden by the subscriber
args <Array> Arguments array for the subscriber
ce <Event.Custom> The custom event that sent the notification
Returns: void

toString

void toString ( )
Returns: void

Properties

Copyright © 2009 Yahoo! Inc. All rights reserved.