com.sun.im.service
Interface ConferenceSession

All Superinterfaces:
CollaborationSession

public interface ConferenceSession
extends CollaborationSession


Method Summary
 Conference getPublicConference(java.lang.String destination)
          retrieve a public conference without joining Verified that the conference exists
 Conference joinPublicConference(java.lang.String destination, ConferenceListener listener)
          join a public conference
 java.util.Collection listPublicConferences(java.lang.String domain)
          Deprecated. use PersonalStore.search() to get conference entries
 Conference setupConference(ConferenceListener listener, int accessLevel)
          setup a new conference
 Conference setupPublicConference(java.lang.String destination, ConferenceListener listener, int accessLevel)
          create a new public conference A public conference is a conference which persists even when no member is present.
 
Methods inherited from interface com.sun.im.service.CollaborationSession
accessService, addPrivacyList, addSessionListener, changePassword, createPrincipal, createPrincipal, createPrivacyList, getActivePrivacyListName, getConferenceService, getDefaultPrivacyListName, getNewsService, getNotificationService, getPersonalStoreService, getPresenceService, getPrincipal, getPrivacyList, getStreamingService, listPrivacyLists, logout, removePrivacyList, removeSessionListener, setActivePrivacyListName, setDefaultPrivacyListName, setSessionListener, unregister
 

Method Detail

setupConference

public Conference setupConference(ConferenceListener listener,
                                  int accessLevel)
                           throws CollaborationException
setup a new conference

Parameters:
listener - conference listener
accessLevel - privilegdes to assign to the invited user.
Returns:
a new conference handle. The only member so far is the owner of this session. The invite method in the Conference object can then be used to invite other users to the conference.
Throws:
CollaborationException

joinPublicConference

public Conference joinPublicConference(java.lang.String destination,
                                       ConferenceListener listener)
                                throws CollaborationException
join a public conference

Parameters:
destination - conference address
listener - conference listener
Throws:
CollaborationException

setupPublicConference

public Conference setupPublicConference(java.lang.String destination,
                                        ConferenceListener listener,
                                        int accessLevel)
                                 throws CollaborationException
create a new public conference A public conference is a conference which persists even when no member is present. It is generally used as a public instant discussion forum, aka public chat room. It differs from a bulletin board in that messages are not persistant. A public conference is joined by other users using the join method.

Parameters:
destination - identifier for this conference
listener - conference listener
accessLevel - default privilegdes to assign to the joining users.
Throws:
CollaborationException
See Also:
join

listPublicConferences

public java.util.Collection listPublicConferences(java.lang.String domain)
                                           throws CollaborationException
Deprecated. use PersonalStore.search() to get conference entries

list all available public conferences within a domain

Parameters:
domain - name of the domain to search.
Returns:
a collection of Conference objects. Note that the current user does not join the listed conferences as a result of this call. Conference returned by this call can be join by invoking the join method of the conference objects.
Throws:
CollaborationException

getPublicConference

public Conference getPublicConference(java.lang.String destination)
                               throws CollaborationException
retrieve a public conference without joining Verified that the conference exists

Parameters:
destination - identifier for this conference
Throws:
CollaborationException