org.eclipse.ecf.presence
Interface IPresenceContainerAdapter

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable

All Known Subinterfaces:

IPresenceService

All Known Implementing Classes:

AbstractPresenceContainer, XMPPContainer, XMPPSContainer

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

Entry point presence container adapter. 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:

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

Method Summary

IAccountManager	getAccountManager() Get interface for managing account
IChatManager	getChatManager() Get chat manager for sending and receiving chat messages
IChatRoomManager	getChatRoomManager() Get chat room manager for this presence container.
IRosterManager	getRosterManager() Get roster manager for access to roster model.
IUserSearchManager	getUserSearchManager() Retrieve interface for search on the provide.

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

getAdapter

Method Detail

getRosterManager

IRosterManager getRosterManager()

Get roster manager for access to roster model. If null is returned roster manager unavailable for this adapter.

Returns:

IRosterManager if available for this adapter. Will be null if not available for for the implementing provider.

getChatManager

IChatManager getChatManager()

Get chat manager for sending and receiving chat messages

Returns:

IChatManager for this presence container adapter. Will be null if no chat manager available for given provider.

getAccountManager

IAccountManager getAccountManager()

Get interface for managing account

Returns:

IAccountManger. Will be 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.

getUserSearchManager

IUserSearchManager getUserSearchManager()

Retrieve interface for search on the provide. The returned IUserSearchManager (if not null) can be used to search users related to the same provider.

Returns:

IUserSearchManager. null if no search available for this provider.

Since:

2.0