StringListQuery Element

Artigo
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 list of queries on several string-valued attributes or options. Used to do a bulk query.

Syntax

<StringListQuery fieldName="string" ownedOnly="True" tag="string">
  <String> ... </String>
  <String> ... </String>
...
  <String> ... </String>
</StringListQuery>

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

Attributes

Name	Description
fieldName	string attribute. Length range 1-255 characters. Specifies the name of the attribute or option being compared against.
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.
tag	string type. Length range 1-3 characters. Restricts the scope of this string query. This attribute is only supported when StringListQuery is included in a ListMeetings Message. To set the tag value of a meeting, use the CreateMeetingRequest Element and include a StringOption Element with a name attribute set to "tag". 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.

fieldName

string attribute. Length range 1-255 characters.

Specifies the name of the attribute or option being compared against.

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.

tag

string type. Length range 1-3 characters.

Restricts the scope of this string query. This attribute is only supported when StringListQuery is included in a ListMeetings Message. To set the tag value of a meeting, use the CreateMeetingRequest Element and include a StringOption Element with a name attribute set to "tag".

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.

Element Information

Parent Elements

Element	Occurrence
DeleteMeetingRequest	1
ListMeetingsRequest	1

Child Element

Element	Description
String	1 or more to a maximum of 100.

Remarks

The StringListQuery message allows the user to request the listing or deletion of a set of up to 100 meetings. In other words, whereas in prior versions of Live Meeting, a DeleteMeeting request message can only delete a single meeting, including a StringListQuery element with from 1 to 100 name values deletes all matching meetings in the query set with a single DeleteMeeting request message. The following example illustrates the use of StringListQuery and identifies meetings by the name attribute. You can also supply mid, opaque1, opaque2, or personalPlaceOf. Each of these attributes identify exactly one meeting.

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

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

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

StringListQuery fieldName Values by Request

fieldName Value	DeleteMeeting	ListMeetings
billing		X
mid	X	X
name	X	X
opaque1	X	X
opaque2	X	X
owner		X
personalPlaceOf	X	X
reid
title		X

Example

Currently, ListMeetings and DeleteMeeting are the only APIs that support StringListQuery. The following code shows the format of the element. The attribute tag is optional.

<StringListQuery fieldName='name' ownedOnly="True" tag='LRS'>
  <String>name1</String>
  <String>name2</String>
  ...
  <String>nameN</String>
</StringListQuery>

Compartilhar via