Package com.pusher.client.user

Interface User

All Known Implementing Classes:

InternalUser

public interface User

An object that represents a user on a Pusher connection. An implementation of this interface is returned when you call Pusher.user().

Method Summary

Modifier and Type	Method	Description
void	bind(java.lang.String eventName, SubscriptionEventListener listener)	Binds a SubscriptionEventListener to an event.
void	bindGlobal(SubscriptionEventListener listener)	Binds a SubscriptionEventListener to all events.
void	unbind(java.lang.String eventName, SubscriptionEventListener listener)	Unbinds a previously bound SubscriptionEventListener from an event.
void	unbindGlobal(SubscriptionEventListener listener)	Unbinds a previously bound SubscriptionEventListener from global events.
java.lang.String	userId()

Method Detail

userId

java.lang.String userId()

Returns:

The user id of the signed in user. Null if no user is signed in;

bind

void bind(java.lang.String eventName,
          SubscriptionEventListener listener)

Binds a SubscriptionEventListener to an event. The SubscriptionEventListener will be notified whenever the specified event is received for this user.

Parameters:

eventName - The name of the event to listen to.

listener - A listener to receive notifications when the event is received.

Throws:

java.lang.IllegalArgumentException - If either of the following are true:

• The name of the event is null.
• The SubscriptionEventListener is null.

bindGlobal

void bindGlobal(SubscriptionEventListener listener)

Binds a SubscriptionEventListener to all events. The SubscriptionEventListener will be notified whenever an event is received for this user.

Parameters:

listener - A listener to receive notifications when the event is received.

Throws:

java.lang.IllegalArgumentException - If the SubscriptionEventListener is null.

unbind

void unbind(java.lang.String eventName,
            SubscriptionEventListener listener)

Unbinds a previously bound SubscriptionEventListener from an event. The SubscriptionEventListener will no longer be notified whenever the specified event is received for this user.

Parameters:

eventName - The name of the event to stop listening to.

listener - The listener to unbind from the event.

Throws:

java.lang.IllegalArgumentException - If either of the following are true:

• The name of the event is null.
• The SubscriptionEventListener is null.

unbindGlobal

void unbindGlobal(SubscriptionEventListener listener)

Unbinds a previously bound SubscriptionEventListener from global events. The SubscriptionEventListener will no longer be notified whenever the any event is received for this user.

Parameters:

listener - The listener to unbind from the event.

Throws:

java.lang.IllegalArgumentException - If the SubscriptionEventListener is null.