Skip navigation links
A B C D E F G H I L M N O P S T U V W 

A

AuthorizationFailureException - Exception in com.pusher.client
Used to indicate an authorization failure.
AuthorizationFailureException() - Constructor for exception com.pusher.client.AuthorizationFailureException
 
AuthorizationFailureException(String) - Constructor for exception com.pusher.client.AuthorizationFailureException
 
AuthorizationFailureException(Exception) - Constructor for exception com.pusher.client.AuthorizationFailureException
 
AuthorizationFailureException(String, Exception) - Constructor for exception com.pusher.client.AuthorizationFailureException
 
authorize(String, String) - Method in interface com.pusher.client.Authorizer
Called when a channel is to be authenticated.
authorize(String, String) - Method in class com.pusher.client.util.HttpAuthorizer
 
Authorizer - Interface in com.pusher.client
Subscriptions to Private and presence channels need to be authorized.

B

bind(String, SubscriptionEventListener) - Method in interface com.pusher.client.channel.Channel
Binds a SubscriptionEventListener to an event.
bind(String, SubscriptionEventListener) - Method in class com.pusher.client.channel.impl.ChannelImpl
 
bind(String, SubscriptionEventListener) - Method in class com.pusher.client.channel.impl.PresenceChannelImpl
 
bind(String, SubscriptionEventListener) - Method in class com.pusher.client.channel.impl.PrivateChannelImpl
 
bind(ConnectionState, ConnectionEventListener) - Method in interface com.pusher.client.connection.Connection
Bind to connection events.
bind(ConnectionState, ConnectionEventListener) - Method in class com.pusher.client.connection.websocket.WebSocketConnection
 
buildUrl(String) - Method in class com.pusher.client.PusherOptions
Construct the URL for the WebSocket connection based on the options previous set on this object and the provided API key

C

Channel - Interface in com.pusher.client.channel
An object that represents a Pusher channel.
ChannelEventListener - Interface in com.pusher.client.channel
Client applications should implement this interface if they want to be notified when events are received on a public or private channel.
ChannelImpl - Class in com.pusher.client.channel.impl
 
ChannelImpl(String, Factory) - Constructor for class com.pusher.client.channel.impl.ChannelImpl
 
ChannelManager - Class in com.pusher.client.channel.impl
 
ChannelManager(Factory) - Constructor for class com.pusher.client.channel.impl.ChannelManager
 
ChannelState - Enum in com.pusher.client.channel
Used to identify the state of the channel e.g.
com.pusher.client - package com.pusher.client
Classes for connecting to Pusher, configuring the Pusher instance and authenticating subscriptions.
com.pusher.client.channel - package com.pusher.client.channel
Classes related to channels, which are subscriptions to data within Pusher, and channel event listener interfaces.
com.pusher.client.channel.impl - package com.pusher.client.channel.impl
 
com.pusher.client.connection - package com.pusher.client.connection
Classes related to the Pusher connection, connection state and monitoring connection state changes.
com.pusher.client.connection.impl - package com.pusher.client.connection.impl
 
com.pusher.client.connection.websocket - package com.pusher.client.connection.websocket
 
com.pusher.client.example - package com.pusher.client.example
Examples that can be executed as part of testing from the built .jar.
com.pusher.client.util - package com.pusher.client.util
Contains helper classes.
compareTo(InternalChannel) - Method in class com.pusher.client.channel.impl.ChannelImpl
 
connect() - Method in interface com.pusher.client.connection.Connection
No need to call this via the API.
connect() - Method in class com.pusher.client.connection.websocket.WebSocketConnection
 
connect() - Method in class com.pusher.client.Pusher
Connects to Pusher.
connect(ConnectionEventListener, ConnectionState...) - Method in class com.pusher.client.Pusher
Binds a ConnectionEventListener to the specified events and then connects to Pusher.
Connection - Interface in com.pusher.client.connection
Represents a connection to Pusher.
ConnectionEventListener - Interface in com.pusher.client.connection
Client applications should implement this interface if they wish to receive notifications when the state of a Connection changes or an error is thrown.
ConnectionState - Enum in com.pusher.client.connection
Represents connection states e.g.
ConnectionStateChange - Class in com.pusher.client.connection
Represents a change in connection state.
ConnectionStateChange(ConnectionState, ConnectionState) - Constructor for class com.pusher.client.connection.ConnectionStateChange
Used within the library to create a connection state change.

