ymsg.network.event
Class SessionConferenceEvent

Object
  EventObject
      SessionEvent
          SessionConferenceEvent

All Implemented Interfaces:

Serializable

public class SessionConferenceEvent

extends SessionEvent

Represents a conference event.

	getFrom	getTo	getMessage	getRoom	getUsers	getUser
conferenceInviteReceived	y	y	y (topic)	y	y	n
conferenceLogonReceived	y	y	n	y	y	y
conferenceLogoffReceived	y	y	n	y	n	y
	y	y	y	y	n	y

Since:

1.0

See Also:

Serialized Form

Field Summary

Fields inherited from class EventObject

source

Constructor Summary

SessionConferenceEvent(Object o, String t, String f, String m, YahooConference r)
Create a new instance.

SessionConferenceEvent(Object o, String t, String f, String m, YahooConference r, YahooUser[] u)
Create a new instance.

Method Summary

YahooConference	getRoom() Returns the conference name (room).
String	getTopic() Returns the welcome message sent round to introduce this conference.
YahooUser	getUser() Returns the subject user object for conference events with only one user.
YahooUser[]	getUsers() Returns an array of user objects for the other users in this conference.
String	toString() Returns a string representation of this object.

Methods inherited from class SessionEvent

getFrom, getMessage, getStatus, getTimestamp, getTo

Methods inherited from class EventObject

getSource

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SessionConferenceEvent

public SessionConferenceEvent(Object o,
                              String t,
                              String f,
                              String m,
                              YahooConference r)

Create a new instance. API users should not call this directly. The API itself will create its own events.

Parameters:

o - source of event (Session)

t - target

m - topic/message

r - conference object

Since:

1.0

SessionConferenceEvent

public SessionConferenceEvent(Object o,
                              String t,
                              String f,
                              String m,
                              YahooConference r,
                              YahooUser[] u)

Create a new instance. API users should not call this directly. The API itself will create its own events.

Parameters:

o - source of event (Session)

t - target

m - topic/message

r - conference object

u - array of user objects

Since:

1.0

Method Detail

getRoom

public YahooConference getRoom()

Returns the conference name (room). This name is used to identify the conference by the API. It is always a good idea to fetch and store this value for later use with Session class methods which facilitate conference use.

Returns:

conference object

Since:

1.0

getUsers

public YahooUser[] getUsers()

Returns an array of user objects for the other users in this conference.

Returns:

array of Yahoo user objects

Since:

1.0

getUser

public YahooUser getUser()

Returns the subject user object for conference events with only one user.

Returns:

array of Yahoo user objects

Since:

1.0

getTopic

public String getTopic()

Returns the welcome message sent round to introduce this conference. This method is a wrapper around getMessage from the parent class.

Note: documentation calls this a welcome message, but YIM itself displays the text under the heading "Topic". For this reason this API allows either getMessage or getTopic to be used.

Returns:

topic/welcome message

Since:

1.0

toString

public String toString()

Returns a string representation of this object.

Overrides:

toString in class SessionEvent

Returns:

object as a string