org.eclipse.ecf.presence
Interface IPresenceContainer

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable

All Known Implementing Classes:

AbstractPresenceContainer

public interface IPresenceContainer
extends org.eclipse.core.runtime.IAdaptable

Entry pointer adapter interface for setting up listeners for presence messages, text messages, subscription requests, and for getting interfaces for message sending (IMessageSender) presence updates (IPresenceSender) and account management (IAccountManager)

To use this adapter:

  IPresenceContainer presenceContainer = (IPresenceContainer) container.getAdapter(IPresenceContainer.class);
  if (presenceContainer != null) {
     ...use presenceContainer
  } else {
     ...presence not supported by provider
  }
 

Method Summary

void	addMessageListener(IMessageListener listener) Setup listener for handling IM messages.
void	addPresenceListener(IPresenceListener listener) Setup listener for handling presence updates.
void	addSubscribeListener(ISubscribeListener listener) Setup listener for handling subscription requests.
IAccountManager	getAccountManager() Get interface for managing account
IChatRoomManager	getChatRoomManager() Get chat room manager for this presence container.
IMessageSender	getMessageSender() Get interface for sending messages
IPresenceSender	getPresenceSender() Retrieve interface for sending presence updates.
void	removeMessageListener(IMessageListener listener) REmove listener for message events
void	removePresenceListener(IPresenceListener listener) Remove listener for presence events.
void	removeSubscribeListener(ISubscribeListener listener) Remove listener for subscription requests.

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

getAdapter

Method Detail

addSubscribeListener

void addSubscribeListener(ISubscribeListener listener)

Setup listener for handling subscription requests. The given listener will asynchronously be called when a subscription request is received by this connected account.

Parameters:

listener - for receiving subscription requests. Must not be null.

removeSubscribeListener

void removeSubscribeListener(ISubscribeListener listener)

Remove listener for subscription requests.

Parameters:

listener - the listener to remove

addPresenceListener

void addPresenceListener(IPresenceListener listener)

Setup listener for handling presence updates. The given listener will asynchronously be called when a subscription request is received by this connected account.

Parameters:

listener - for receiving presence notifications. Must not be null.

removePresenceListener

void removePresenceListener(IPresenceListener listener)

Remove listener for presence events.

Parameters:

listener - the listener to remove

addMessageListener

void addMessageListener(IMessageListener listener)

Setup listener for handling IM messages. The given listener will asynchronously be called when a subscription request is received by this connected account.

Parameters:

listener - for receiving message notifications. Must not be null.

removeMessageListener

void removeMessageListener(IMessageListener listener)

REmove listener for message events

Parameters:

listener - the listener to remove

getPresenceSender

IPresenceSender getPresenceSender()

Retrieve interface for sending presence updates. The returned IPresenceSender (if not null) can be used to send presence change messages to remote users that have access to the presence information for the connected account.

Returns:

IPresenceSender. Null if no presence sender available for this provider.

getMessageSender

IMessageSender getMessageSender()

Get interface for sending messages

Returns:

IMessageSender. Null if no message sender available

getAccountManager

IAccountManager getAccountManager()

Get interface for managing account

Returns:

IAccountManger. Null if no account manager available

getChatRoomManager

IChatRoomManager getChatRoomManager()

Get chat room manager for this presence container. If returns null, no chat room facilities are available

Returns:

a chat room manager instance if chat room facilities are available for this presence container If no such facilities are available, returns null