D

disconnect() - Method in interface com.pusher.client.connection.impl.InternalConnection
 
disconnect() - Method in class com.pusher.client.connection.websocket.WebSocketConnection
 
disconnect() - Method in class com.pusher.client.Pusher
Disconnect from Pusher.

E

equals(Object) - Method in class com.pusher.client.channel.User
 
equals(Object) - Method in class com.pusher.client.connection.ConnectionStateChange
 
ExampleApp - Class in com.pusher.client.example
 
ExampleApp(String[]) - Constructor for class com.pusher.client.example.ExampleApp
 

F

Factory - Class in com.pusher.client.util
This is a lightweight way of doing dependency injection and enabling classes to be unit tested in isolation.
Factory() - Constructor for class com.pusher.client.util.Factory
 

G

getActivityTimeout() - Method in class com.pusher.client.PusherOptions
 
getAuthorizer() - Method in class com.pusher.client.PusherOptions
Gets the authorizer to be used when authenticating private and presence channels.
getAuthResponse() - Method in class com.pusher.client.channel.impl.PrivateChannelImpl
Protected access because this is also used by PresenceChannelImpl.
getChannel(String) - Method in class com.pusher.client.channel.impl.ChannelManager
 
getChannel(String) - Method in class com.pusher.client.Pusher
 
getChannelManager() - Method in class com.pusher.client.util.Factory
 
getConnection() - Method in class com.pusher.client.Pusher
Gets the underlying Connection object that is being used by this instance of Pusher.
getConnection(String, PusherOptions) - Method in class com.pusher.client.util.Factory
 
getCurrentState() - Method in class com.pusher.client.connection.ConnectionStateChange
The current connection state.
getDisallowedNameExpressions() - Method in class com.pusher.client.channel.impl.ChannelImpl
 
getDisallowedNameExpressions() - Method in class com.pusher.client.channel.impl.PresenceChannelImpl
 
getDisallowedNameExpressions() - Method in class com.pusher.client.channel.impl.PrivateChannelImpl
 
getEventListener() - Method in class com.pusher.client.channel.impl.ChannelImpl
 
getEventListener() - Method in interface com.pusher.client.channel.impl.InternalChannel
 
getEventQueue() - Method in class com.pusher.client.util.Factory
 
getId() - Method in class com.pusher.client.channel.User
A unique identifier for the user within a Pusher application.
getInfo() - Method in class com.pusher.client.channel.User
Custom additional information about a user as a String encoding a JSON hash
getInfo(Class<V>) - Method in class com.pusher.client.channel.User
Custom additional information about a user decoded as a new instance of the provided POJO bean type
getMe() - Method in class com.pusher.client.channel.impl.PresenceChannelImpl
 
getMe() - Method in interface com.pusher.client.channel.PresenceChannel
Gets the user that represents the currently connected client.
getName() - Method in interface com.pusher.client.channel.Channel
Gets the name of the Pusher channel that this object represents.
getName() - Method in class com.pusher.client.channel.impl.ChannelImpl
 
getPongTimeout() - Method in class com.pusher.client.PusherOptions
 
getPresenceChannel(String) - Method in class com.pusher.client.channel.impl.ChannelManager
 
getPresenceChannel(String) - Method in class com.pusher.client.Pusher
 
getPreviousState() - Method in class com.pusher.client.connection.ConnectionStateChange
The previous connections state.
getPrivateChannel(String) - Method in class com.pusher.client.channel.impl.ChannelManager
 
getPrivateChannel(String) - Method in class com.pusher.client.Pusher
 
getSocketId() - Method in interface com.pusher.client.connection.Connection
Gets a unique connection ID.
getSocketId() - Method in class com.pusher.client.connection.websocket.WebSocketConnection
 
