Package com.pusher.client.channel

Interface Channel

All Known Subinterfaces:

PresenceChannel, PrivateChannel, PrivateEncryptedChannel

public interface Channel

An object that represents a Pusher channel. An implementation of this interface is returned when you call Pusher.subscribe(String) or Pusher.subscribe(String, ChannelEventListener, String...) .

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.
java.lang.String	getName()	Gets the name of the Pusher channel that this object represents.
boolean	isSubscribed()
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.

Method Detail

getName

java.lang.String getName()

Gets the name of the Pusher channel that this object represents.

Returns:

The name of the channel.

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 on this channel.

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.

java.lang.IllegalStateException - If the channel has been unsubscribed by calling Pusher.unsubscribe(String). This puts the Channel in a terminal state from which it can no longer be used. To resubscribe, call Pusher.subscribe(String) or Pusher.subscribe(String, ChannelEventListener, String...) again to receive a fresh Channel instance.

bindGlobal

void bindGlobal(SubscriptionEventListener listener)

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

Parameters:

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

Throws:

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

java.lang.IllegalStateException - If the channel has been unsubscribed by calling Pusher.unsubscribe(String). This puts the Channel in a terminal state from which it can no longer be used. To resubscribe, call Pusher.subscribe(String) or Pusher.subscribe(String, ChannelEventListener, String...) again to receive a fresh Channel instance.

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 on this channel.

Calling this method does not unsubscribe from the channel even if there are no more SubscriptionEventListeners bound to it. If you want to unsubscribe from the channel completely, call Pusher.unsubscribe(String). It is not necessary to unbind your SubscriptionEventListeners first.

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.

java.lang.IllegalStateException - If the channel has been unsubscribed by calling Pusher.unsubscribe(String). This puts the Channel in a terminal state from which it can no longer be used. To resubscribe, call Pusher.subscribe(String) or Pusher.subscribe(String, ChannelEventListener, String...) again to receive a fresh Channel instance.

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 on this channel.

Calling this method does not unsubscribe from the channel even if there are no more SubscriptionEventListeners bound to it. If you want to unsubscribe from the channel completely, call Pusher.unsubscribe(String). It is not necessary to unbind your SubscriptionEventListeners first.

Parameters:

listener - The listener to unbind from the event.

Throws:

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

java.lang.IllegalStateException - If the channel has been unsubscribed by calling Pusher.unsubscribe(String). This puts the Channel in a terminal state from which it can no longer be used. To resubscribe, call Pusher.subscribe(String) or Pusher.subscribe(String, ChannelEventListener, String...) again to receive a fresh Channel instance.

isSubscribed

boolean isSubscribed()

Returns:

Whether or not the channel is subscribed.