org.eclipse.ecf.presence
Interface IPresence

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable, java.io.Serializable

All Known Implementing Classes:

Presence

public interface IPresence
extends org.eclipse.core.runtime.IAdaptable, java.io.Serializable

Presence information for a user.

Nested Class Summary

static class	IPresence.Mode A type-safe enum class to represent the presence mode information
static class	IPresence.Type A type-safe enum class to represent the presence type information

Method Summary

IPresence.Mode	getMode() Get the presence mode for this presence
byte[]	getPictureData() Get picture data for this presence
java.util.Map	getProperties() Get properties for this presence
java.lang.String	getStatus() Get status information for this presence information.
IPresence.Type	getType() Get presence type information for this presence.

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Method Detail

getMode

IPresence.Mode getMode()

Get the presence mode for this presence

Returns:

Mode the mode information for this presence. Will not return null.

getProperties

java.util.Map getProperties()

Get properties for this presence

Returns:

Map of properties for this presence information. Will not return null.

getStatus

java.lang.String getStatus()

Get status information for this presence information.

Returns:

String status information for this presence info. May return null.

getType

IPresence.Type getType()

Get presence type information for this presence.

Returns:

Type the type of presence. Will not return null.

getPictureData

byte[] getPictureData()

Get picture data for this presence

Returns:

byte [] image data. Empty array will be returned if not picture data.