getState() - Method in interface com.pusher.client.connection.Connection
Gets the current connection state.
getState() - Method in class com.pusher.client.connection.websocket.WebSocketConnection
 
getTimers() - Method in class com.pusher.client.util.Factory
 
getUsers() - Method in class com.pusher.client.channel.impl.PresenceChannelImpl
 
getUsers() - Method in interface com.pusher.client.channel.PresenceChannel
Gets a set of users currently subscribed to the channel.

H

hashCode() - Method in class com.pusher.client.channel.User
 
hashCode() - Method in class com.pusher.client.connection.ConnectionStateChange
 
HttpAuthorizer - Class in com.pusher.client.util
Used to authenticate a private or presence channel subscription.
HttpAuthorizer(String) - Constructor for class com.pusher.client.util.HttpAuthorizer
Creates a new authorizer.

I

InternalChannel - Interface in com.pusher.client.channel.impl
 
InternalConnection - Interface in com.pusher.client.connection.impl
 
isEncrypted() - Method in class com.pusher.client.PusherOptions
Gets whether an encrypted (SSL) connection should be used when connecting to Pusher.
isSSL() - Method in class com.pusher.client.util.HttpAuthorizer
Identifies if the HTTP request will be sent over HTTPS.
isSubscribed() - Method in interface com.pusher.client.channel.Channel
 
isSubscribed() - Method in class com.pusher.client.channel.impl.ChannelImpl
 

L

LIB_VERSION - Static variable in class com.pusher.client.PusherOptions
 

M

main(String[]) - Static method in class com.pusher.client.example.ExampleApp
 
main(String[]) - Static method in class com.pusher.client.example.PresenceChannelExampleApp
 
main(String[]) - Static method in class com.pusher.client.example.PrivateChannelExampleApp
 
main(String[]) - Static method in class com.pusher.client.example.SimpleWebSocket
 

N

name - Variable in class com.pusher.client.channel.impl.ChannelImpl
 
newPresenceChannel(InternalConnection, String, Authorizer) - Method in class com.pusher.client.util.Factory
 
newPrivateChannel(InternalConnection, String, Authorizer) - Method in class com.pusher.client.util.Factory
 
newPublicChannel(String) - Method in class com.pusher.client.util.Factory
 
newWebSocketClientWrapper(URI, WebSocketListener) - Method in class com.pusher.client.util.Factory
 

O

onAuthenticationFailure(String, Exception) - Method in interface com.pusher.client.channel.PrivateChannelEventListener
Called when an attempt to authenticate a private channel fails.
onAuthenticationFailure(String, Exception) - Method in class com.pusher.client.example.PresenceChannelExampleApp
 
onAuthenticationFailure(String, Exception) - Method in class com.pusher.client.example.PrivateChannelExampleApp
 
onClose(int, String, boolean) - Method in class com.pusher.client.connection.websocket.WebSocketClientWrapper
 
onClose(int, String, boolean) - Method in class com.pusher.client.connection.websocket.WebSocketConnection
 
onClose(int, String, boolean) - Method in interface com.pusher.client.connection.websocket.WebSocketListener
 
onClose(int, String, boolean) - Method in class com.pusher.client.example.SimpleWebSocket
 
onConnectionStateChange(ConnectionStateChange) - Method in class com.pusher.client.channel.impl.ChannelManager
 
onConnectionStateChange(ConnectionStateChange) - Method in interface com.pusher.client.connection.ConnectionEventListener
Callback that is fired whenever the ConnectionState of the Connection changes.
onConnectionStateChange(ConnectionStateChange) - Method in class com.pusher.client.example.ExampleApp
 
onConnectionStateChange(ConnectionStateChange) - Method in class com.pusher.client.example.PresenceChannelExampleApp
 
onConnectionStateChange(ConnectionStateChange) - Method in class com.pusher.client.example.PrivateChannelExampleApp
 
onError(String, String, Exception) - Method in class com.pusher.client.channel.impl.ChannelManager
 
onError(String, String, Exception) - Method in interface com.pusher.client.connection.ConnectionEventListener
Callback that indicates either: An error message has been received from Pusher, or An error has occurred in the client library.
onError(Exception) - Method in class com.pusher.client.connection.websocket.WebSocketClientWrapper
 
