TimeIntervalQuery 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 a query against a time-valued attribute or option. The query matches when the value of the attribute or option specified by fieldName falls within the time represented by the TimeInterval child element.

Syntax

<TimeIntervalQuery
    fieldName = "string" tag="string"
    ownedOnly = "True" | "False">
    <TimeInterval ...></TimeInterval>
</TimeIntervalQuery>

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

Attributes

Name	Description
fieldName	string type. Length range 1-255 characters. Specifies the name of the attribute or option against which the comparison is made.
tag	string type. Length range 1-3 characters. This attribute is optional. The attribute is only supported when TimeIntervalQuery is used in a ListMeetings Message. To set the tag value for a meeting created using the CreateMeeting Message, set the StringOption Element "tag" to an acceptable value. Restricts the scope of this string query. The tag option values assigned by a client must not be in the following list of values reserved by Live Meeting: "LRS", "RPD", "OLK" or any value beginning with"_". For example, "_EA" cannot be used by a client except where the client is querying for Easy Assist sessions. Added in Live Meeting service API Update for Live Meeting 2007.
ownedOnly	Boolean type. Value range [True \| False]. This attribute is optional. Default value is False. Applicable only for users with Administrator role. If True, confines the search to the set of meetings or recordings that are owned by the authenticated user.

fieldName

string type. Length range 1-255 characters.

Specifies the name of the attribute or option against which the comparison is made.

tag

string type. Length range 1-3 characters.

This attribute is optional. The attribute is only supported when TimeIntervalQuery is used in a ListMeetings Message. To set the tag value for a meeting created using the CreateMeeting Message, set the StringOption Element "tag" to an acceptable value.

Restricts the scope of this string query.

The tag option values assigned by a client must not be in the following list of values reserved by Live Meeting: "LRS", "RPD", "OLK" or any value beginning with"_". For example, "_EA" cannot be used by a client except where the client is querying for Easy Assist sessions.

Added in Live Meeting service API Update for Live Meeting 2007.

ownedOnly

Boolean type. Value range [True | False]. This attribute is optional. Default value is False.

Applicable only for users with Administrator role.

If True, confines the search to the set of meetings or recordings that are owned by the authenticated user.

Element Information

Parent Elements

Element	Occurrence
ListConnectedVisitorsRequest	1
ListMeetingsRequest	1
ListRecordings4Request	1
ListRecordingVisitors4Request	1
ListVisitorsRequest	1

Child Element

Element	Occurrence
TimeInterval	1

Remarks

The TimeInterval child element represents a half-open time interval.

The following table specifies the allowed values for the fieldName attribute.

TimeIntervalQuery fieldName Attribute Values

fieldName Value	Description
createOrModifyTime	The query matches meetings and recordings with a createTime or a modifyTime value in the given time interval.
endTime	The meeting end time. Ongoing meetings do not match a query with this field.
startTime	For a meeting or recording, the time it started. For a visitor to a meeting, the time when the console started. For a visitor to a recording, the time the user accessed the recording.
visitedIn	The query matches meetings or recordings that had at least one visitor during the given time interval.

The following table specifies which fieldName values are valid in each possible request. An X indicates that the value is valid.

TimeIntervalQuery fieldName Values by Request

fieldName Value	ListMeetings	ListRecordings4	ListRecordingVisitors4	ListConnectedVisitors ListVisitors
createOrModifyTime	X	X
endTime	X
startTime	X	X	X	X
visitedIn	X		X

If the requestor is an administrator, the query searches through all meetings or recordings in the conference center unless ownedOnly is set to True, in which case the search is limited to meetings or recordings owned by that administrator. By default, the attribute ownedOnly is False.

If the requestor is an organizer, the search is limited to meetings or recordings owned by that organizer. In this case, the ownedOnly attribute has no effect on the search results.

Example

The following example creates a time based query for Easy Assist sessions created in the month of July, 2008

<TimeIntervalQuery fieldName="startTime" tag='_EA'>
   <TimeInterval startTime="2008-07-01T00:00:00Z"
          endTime="2008-08-01T00:00:00Z"/>
</TimeIntervalQuery>