org.eclipse.ecf.presence.roster
Interface IRosterManager

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable

All Known Implementing Classes:

AbstractRosterManager

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

Roster manager for getting access to and changing roster.

Method Summary

void	addPresenceListener(IPresenceListener listener) Setup listener for handling presence updates.
void	addRosterListener(IRosterListener listener) Add roster listener to receive roster add/update/remove events for this roster manager
void	addRosterSubscriptionListener(IRosterSubscriptionListener listener) Setup listener for handling roster subscription requests.
IPresenceSender	getPresenceSender() Retrieve interface for sending presence updates.
IRoster	getRoster() Get roster for this account.
IRosterSubscriptionSender	getRosterSubscriptionSender() Get roster subscription sender.
void	removePresenceListener(IPresenceListener listener) Remove listener for presence events.
void	removeRosterListener(IRosterListener listener) Remove roster listener
void	removeRosterSubscriptionListener(IRosterSubscriptionListener listener) Remove listener for roster subscription requests.

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

getAdapter

Method Detail

getRoster

IRoster getRoster()

Get roster for this account.

Returns:

IRoster for this roster manager. Will not be null.

addRosterListener

void addRosterListener(IRosterListener listener)

Add roster listener to receive roster add/update/remove events for this roster manager

Parameters:

listener - the listener to add. Must not be null.

removeRosterListener

void removeRosterListener(IRosterListener listener)

Remove roster listener

Parameters:

listener - the listener to remove. Must not be null.

addRosterSubscriptionListener

void addRosterSubscriptionListener(IRosterSubscriptionListener listener)

Setup listener for handling roster 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.

removeRosterSubscriptionListener

void removeRosterSubscriptionListener(IRosterSubscriptionListener listener)

Remove listener for roster subscription requests.

Parameters:

listener - the listener to remove. Will not be null.

getRosterSubscriptionSender

IRosterSubscriptionSender getRosterSubscriptionSender()

Get roster subscription sender. The roster subscription sender returned by this method, if not null, may be used to send roster subscribe and unsubscribe requests

Returns:

IRosterSubscriptionSender the sender to use. If null, sending requests for roster updates are not supported.

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.

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. Must not be null.