onError(Exception) - Method in class com.pusher.client.connection.websocket.WebSocketConnection
 
onError(Exception) - Method in interface com.pusher.client.connection.websocket.WebSocketListener
 
onError(String, String, Exception) - Method in class com.pusher.client.example.ExampleApp
 
onError(String, String, Exception) - Method in class com.pusher.client.example.PresenceChannelExampleApp
 
onError(String, String, Exception) - Method in class com.pusher.client.example.PrivateChannelExampleApp
 
onError(Exception) - Method in class com.pusher.client.example.SimpleWebSocket
 
onEvent(String, String, String) - Method in interface com.pusher.client.channel.SubscriptionEventListener
Callback that is fired whenever an event that this SubscriptionEventListener has been bound to is received.
onEvent(String, String, String) - Method in class com.pusher.client.example.ExampleApp
 
onEvent(String, String, String) - Method in class com.pusher.client.example.PresenceChannelExampleApp
 
onEvent(String, String, String) - Method in class com.pusher.client.example.PrivateChannelExampleApp
 
onMessage(String, String) - Method in class com.pusher.client.channel.impl.ChannelImpl
 
onMessage(String, String) - Method in class com.pusher.client.channel.impl.ChannelManager
 
onMessage(String, String) - Method in interface com.pusher.client.channel.impl.InternalChannel
 
onMessage(String, String) - Method in class com.pusher.client.channel.impl.PresenceChannelImpl
 
onMessage(String) - Method in class com.pusher.client.connection.websocket.WebSocketClientWrapper
 
onMessage(String) - Method in class com.pusher.client.connection.websocket.WebSocketConnection
 
onMessage(String) - Method in interface com.pusher.client.connection.websocket.WebSocketListener
 
onMessage(String) - Method in class com.pusher.client.example.SimpleWebSocket
 
onOpen(ServerHandshake) - Method in class com.pusher.client.connection.websocket.WebSocketClientWrapper
 
onOpen(ServerHandshake) - Method in class com.pusher.client.connection.websocket.WebSocketConnection
 
onOpen(ServerHandshake) - Method in interface com.pusher.client.connection.websocket.WebSocketListener
 
onOpen(ServerHandshake) - Method in class com.pusher.client.example.SimpleWebSocket
 
onSubscriptionSucceeded(String) - Method in interface com.pusher.client.channel.ChannelEventListener
Callback that is fired when a subscription success acknowledgement message is received from Pusher after subscribing to the channel.
onSubscriptionSucceeded(String) - Method in class com.pusher.client.example.ExampleApp
 
onSubscriptionSucceeded(String) - Method in class com.pusher.client.example.PresenceChannelExampleApp
 
onSubscriptionSucceeded(String) - Method in class com.pusher.client.example.PrivateChannelExampleApp
 
onUsersInformationReceived(String, Set<User>) - Method in interface com.pusher.client.channel.PresenceChannelEventListener
Called when the subscription has succeeded and an initial list of subscribed users has been received from Pusher.
onUsersInformationReceived(String, Set<User>) - Method in class com.pusher.client.example.PresenceChannelExampleApp
 

P

PresenceChannel - Interface in com.pusher.client.channel
An object that represents a Pusher presence channel.
PresenceChannelEventListener - Interface in com.pusher.client.channel
Used to listen for presence specific events as well as those defined by the PrivateChannelEventListener and parent interfaces.
PresenceChannelExampleApp - Class in com.pusher.client.example
 
PresenceChannelExampleApp(String[]) - Constructor for class com.pusher.client.example.PresenceChannelExampleApp
 
PresenceChannelImpl - Class in com.pusher.client.channel.impl
 
PresenceChannelImpl(InternalConnection, String, Authorizer, Factory) - Constructor for class com.pusher.client.channel.impl.PresenceChannelImpl
 
PrivateChannel - Interface in com.pusher.client.channel
Represents a subscription to a private channel.
PrivateChannelEventListener - Interface in com.pusher.client.channel
Interface to listen to private channel events.
PrivateChannelExampleApp - Class in com.pusher.client.example
 
