Visitor 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.

Represents the time that each visitor is connected to the meeting during an hour.

Syntax

<Visitor>
    ...
</Visitor>

The following sections describe attributes, parent elements, and child elements.

Attributes

None.

Element Information

Parent Elements

Element	Occurrence
ListConnectedVisitorsReply	1
ListVisitorsReply	1

Child Element

Element	Occurrence
OptionList	1

Remarks

Represents the time that each visitor is connected to the meeting during an hour. When a visitor is connected across an hour boundary, there is a Visitor element for each hour in which the visitor is connected. The following table specifies the options that can appear as the child elements of OptionList in the Visitor element.

Option Name	Description
browser	StringOption. Length range 1-255 characters. Specifies the value of the User-Agent HTTP header from the users browser.
company	StringOption. Length range 1-255 characters. Specifies the visitor's company name as supplied on the extended registration entry form or by the company property of the entry URL.
email	StringOption. Length range 1-255 characters. Specifies the visitor's e-mail address as supplied on the extended registration entry form or by the e-mail property of the entry URL.
endTime	TimeOption. Value range yyyy-mm-ddThh:mm:ssZ. Indicates the time when the user disconnected from the meeting. Represents a date and time in (ISO 8601 extended) UTC format.
extra1	StringOption. Length range 1-128 characters. The conference center does not interpret this field. The value of this option is supplied by the extra1 property of the entry URL.
extra2	StringOption. Length range 1-128 characters. The conference center does not interpret this field. The value of this option is supplied by the extra2 property of the entry URL.
extra3	StringOption. Length range 1-255 characters. The conference center does not interpret this field. The value of this option is supplied by the extra3 property of the entry URL.
ipAddr	StringOption. Length range 7-15 characters. Specifies the IP address from which the users connection came. If the user connects using a proxy server, this is the proxy servers address.
lc	StringOption. Length range 1-255 characters. The value of this option is supplied by the lc property of the entry URL. It is the locale requested for this user for the meeting. Only one of the locales supported by the conference center can be specified. The list of locales supported by a conference center can be queried using the locales option in GetConferencingServiceData. Specifying an unsupported locale results in an error being returned.
role	EnumerationOption. Value range [Audience \| Presenter]. Tells whether the user is an audience member or a presenter.
src	StringOption. Length range 1-255 characters. The conference center does not interpret this field. The value of this option is supplied by the src property of the entry URL.
startTime	TimeOption. Value range yyyy-mm-ddThh:mm:ssZ. Indicates the time when the console started. Represents a date and time in (ISO 8601 extended) UTC format.
userName	StringOption. Length range 1-255 characters. Specifies the visitor's name, as supplied on the entry form or from the cn property of the entry URL.
vid	StringOption. Length range 1-16 characters. Specifies the visitor ID assigned by the conference center. A new vid is assigned for each new Web browser launch page instance.

An application can use extra1, extra2, extra3, and src options to store additional information about the visitor, when the visitor accesses the meeting through that application.

Example

In the following example, you can see the visitor named Kim who has a vid of bqbdh6gqswv4x3pq and attended the meeting from 22:47:28 UTC to 23:35:32 UTC. The first Visitor element shows Kims attendance in the 2200 hour. The second Visitor element shows Kims attendance in the 2300 hour.

<PlaceWareConfCenter>
  <ListVisitorsReply>
    <Visitor>
      <OptionList>
        <StringOption value="Kim" name="userName"></StringOption>
        <StringOption value="bqbdh6gqswv4x3pq" name="vid"></StringOption>
        <TimeOption value="2006-05-03T22:47:28Z" name="startTime"></TimeOption>
        <TimeOption value="2006-05-03T23:00:00Z" name="endTime"></TimeOption>
        <EnumerationOption value="Presenter" name="role">
          <String>Audience</String>
          <String>Presenter</String>
        </EnumerationOption>
      </OptionList>
    </Visitor>
    <Visitor>
      <OptionList>
        <StringOption value="Kim" name="userName"></StringOption>
        <StringOption value="bqbdh6gqswv4x3pq" name="vid"></StringOption>
        <TimeOption value="2006-05-03T23:00:00Z" name="startTime"></TimeOption>
        <TimeOption value="2006-05-03T23:35:32Z" name="endTime"></TimeOption>
        <EnumerationOption value="Presenter" name="role">
          <String>Audience</String>
          <String>Presenter</String>
        </EnumerationOption>
      </OptionList>
    </Visitor>
  </ListVisitorsReply>
</PlaceWareConfCenter>