com.zion.jbuddy.conference
Interface IConferenceService

public interface IConferenceService

Provides multi-user conferencing capabilities to the client.

A conference service can be used to create new conferences, join existing conferences, and accept incoming conference invitations. To retrieve a client's conference service, call its getConferenceService method.

An IConferenceServiceListener may be added to this conference service to listen for incoming events, such as invitationReceived and joined.

See IConference for more information.

Valid for AIM, ICQ, JABBER, LCS, MSN, SAMETIME, YIM.

Since:

5.0, 6.3 LCS (only OCS)

See Also:

IClient.getConferenceService(), IConference, IConferenceServiceListener, ConferenceServiceAdapter

Method Summary

void	addListener(IConferenceServiceListener listener) Enables a listener to receive events from this conference service.
IConference	conferenceFactory() Returns a new conference instance.
IClient	getClient() Returns the client this conference service is associated with.
IConference	getConference(String name) Returns a conference that the client is connected or connecting to.
IConference[]	getConferences() Returns the conferences the client is connected or connecting to.
void	removeListener(IConferenceServiceListener listener) Stops a listener from receiving events from this conference service.

Method Detail

getClient

IClient getClient()

Returns the client this conference service is associated with.

getConference

IConference getConference(String name)

Returns a conference that the client is connected or connecting to.

Valid for AIM, ICQ, JABBER, SAMETIME, YIM.

Parameters:

name - the name of the conference

Returns:

the conference. Returns null if the conference doesn't exist, or the protocol doesn't support conference names.

getConferences

IConference[] getConferences()

Returns the conferences the client is connected or connecting to.

addListener

void addListener(IConferenceServiceListener listener)

Enables a listener to receive events from this conference service.

removeListener

void removeListener(IConferenceServiceListener listener)

Stops a listener from receiving events from this conference service.

conferenceFactory

IConference conferenceFactory()

Returns a new conference instance.

To connect to the conference, either create or join must be called on the conference.

See Also:

IConference.create(java.lang.String), IConference.join(java.lang.String), IConference.addListener(com.zion.jbuddy.conference.IConferenceListener)