PrivateChannelExampleApp(String[]) - Constructor for class com.pusher.client.example.PrivateChannelExampleApp
 
PrivateChannelImpl - Class in com.pusher.client.channel.impl
 
PrivateChannelImpl(InternalConnection, String, Authorizer, Factory) - Constructor for class com.pusher.client.channel.impl.PrivateChannelImpl
 
Pusher - Class in com.pusher.client
This class is the main entry point for accessing Pusher.
Pusher(String) - Constructor for class com.pusher.client.Pusher
Creates a new instance of Pusher.
Pusher(String, PusherOptions) - Constructor for class com.pusher.client.Pusher
Creates a new instance of Pusher.
PusherOptions - Class in com.pusher.client
Configuration for a Pusher instance.
PusherOptions() - Constructor for class com.pusher.client.PusherOptions
 

S

sendMessage(String) - Method in interface com.pusher.client.connection.impl.InternalConnection
 
sendMessage(String) - Method in class com.pusher.client.connection.websocket.WebSocketConnection
 
setActivityTimeout(long) - Method in class com.pusher.client.PusherOptions
The number of milliseconds of inactivity at which a "ping" will be triggered to check the connection.
setAuthorizer(Authorizer) - Method in class com.pusher.client.PusherOptions
Sets the authorizer to be used when authenticating private and presence channels.
setCluster(String) - Method in class com.pusher.client.PusherOptions
 
setConnection(InternalConnection) - Method in class com.pusher.client.channel.impl.ChannelManager
 
setEncrypted(boolean) - Method in class com.pusher.client.PusherOptions
Sets whether an encrypted (SSL) connection should be used when connecting to Pusher.
setEventListener(ChannelEventListener) - Method in class com.pusher.client.channel.impl.ChannelImpl
 
setEventListener(ChannelEventListener) - Method in interface com.pusher.client.channel.impl.InternalChannel
 
setHeaders(Map<String, String>) - Method in class com.pusher.client.util.HttpAuthorizer
Set additional headers to be sent as part of the request.
setHost(String) - Method in class com.pusher.client.PusherOptions
The host to which connections will be made.
setPongTimeout(long) - Method in class com.pusher.client.PusherOptions
The number of milliseconds after a "ping" is sent that the client will wait to receive a "pong" response from the server before considering the connection broken and triggering a transition to the disconnected state.
setQueryStringParameters(HashMap<String, String>) - Method in class com.pusher.client.util.HttpAuthorizer
This methods is for passing extra parameters authentication that needs to be added to query string.
setWsPort(int) - Method in class com.pusher.client.PusherOptions
The port to which unencrypted connections will be made.
setWssPort(int) - Method in class com.pusher.client.PusherOptions
The port to which encrypted connections will be made.
shutdownThreads() - Method in class com.pusher.client.util.Factory
 
SimpleWebSocket - Class in com.pusher.client.example
 
SimpleWebSocket() - Constructor for class com.pusher.client.example.SimpleWebSocket
 
state - Variable in class com.pusher.client.channel.impl.ChannelImpl
 
subscribe(String) - Method in class com.pusher.client.Pusher
Subscribes to a public Channel.
subscribe(String, ChannelEventListener, String...) - Method in class com.pusher.client.Pusher
Binds a ChannelEventListener to the specified events and then subscribes to a public Channel.
subscribePresence(String) - Method in class com.pusher.client.Pusher
Subscribes to a PresenceChannel which requires authentication.
subscribePresence(String, PresenceChannelEventListener, String...) - Method in class com.pusher.client.Pusher
Subscribes to a PresenceChannel which requires authentication.
subscribePrivate(String) - Method in class com.pusher.client.Pusher
Subscribes to a PrivateChannel which requires authentication.
subscribePrivate(String, PrivateChannelEventListener, String...) - Method in class com.pusher.client.Pusher
Subscribes to a PrivateChannel which requires authentication.
subscribeTo(InternalChannel, ChannelEventListener, String...) - Method in class com.pusher.client.channel.impl.ChannelManager
 
