Index (Pusher Java Websocket API)

A B C D E F G H I L N O P Q R S T U V
All Classes All Packages

A

ALL - com.pusher.client.connection.ConnectionState
authenticate(String) - Method in interface com.pusher.client.UserAuthenticator: Called when a user is to be authenticated.
authenticate(String) - Method in class com.pusher.client.util.HttpUserAuthenticator
AuthenticationFailureException - Exception in com.pusher.client: Used to indicate an authentication failure.
AuthenticationFailureException() - Constructor for exception com.pusher.client.AuthenticationFailureException
AuthenticationFailureException(Exception) - Constructor for exception com.pusher.client.AuthenticationFailureException
AuthenticationFailureException(String) - Constructor for exception com.pusher.client.AuthenticationFailureException
AuthenticationFailureException(String, Exception) - Constructor for exception com.pusher.client.AuthenticationFailureException
AuthenticationResponse - Class in com.pusher.client.user.impl.message
AuthenticationResponse() - Constructor for class com.pusher.client.user.impl.message.AuthenticationResponse
authFailureException(IOException) - Method in class com.pusher.client.util.HttpChannelAuthorizer
authFailureException(IOException) - Method in class com.pusher.client.util.HttpUserAuthenticator
authFailureException(String) - Method in class com.pusher.client.util.HttpChannelAuthorizer
authFailureException(String) - Method in class com.pusher.client.util.HttpUserAuthenticator
AuthorizationFailureException - Exception in com.pusher.client: Used to indicate an authorization failure.
AuthorizationFailureException() - Constructor for exception com.pusher.client.AuthorizationFailureException
AuthorizationFailureException(Exception) - Constructor for exception com.pusher.client.AuthorizationFailureException
AuthorizationFailureException(String) - 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.ChannelAuthorizer: Called when a channel subscription is to be authorized.
authorize(String, String) - Method in class com.pusher.client.util.HttpChannelAuthorizer
Authorizer - Interface in com.pusher.client: Deprecated.
Please use ChannelAuthorizer

B

bind(ConnectionState, ConnectionEventListener) - Method in interface com.pusher.client.connection.Connection: Bind to connection events.
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.user.impl.InternalUser
bind(String, SubscriptionEventListener) - Method in interface com.pusher.client.user.User: Binds a SubscriptionEventListener to an event.
bindGlobal(SubscriptionEventListener) - Method in interface com.pusher.client.channel.Channel: Binds a SubscriptionEventListener to all events.
bindGlobal(SubscriptionEventListener) - Method in class com.pusher.client.user.impl.InternalUser
bindGlobal(SubscriptionEventListener) - Method in interface com.pusher.client.user.User: Binds a SubscriptionEventListener to all events.
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.
ChannelAuthorizer - Interface in com.pusher.client: Subscriptions to Private and presence channels need to be authorized.
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.
ChannelState - Enum in com.pusher.client.channel: Used to identify the state of the channel e.g.
Client - Interface in com.pusher.client
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.connection - package com.pusher.client.connection: Classes related to the Pusher connection, connection state and monitoring connection state changes.
com.pusher.client.user - package com.pusher.client.user
com.pusher.client.user.impl - package com.pusher.client.user.impl
com.pusher.client.user.impl.message - package com.pusher.client.user.impl.message
com.pusher.client.util - package com.pusher.client.util: Contains helper classes.
connect() - Method in interface com.pusher.client.Client
connect() - Method in interface com.pusher.client.connection.Connection: No need to call this via the API.
connect() - Method in class com.pusher.client.Pusher: Connects to Pusher.
connect(ConnectionEventListener, ConnectionState...) - Method in interface com.pusher.client.Client
connect(ConnectionEventListener, ConnectionState...) - Method in class com.pusher.client.Pusher: Binds a ConnectionEventListener to the specified events and then connects to Pusher.
CONNECTED - com.pusher.client.connection.ConnectionState
CONNECTING - com.pusher.client.connection.ConnectionState
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.
ConnectionFactory - Class in com.pusher.client.util: Abstract factory to be used for building HttpChannelAuthorizer connections
ConnectionFactory() - Constructor for class com.pusher.client.util.ConnectionFactory
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.Client
disconnect() - Method in class com.pusher.client.Pusher: Disconnect from Pusher.
DISCONNECTED - com.pusher.client.connection.ConnectionState
DISCONNECTING - com.pusher.client.connection.ConnectionState

E

