org.jivesoftware.smackx.geoloc

Class GeoLocationManager

java.lang.Object

org.jivesoftware.smack.Manager

org.jivesoftware.smackx.geoloc.GeoLocationManager

public final class GeoLocationManager
extends org.jivesoftware.smack.Manager

Constructor Summary

Constructors

Constructor and Description
GeoLocationManager(org.jivesoftware.smack.XMPPConnection connection)

Method Summary

Modifier and Type	Method and Description
static GeoLocationManager	getInstanceFor(org.jivesoftware.smack.XMPPConnection connection) Retrieves a GeoLocationManager for the specified XMPPConnection, creating one if it doesn't already exist.
static boolean	isGeoLocationMessage(org.jivesoftware.smack.packet.Message message) Returns true if the message contains a GeoLocation extension.
void	sendGeolocation(GeoLocation geoLocation) Send geolocation through the PubSub node.
void	sendGeoLocationToJid(GeoLocation geoLocation, org.jxmpp.jid.Jid jid)
void	stopPublishingGeolocation() Send empty geolocation through the PubSub node.

Methods inherited from class org.jivesoftware.smack.Manager

connection, getAuthenticatedConnectionOrThrow, schedule

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoLocationManager

public GeoLocationManager(org.jivesoftware.smack.XMPPConnection connection)

Method Detail

getInstanceFor

public static GeoLocationManager getInstanceFor(org.jivesoftware.smack.XMPPConnection connection)

Retrieves a GeoLocationManager for the specified XMPPConnection, creating one if it doesn't already exist.

Parameters:

connection - The connection the manager is attached to.

Returns:

The new or existing manager.

sendGeoLocationToJid

public void sendGeoLocationToJid(GeoLocation geoLocation,
                                 org.jxmpp.jid.Jid jid)
                          throws java.lang.InterruptedException,
                                 org.jivesoftware.smack.SmackException.NotConnectedException

Throws:

java.lang.InterruptedException

org.jivesoftware.smack.SmackException.NotConnectedException

isGeoLocationMessage

public static boolean isGeoLocationMessage(org.jivesoftware.smack.packet.Message message)

Returns true if the message contains a GeoLocation extension.

Parameters:

message - the message to check if contains a GeoLocation extension or not

Returns:

a boolean indicating whether the message is a GeoLocation message

sendGeolocation

public void sendGeolocation(GeoLocation geoLocation)
                     throws org.jivesoftware.smack.SmackException.NoResponseException,
                            org.jivesoftware.smack.XMPPException.XMPPErrorException,
                            org.jivesoftware.smack.SmackException.NotConnectedException,
                            java.lang.InterruptedException,
                            PubSubException.NotALeafNodeException

Send geolocation through the PubSub node.

Parameters:

geoLocation -

Throws:

java.lang.InterruptedException

org.jivesoftware.smack.SmackException.NotConnectedException

org.jivesoftware.smack.XMPPException.XMPPErrorException

org.jivesoftware.smack.SmackException.NoResponseException

PubSubException.NotALeafNodeException

stopPublishingGeolocation

public void stopPublishingGeolocation()
                               throws org.jivesoftware.smack.SmackException.NoResponseException,
                                      org.jivesoftware.smack.XMPPException.XMPPErrorException,
                                      org.jivesoftware.smack.SmackException.NotConnectedException,
                                      java.lang.InterruptedException,
                                      PubSubException.NotALeafNodeException

Send empty geolocation through the PubSub node.

Throws:

java.lang.InterruptedException

org.jivesoftware.smack.SmackException.NotConnectedException

org.jivesoftware.smack.XMPPException.XMPPErrorException

org.jivesoftware.smack.SmackException.NoResponseException

PubSubException.NotALeafNodeException