SUBSCRIPTION_SUCCESS_EVENT - Static variable in class com.pusher.client.channel.impl.ChannelImpl
 
SubscriptionEventListener - Interface in com.pusher.client.channel
Client applications should implement this interface if they want to be notified when events are received on a public or private channel.

T

toString() - Method in class com.pusher.client.channel.impl.ChannelImpl
 
toString() - Method in class com.pusher.client.channel.impl.PresenceChannelImpl
 
toString() - Method in class com.pusher.client.channel.impl.PrivateChannelImpl
 
toString() - Method in class com.pusher.client.channel.User
 
toSubscribeMessage() - Method in class com.pusher.client.channel.impl.ChannelImpl
 
toSubscribeMessage() - Method in interface com.pusher.client.channel.impl.InternalChannel
 
toSubscribeMessage() - Method in class com.pusher.client.channel.impl.PresenceChannelImpl
 
toSubscribeMessage() - Method in class com.pusher.client.channel.impl.PrivateChannelImpl
 
toUnsubscribeMessage() - Method in class com.pusher.client.channel.impl.ChannelImpl
 
toUnsubscribeMessage() - Method in interface com.pusher.client.channel.impl.InternalChannel
 
trigger(String, String) - Method in class com.pusher.client.channel.impl.PrivateChannelImpl
 
trigger(String, String) - Method in interface com.pusher.client.channel.PrivateChannel
Once subscribed it is possible to trigger client events on a private channel as long as client events have been activated for the a Pusher application.

U

unbind(String, SubscriptionEventListener) - Method in interface com.pusher.client.channel.Channel
Unbinds a previously bound SubscriptionEventListener from an event.
unbind(String, SubscriptionEventListener) - Method in class com.pusher.client.channel.impl.ChannelImpl
 
unbind(ConnectionState, ConnectionEventListener) - Method in interface com.pusher.client.connection.Connection
Unbind from connection state changes.
unbind(ConnectionState, ConnectionEventListener) - Method in class com.pusher.client.connection.websocket.WebSocketConnection
 
unsubscribe(String) - Method in class com.pusher.client.Pusher
Unsubscribes from a channel using via the name of the channel.
unsubscribeFrom(String) - Method in class com.pusher.client.channel.impl.ChannelManager
 
updateState(ChannelState) - Method in class com.pusher.client.channel.impl.ChannelImpl
 
updateState(ChannelState) - Method in interface com.pusher.client.channel.impl.InternalChannel
 
User - Class in com.pusher.client.channel
Represents a user that is subscribed to a PresenceChannel.
User(String, String) - Constructor for class com.pusher.client.channel.User
Create a new user.
userSubscribed(String, User) - Method in interface com.pusher.client.channel.PresenceChannelEventListener
Called when a new user subscribes to the channel.
userSubscribed(String, User) - Method in class com.pusher.client.example.PresenceChannelExampleApp
 
userUnsubscribed(String, User) - Method in interface com.pusher.client.channel.PresenceChannelEventListener
Called when an existing user unsubscribes from the channel.
userUnsubscribed(String, User) - Method in class com.pusher.client.example.PresenceChannelExampleApp
 

V

valueOf(String) - Static method in enum com.pusher.client.channel.ChannelState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pusher.client.connection.ConnectionState
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.pusher.client.channel.ChannelState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pusher.client.connection.ConnectionState
Returns an array containing the constants of this enum type, in the order they are declared.

W

WebSocketClientWrapper - Class in com.pusher.client.connection.websocket
A thin wrapper around the WebSocketClient class from the Java-WebSocket library.
WebSocketClientWrapper(URI, WebSocketListener) - Constructor for class com.pusher.client.connection.websocket.WebSocketClientWrapper
 
WebSocketConnection - Class in com.pusher.client.connection.websocket
 
WebSocketConnection(String, long, long, Factory) - Constructor for class com.pusher.client.connection.websocket.WebSocketConnection
 
WebSocketListener - Interface in com.pusher.client.connection.websocket
 
A B C D E F G H I L M N O P S T U V W 
Skip navigation links

Copyright © 2016 Pusher. All rights reserved.