equals(Object) - Method in class com.pusher.client.channel.User
equals(Object) - Method in class com.pusher.client.connection.ConnectionStateChange

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
FAILED - com.pusher.client.channel.ChannelState
fromJson(String) - Static method in class com.pusher.client.channel.PusherEvent

G

getActivityTimeout() - Method in class com.pusher.client.PusherOptions
getAuth() - Method in class com.pusher.client.user.impl.message.AuthenticationResponse
getAuthorizer() - Method in class com.pusher.client.PusherOptions: Deprecated.
Please use getChannelauthorizer
getBody() - Method in class com.pusher.client.util.ConnectionFactory
getBody() - Method in class com.pusher.client.util.UrlEncodedConnectionFactory
getChannel(String) - Method in interface com.pusher.client.Client
getChannel(String) - Method in class com.pusher.client.Pusher
getChannelAuthorizer() - Method in class com.pusher.client.PusherOptions: Gets the channel authorizer to be used when authorizing private and presence channels.
getChannelManager() - Method in class com.pusher.client.util.Factory
getChannelName() - Method in class com.pusher.client.channel.PusherEvent
getChannelName() - Method in class com.pusher.client.util.ConnectionFactory
getCharset() - Method in class com.pusher.client.util.ConnectionFactory
getCharset() - Method in class com.pusher.client.util.UrlEncodedConnectionFactory
getConnection() - Method in interface com.pusher.client.Client
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, Consumer<PusherEvent>) - Method in class com.pusher.client.util.Factory
getContentType() - Method in class com.pusher.client.util.ConnectionFactory
getContentType() - Method in class com.pusher.client.util.UrlEncodedConnectionFactory
getCurrentState() - Method in class com.pusher.client.connection.ConnectionStateChange: The current connection state.
getData() - Method in class com.pusher.client.channel.PusherEvent
getEventName() - Method in class com.pusher.client.channel.PusherEvent
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
getMaxReconnectGapInSeconds() - Method in class com.pusher.client.PusherOptions
getMaxReconnectionAttempts() - Method in class com.pusher.client.PusherOptions
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.
getPongTimeout() - Method in class com.pusher.client.PusherOptions
getPresenceChannel(String) - Method in interface com.pusher.client.Client
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 interface com.pusher.client.Client
getPrivateChannel(String) - Method in class com.pusher.client.Pusher
getPrivateEncryptedChannel(String) - Method in class com.pusher.client.Pusher
getProperty(String) - Method in class com.pusher.client.channel.PusherEvent: getProperty returns the value associated with the key, or null.
getProxy() - Method in class com.pusher.client.PusherOptions
getSocketId() - Method in interface com.pusher.client.connection.Connection: Gets a unique connection ID.
getSocketId() - Method in class com.pusher.client.util.ConnectionFactory
getState() - Method in interface com.pusher.client.connection.Connection: Gets the current connection state.
getTimers() - Method in class com.pusher.client.util.Factory
getUserAuthenticator() - Method in class com.pusher.client.PusherOptions: Gets the user authenticator to be used when signing in.
getUserData() - Method in class com.pusher.client.user.impl.message.AuthenticationResponse
getUserId() - Method in class com.pusher.client.channel.PusherEvent
getUsers() - Method in interface com.pusher.client.channel.PresenceChannel: Gets a set of users currently subscribed to the channel.

H

handleEvent(PusherEvent) - Method in class com.pusher.client.user.impl.InternalUser
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: Deprecated.
Please use HttpChannelAuthorizer
HttpAuthorizer(String) - Constructor for class com.pusher.client.util.HttpAuthorizer: Deprecated.

Creates a new authorizer.
HttpAuthorizer(String, ConnectionFactory) - Constructor for class com.pusher.client.util.HttpAuthorizer: Deprecated.

Creates a new authorizer.
HttpChannelAuthorizer - Class in com.pusher.client.util: Used to authorize a private or presence channel subscription.
HttpChannelAuthorizer(String) - Constructor for class com.pusher.client.util.HttpChannelAuthorizer: Creates a new channel authorizer.
HttpChannelAuthorizer(String, ConnectionFactory) - Constructor for class com.pusher.client.util.HttpChannelAuthorizer: Creates a new channel authorizer.
HttpUserAuthenticator - Class in com.pusher.client.util: Used to authenticate the user when signing in on a Pusher Channels connection.
HttpUserAuthenticator(String) - Constructor for class com.pusher.client.util.HttpUserAuthenticator: Creates a new user authenticator.
HttpUserAuthenticator(String, ConnectionFactory) - Constructor for class com.pusher.client.util.HttpUserAuthenticator: Creates a new user authenticator.

