StringQuery 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 one query on a string-valued attribute or option.

Syntax

<StringQuery
    fieldName = "string" tag="string"
    operator = "=" | "LIKE"
    value = "string"
    ownedOnly = "True" | "False">
</StringQuery>

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. Restricts the scope of this string query. See Example later in this topic. tag is only supported when StringQuery is included in a ListMeetings Message. This meeting attribute is set in a CreateMeetingRequest Element by specifying the tagStringOption Element. 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.
operator	string type. Value range [ = \| LIKE]. Specifies the comparison operator. The equal (=) character selects comparison for equality. LIKE selects comparison with a pattern that can include the wildcard characters % and _. The % wildcard character indicates zero or more characters of any value at the position of the wildcard character. Using the underscore ( _ ) character indicates one character of any value is acceptable in the wildcard position. For example, if your string query is <StringQuery operator="LIKE" value="admi_" fieldName="name" />, you are querying for groups whose name is five characters in length (admi + _), whose fifth character can be any value while the first four characters must be admi. A group named admin can be returned given the above constraints. If your string query is <StringQuery operator="LIKE" value="admi%" fieldName="name" />, the query result can include admi, administration, or administrator. This is true because your query specified admi in the first four character positions and any number of characters of any value in position five and beyond.
value	string type. Length range 1-1023 characters. Specifies the value against which the field is compared.
ownedOnly	Boolean type. Value range [True \| False]. This attribute is optional. Default value is False. Applicable only for users with Administrator role. When True, it confines the search to the set of meetings or recordings that are owned by the authenticated user.

Element Information

Parent Elements

Element	Occurrence
CreateMeetingRequest Element	1
DeleteMeetingRequest Element	1
DeleteRecordingRequest Element	1
DisconnectVisitorsRequest Element	1
GetURLRequest Element	1
ListConnectedVisitorsRequest Element	1
ListMeetingsRequest Element	1
ListPollsRequest Element	1
ListRecordings4Request Element	1
ListRecordingVisitors4Request Element	1
ListVisitorsRequest Element	1
ModifyMeetingRequest Element	1
ModifyRecordingRequest Element	1
RestoreMeetingRequest Element	1
RestoreRecordingRequest Element	1

Child Element

Element	Occurrence
none	Not applicable

Remarks

The following table specifies the allowed values for the fieldName attribute. Unless explicitly specified otherwise, any operator can be used with any fieldName value.

StringQuery fieldName Attribute Values

fieldName Value	Description
billing	The billing field.
mid	The unique identifier for the meeting. Only the = operator is allowed.
name	The name.
opaque1	The meeting opaque1 field.
opaque2	The meeting opaque2 field.
owner	The owner field. Only the = operator is allowed.
personalPlaceOf	Value is the userID of an organizer or administrator. The query matches the Meet Now meeting for the user specified, if there is such a meeting. Only the = operator is allowed.
reid	The unique identifier for the recording. Only the = operator is allowed.
title	The title field.

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 ownedOnly attribute 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.

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

StringQuery fieldName Values by Request (Meeting Management)

fieldName Value	CreateMeeting	ModifyMeeting DeleteMeeting ListVisitors ListConnectedVisitors ListPolls DisconnectVisitors	ListMeetings
billing			X
mid		X	X
name		X	X
opaque1		X	X
opaque2		X	X
owner			X
personalPlaceOf	X	X	X
reid
title			X

StringQuery fieldName Values by Request (Other than Meeting Management)

fieldName Value	GetURL (download)	GetURL (upload)	ListRecordings4	ModifyRecording DeleteRecording ListRecordingVisitors4RestoreRecording
billing			X
mid		X
name	X(recordingname)	X(meetingname)	X	X
opaque1		X
opaque2		X
owner			X
personalPlaceOf		X
reid	X		X	X
title			X

The following table specifies the wildcard characters that can be used with the LIKE operator.

LIKE Operator Wildcard Characters

Wildcard	Description
%	Matches any string.
_	Matches any single character.

Example

<StringQuery fieldName="mid" operator="=" value="oi7pv2bbz8eq" tag='LRS'/>