com.quickblox.chat

Class QBPingManager

java.lang.Object

Manager

com.quickblox.chat.QBPingManager

public class QBPingManager
extends Manager

Method Summary

Modifier and Type	Method and Description
void	addPingFailedListener(PingFailedListener pingFailedListener)
java.util.List<java.lang.String>	errorsToList(java.lang.String... errors)
boolean	pingServer() Pings the server.
void	pingServer(QBEntityCallback<java.lang.Void> callback) Pings the server asynchronous.
boolean	pingUser(int userId) Pings the given user.
void	pingUser(int userId, QBEntityCallback<java.lang.Void> callback) Pings the given user asynchronous.
void	removePingFailedListener(PingFailedListener pingFailedListener)
void	setPingInterval(int pingInterval) Set the interval between the server is automatic pinged.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addPingFailedListener

public void addPingFailedListener(PingFailedListener pingFailedListener)

removePingFailedListener

public void removePingFailedListener(PingFailedListener pingFailedListener)

pingServer

public boolean pingServer()
                   throws SmackException.NotConnectedException

Pings the server. This method will return true if the server is reachable.

Returns:

true if a reply was received from the server, false otherwise.

Throws:

SmackException.NotConnectedException

pingServer

public void pingServer(QBEntityCallback<java.lang.Void> callback)

Pings the server asynchronous. This method will return result of ping in callback.

pingUser

public boolean pingUser(int userId)
                 throws SmackException.NotConnectedException

Pings the given user. This method will return false if an error occurs. The exception to this, is a server ping, which will always return true if the server is reachable, event if there is an error on the ping itself (i.e. ping not supported).

Parameters:

userId - The id of user the ping is being sent to

Returns:

true if a reply was received from the entity, false otherwise.

Throws:

SmackException.NotConnectedException

pingUser

public void pingUser(int userId,
                     QBEntityCallback<java.lang.Void> callback)

Pings the given user asynchronous. This method will return result in QBEntityCallback

Parameters:

userId - The id of user the ping is being sent to

setPingInterval

public void setPingInterval(int pingInterval)

Set the interval between the server is automatic pinged.

Parameters:

pingInterval - the interval between the ping

errorsToList

public java.util.List<java.lang.String> errorsToList(java.lang.String... errors)