I

INITIAL - com.pusher.client.channel.ChannelState
InternalUser - Class in com.pusher.client.user.impl
InternalUser(InternalConnection, UserAuthenticator, Factory) - Constructor for class com.pusher.client.user.impl.InternalUser
isEncrypted() - Method in class com.pusher.client.PusherOptions: Deprecated.
Please use isUseTLS
isSubscribed() - Method in interface com.pusher.client.channel.Channel
isUseTLS() - Method in class com.pusher.client.PusherOptions

L

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

N

newPresenceChannel(InternalConnection, String, ChannelAuthorizer) - Method in class com.pusher.client.util.Factory
newPrivateChannel(InternalConnection, String, ChannelAuthorizer) - Method in class com.pusher.client.util.Factory
newPrivateEncryptedChannel(InternalConnection, String, ChannelAuthorizer) - Method in class com.pusher.client.util.Factory
newPublicChannel(String) - Method in class com.pusher.client.util.Factory
newUser(InternalConnection, UserAuthenticator) - Method in class com.pusher.client.util.Factory
newWebSocketClientWrapper(URI, Proxy, 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.
onConnectionStateChange(ConnectionStateChange) - Method in interface com.pusher.client.connection.ConnectionEventListener: Callback that is fired whenever the ConnectionState of the Connection changes.
onDecryptionFailure(String, String) - Method in interface com.pusher.client.channel.PrivateEncryptedChannelEventListener
onError(String, Exception) - Method in interface com.pusher.client.channel.SubscriptionEventListener: Callback that is fired whenever an unexpected error occurs processing for this SubscriptionEventListener.
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.
onEvent(PusherEvent) - Method in interface com.pusher.client.channel.SubscriptionEventListener: Callback that is fired whenever an event that this SubscriptionEventListener has been bound to is received.
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.
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.

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.
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.
PrivateEncryptedChannel - Interface in com.pusher.client.channel: Represents a subscription to an encrypted private channel.
PrivateEncryptedChannelEventListener - Interface in com.pusher.client.channel: Interface to listen to private encrypted channel events.
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.
PusherEvent - Class in com.pusher.client.channel
PusherEvent(JsonObject) - Constructor for class com.pusher.client.channel.PusherEvent
PusherEvent(String, String, String, String) - Constructor for class com.pusher.client.channel.PusherEvent
PusherEvent(String, String, String, Map<String, Object>) - Constructor for class com.pusher.client.channel.PusherEvent
PusherOptions - Class in com.pusher.client: Configuration for a Pusher instance.
PusherOptions() - Constructor for class com.pusher.client.PusherOptions

Q

queueOnEventThread(Runnable) - Method in class com.pusher.client.util.Factory

R

RECONNECTING - com.pusher.client.connection.ConnectionState

S

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: Deprecated.
Please use setChannelauthorizer
setChannelAuthorizer(ChannelAuthorizer) - Method in class com.pusher.client.PusherOptions: Sets the channel authorizer to be used when authorizing private and presence channels.
setChannelName(String) - Method in class com.pusher.client.util.ConnectionFactory
setCluster(String) - Method in class com.pusher.client.PusherOptions
setEncrypted(boolean) - Method in class com.pusher.client.PusherOptions: Deprecated.
Please use setUseTLS
setHost(String) - Method in class com.pusher.client.PusherOptions: The host to which connections will be made.
setMaxReconnectGapInSeconds(int) - Method in class com.pusher.client.PusherOptions: The delay in two reconnection extends exponentially (1, 2, 4, ..
setMaxReconnectionAttempts(int) - Method in class com.pusher.client.PusherOptions: Number of reconnect attempts when websocket connection failed
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.
setProxy(Proxy) - Method in class com.pusher.client.PusherOptions: The default value is Proxy.NO_PROXY.
setSocketId(String) - Method in class com.pusher.client.util.ConnectionFactory
setUserAuthenticator(UserAuthenticator) - Method in class com.pusher.client.PusherOptions: Sets the user authenticator to be used when signing in.
setUseTLS(boolean) - Method in class com.pusher.client.PusherOptions: Sets whether the connection to Pusher should be use TLS.
setWsPort(int) - Method in class com.pusher.client.PusherOptions: The port to which non TLS 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
signin() - Method in class com.pusher.client.Pusher: Signs in on the Pusher connection as the current user.
signin() - Method in class com.pusher.client.user.impl.InternalUser
SigninMessage - Class in com.pusher.client.user.impl.message
SigninMessage(String, String) - Constructor for class com.pusher.client.user.impl.message.SigninMessage
subscribe(String) - Method in interface com.pusher.client.Client
subscribe(String) - Method in class com.pusher.client.Pusher: Subscribes to a public Channel.
subscribe(String, ChannelEventListener, String...) - Method in interface com.pusher.client.Client
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.
SUBSCRIBE_SENT - com.pusher.client.channel.ChannelState
SUBSCRIBED - com.pusher.client.channel.ChannelState
subscribePresence(String) - Method in interface com.pusher.client.Client
subscribePresence(String) - Method in class com.pusher.client.Pusher: Subscribes to a PresenceChannel which requires authentication.
subscribePresence(String, PresenceChannelEventListener, String...) - Method in interface com.pusher.client.Client
subscribePresence(String, PresenceChannelEventListener, String...) - Method in class com.pusher.client.Pusher: Subscribes to a PresenceChannel which requires authentication.
subscribePrivate(String) - Method in interface com.pusher.client.Client
subscribePrivate(String) - Method in class com.pusher.client.Pusher: Subscribes to a PrivateChannel which requires authentication.
subscribePrivate(String, PrivateChannelEventListener, String...) - Method in interface com.pusher.client.Client
subscribePrivate(String, PrivateChannelEventListener, String...) - Method in class com.pusher.client.Pusher: Subscribes to a PrivateChannel which requires authentication.
subscribePrivateEncrypted(String, PrivateEncryptedChannelEventListener, String...) - Method in class com.pusher.client.Pusher: Subscribes to a PrivateEncryptedChannel which requires authentication.
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

toJson() - Method in class com.pusher.client.channel.PusherEvent
toString() - Method in class com.pusher.client.channel.PusherEvent
toString() - Method in class com.pusher.client.channel.User
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(ConnectionState, ConnectionEventListener) - Method in interface com.pusher.client.connection.Connection: Unbind from connection state changes.
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.user.impl.InternalUser
unbind(String, SubscriptionEventListener) - Method in interface com.pusher.client.user.User: Unbinds a previously bound SubscriptionEventListener from an event.
unbindGlobal(SubscriptionEventListener) - Method in interface com.pusher.client.channel.Channel: Unbinds a previously bound SubscriptionEventListener from global events.
unbindGlobal(SubscriptionEventListener) - Method in class com.pusher.client.user.impl.InternalUser
unbindGlobal(SubscriptionEventListener) - Method in interface com.pusher.client.user.User: Unbinds a previously bound SubscriptionEventListener from global events.
unsubscribe(String) - Method in interface com.pusher.client.Client
unsubscribe(String) - Method in class com.pusher.client.Pusher: Unsubscribes from a channel using via the name of the channel.
UNSUBSCRIBED - com.pusher.client.channel.ChannelState
UrlEncodedConnectionFactory - Class in com.pusher.client.util: Form URL-Encoded Connection Factory
UrlEncodedConnectionFactory() - Constructor for class com.pusher.client.util.UrlEncodedConnectionFactory: Create a Form URL-encoded factory
UrlEncodedConnectionFactory(Map<String, String>) - Constructor for class com.pusher.client.util.UrlEncodedConnectionFactory: Create a Form URL-encoded factory
user() - Method in class com.pusher.client.Pusher
User - Class in com.pusher.client.channel: Represents a user that is subscribed to a PresenceChannel.
User - Interface in com.pusher.client.user: An object that represents a user on a Pusher connection.
User(String, String) - Constructor for class com.pusher.client.channel.User: Create a new user.
UserAuthenticator - Interface in com.pusher.client: Sigining in as a User on a connection requires authentication.
userId() - Method in class com.pusher.client.user.impl.InternalUser
userId() - Method in interface com.pusher.client.user.User
userSubscribed(String, User) - Method in interface com.pusher.client.channel.PresenceChannelEventListener: Called when a new user subscribes to the channel.
userUnsubscribed(String, User) - Method in interface com.pusher.client.channel.PresenceChannelEventListener: Called when an existing user unsubscribes from the channel.

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.

A B C D E F G H I L N O P Q R S T U V
All Classes All Packages