conference Element

Article
05/23/2014

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Groups conference-related events.

Syntax

<conference eid="integer value" confId="integer value"/>

Attributes

Attribute	Data Type	Description
eid	integer	Event Id. This is an integer value assigned by the Communicator Web Access Server.
confId	integer	Conference Id. This is an integer value assigned by the Communicator Web Access Server. This is a required attribute.

Element Information

Parent Element

Element	Description
cwaEvents	Holds the responses from the asynchronous data channel with which a Unified Communications AJAX API Client polls the server for updates that have taken place.

Child Elements

Element	Occurrences	Description
confUri	0 or 1	The SIP uri of the conference focus
enableAppearOffline	0 or 1	Indicates user is allowed to set status to "Appear Offline". It contains a text element value "true" or "false".
imSessionReceived	0 or 1	Indicates that an instant messaging session invitation is received.
imSessionState	0 or 1	Returns data or metadata related to an IM conversation. Possible values are connected, incoming, connecting or terminated.
messageReceived	0 or 1	Returns an IM message received from another participant.
messageIdReceived	0 or 1	An identifier returned by the other end indicating which message this is in the sequence
composingState	0 or 1	Notifies other users in an IM session that the caller is in the process of typing a message. Possible values are composing or idle.
initiateImSessionAccepted	0 or 1	Indicates that the initial request to initiate an IM session has been accepted by a Communicator Web Access server.
inviteFailed	0 or 1	This conference event element contains the SIP uri of an invited participant that did not accept an IM invitation.
locked	0 or 1	Indicates whether others are permitted to join the conference.
escalationMode	0 or 1	Indicates what the mode the conference is in. Possible values are invitingPeer, peer, escalated, or escalating.
role	0 or 1	Indicates the role of the participant in a session. The value can be "presenter" or "peer" that indicate if you are a conference leader or not.
participant	0 or 1	Indicates that a participant has been added or updated to the IM session.
participantRemoved	0 or 1	Indicates that a participant has been removed from the conference session.
voIPReceived	0 or 1	Represents a Communicator Web Access server notification that the client has received a VoIP INVITE.
voIPTerminated	0 or 1	Represents a Communicator Web Access server notification that the VoIP invitation has been terminated.

Remarks

The conference event element is the parent for all IM-related events that a Unified Communications AJAX API Client application receives.

Examples

The following examples illustrate typical events raised by a conference session.

A local user is attempting to create a one to one conference. The invited user is not online and does not respond to the invitation.

<cwaEvents pollWaitTime="3000" ackId="23" sid="1567">
  <conference eid="18" confId="1">
    <initiateImSessionAccepted rid="5" confId="1" />
  </conference>
  <conference eid="19" confId="1">
    <escalationMode>invitingPeer</escalationMode>
  </conference>
  <conference eid="20" confId="1">
    <escalationMode>none</escalationMode>
  </conference>
  <conference eid="21" confId="1">
    <inviteFailed uri="sip:jaya@contoso.com" />
  </conference>
  <requestFailed eid="22" rid="5">
    <error code="18201" reason="Operation failed" detail="The requested operation failed.">
      <sipResponse code="480" reason="Temporarily Unavailable">
        <ms-diagnostics>2;reason="See response code and reason phrase";source="contoso.com";AppUri="http://www.contoso.com/LCS/DefaultRouting"</ms-diagnostics>
      </sipResponse>
    </error>
  </requestFailed>
  <conference eid="23" confId="1">
    <imSessionState>terminated</imSessionState>
  </conference>
</cwaEvents>

In this example, Sally G. has sent a message to another user in an active. one-to-one IM session. The cwaEvents packet contains the identity of the sender in the sender attribute, message content, and message formatting information. See the format element for more information about message formatting.

<cwaEvents pollWaitTime="2000" ackId="36" sid="83">
   <conference eid="36" confId="1">
     <messageReceived sender="sip:sallyg@contoso.com">
        <message>
           <format>X-MMS-IM-Format: FN=Arial; EF=; CO=000000; CS=1;
           PF=00/>
             <content>hello</content>
        </message>
     </messageReceived>
   </conference>
</cwaEvents>

When participating in a conference, it is important that the local user notifies the remote users when he is typing or idle. The local client sends his current composing state to remote participants. The event is received in the following form. See the notifyComposing element for information about sending a composing message.

<conference eid="37" confId="1">
     <composingState uri="sip:guest2@contoso.com">idle</composingState>
</conference>

This event notifies the local user that she has been promoted to the role of presenter.

<cwaEvents pollWaitTime="2000" ackId="27" sid="1569">
  <conference eid="27" confId="1">
    <role>presenter</role>
  </conference>
</cwaEvents>

A one-to-one IM conference has been escalated to a focus-based conference by the Communicator Web Access Server with the invitation of a third participant. The conference focus uri sent on escalating. The value should be cached locally in the event the local participant is disconnected and wants to reconnect to the conference.

<cwaEvents pollWaitTime="1000" ackId="26" sid="1569">
  <conference eid="25" confId="1">
    <escalationMode>escalating</escalationMode>
  </conference>
  <conference eid="26" confId="1">
    <confUri>sip:guest1@contoso.com;gruu;opaque=app:conf:focus:id:A0D4R2K66PIKGS3POYUSPOC238VJJIVI</confUri>
  </conference>
</cwaEvents>

Communicator Web Access Server has sent a conference event listing the participants in the active conference. Note that the participant's role is provided in the role attribute of the participant element.

<cwaEvents pollWaitTime="2000" ackId="48" sid="1567">
  <conference eid="46" confId="2">
    <participant uri="sip:guest1@contoso.com" name="" role="presenter" />
  </conference>
  <conference eid="47" confId="2">
    <escalationMode>escalated</escalationMode>
  </conference>
  <conference eid="48" confId="2">
    <participant uri="sip:guest2@contoso.com" name="guest2" role="attendee" />
  </conference>
</cwaEvents>

This event is sent on termination of a conference.

<cwaEvents pollWaitTime="1000" ackId="66" sid="1567">
  <conference eid="66" confId="2">
    <imSessionState>terminated</imSessionState>
  </conference>
</cwaEvents>

If a participant leaves or is ejected from a conference, this event is sent to all remaining participants.

<cwaEvents pollWaitTime="1000" ackId="65" sid="1567">
  <conference eid="65" confId="2">
    <participantRemoved>sip:guest1@contoso.com</participantRemoved>
  </conference>
</cwaEvents>