com.pusher.client.channel.Channel.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pusher-java-client Show documentation

This is a Java client library for Pusher, targeted at core Java and Android.

There is a newer version: 2.4.4






Channel (Pusher Java Websocket API)











Skip navigation links




Overview
Package
Class
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.pusher.client.channel
Interface Channel






All Known Subinterfaces:
PresenceChannel, PrivateChannel




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

All Methods Instance Methods Abstract Methods 

Modifier and Type
Method and Description


void
bind(java.lang.String eventName,
    SubscriptionEventListener listener)
Binds a SubscriptionEventListener to an event.



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.
















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.








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.








isSubscribed
boolean isSubscribed()

Returns:
Whether or not the channel is subscribed.














Skip navigation links




Overview
Package
Class
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method

Modifier and Type	Method and Description
`void`	`bind(java.lang.String eventName, SubscriptionEventListener listener)` Binds a `SubscriptionEventListener` to an event.
`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.