com.whizzosoftware.hobson.api.presence

Interface PresenceManager

public interface PresenceManager

A manager interface for entity presence functions.

Since:

hobson-hub-api 0.1.7

Author:

Dan Noguerol

Method Summary

Modifier and Type	Method and Description
PresenceEntityContext	addPresenceEntity(HubContext hctx, java.lang.String name) Adds a new presence entity.
PresenceLocationContext	addPresenceLocation(HubContext hctx, java.lang.String name, java.lang.Double latitude, java.lang.Double longitude, java.lang.Double radius, java.lang.Integer beaconMajor, java.lang.Integer beaconMinor) Adds a new presence location.
void	deletePresenceEntity(PresenceEntityContext ctx) Deletes a presence entity.
void	deletePresenceLocation(PresenceLocationContext ctx) Deletes a presence location.
java.util.Collection<PresenceEntity>	getAllPresenceEntities(HubContext ctx) Returns all presence entities for a hub.
java.util.Collection<PresenceLocation>	getAllPresenceLocations(HubContext ctx) Retrieves a lit of all presence locations.
PresenceEntity	getPresenceEntity(PresenceEntityContext ctx) Returns details of a presence entity.
PresenceLocation	getPresenceEntityLocation(PresenceEntityContext ctx) Retrieves the current location of a presence entity.
PresenceLocation	getPresenceLocation(PresenceLocationContext ctx) Returns details of a presence location.
void	updatePresenceEntityLocation(PresenceEntityContext ectx, PresenceLocationContext lctx) Sends an update event for a presence entity.

Method Detail

getAllPresenceEntities

java.util.Collection<PresenceEntity> getAllPresenceEntities(HubContext ctx)

Returns all presence entities for a hub.

Parameters:

ctx - the context of the target hub

Returns:

a Collection of PresenceEntity objects

getPresenceEntity

PresenceEntity getPresenceEntity(PresenceEntityContext ctx)

Returns details of a presence entity.

Parameters:

ctx - the context of the entity

Returns:

a PresenceEntity object

addPresenceEntity

PresenceEntityContext addPresenceEntity(HubContext hctx,
                                        java.lang.String name)

Adds a new presence entity.

Parameters:

hctx - the context of the hub that owns the entity

name - the name of the entity

Returns:

the ID of the newly created entity

deletePresenceEntity

void deletePresenceEntity(PresenceEntityContext ctx)

Deletes a presence entity.

Parameters:

ctx - the context of the presence entity

getPresenceEntityLocation

PresenceLocation getPresenceEntityLocation(PresenceEntityContext ctx)

Retrieves the current location of a presence entity.

Parameters:

ctx - the presence entity context

Returns:

the current location (or null if unknown)

updatePresenceEntityLocation

void updatePresenceEntityLocation(PresenceEntityContext ectx,
                                  PresenceLocationContext lctx)

Sends an update event for a presence entity.

Parameters:

ectx - the context of the entity

lctx - the context of the new location

getAllPresenceLocations

java.util.Collection<PresenceLocation> getAllPresenceLocations(HubContext ctx)

Retrieves a lit of all presence locations.

Parameters:

ctx - the context of the target hub

Returns:

a Collection of PresenceLocation objects

getPresenceLocation

PresenceLocation getPresenceLocation(PresenceLocationContext ctx)

Returns details of a presence location.

Parameters:

ctx - the context of the presence location

Returns:

a PresenceLocation object

addPresenceLocation

PresenceLocationContext addPresenceLocation(HubContext hctx,
                                            java.lang.String name,
                                            java.lang.Double latitude,
                                            java.lang.Double longitude,
                                            java.lang.Double radius,
                                            java.lang.Integer beaconMajor,
                                            java.lang.Integer beaconMinor)

Adds a new presence location.

Parameters:

hctx - the context of the target hub

name - the name of the location

latitude - the location's latitude (for map-based locations)

longitude - the location's longitude (for map-based locations)

radius - the radius around the lat/long (for map-based locations)

beaconMajor - the beacon major number (for beacon-based locations)

beaconMinor - the beacon minor number (for beacon-based locations)

Returns:

the context of the newly created location

deletePresenceLocation

void deletePresenceLocation(PresenceLocationContext ctx)

Deletes a presence location.

Parameters:

ctx - the context of the presence location to delete