Member Complex Type

The Member type is the web service representation of a member of a workspace.

Syntax

<Member>
  <URI />
  <Contact /> 
  <Name />  
  <Role />  
  <Awareness />  
  <AwarenessState /> 
  <TimeWentIdle />
  <SyncState />
  <ActiveInSpace /> 
  <ActiveInTool> 
    <!-- Array of -->  <URI /> 
  </ActiveInTool> 
</Member>

Complex Type Elements

Element	Data type	Description
URI	xs:anyURI	The Groove Identity URL for the member (including the initial "grooveIdentity://"). The usage of this element depends on the context: Read operation: value provided by operation. Create operation: value required by operation. Update operation: value ignored by operation. Events: value provided by events.
Contact	xs:anyURI	URI for GrooveContacts Web Service. The usage of this element depends on the context: Read operation: value provided by operation. Create operation: value ignored by operation. Update operation: value ignored by operation. Events: value provided by events.
Name	xs:string	The member's name. This element is optional. The usage of this element depends on the context: Read operation: value provided by operation. Create operation: value ignored by operation. Update operation: value ignored by operation. Events: value provided by events.
Role	xs:string	Specifies the member's role within the workspace with one of the following strings: “$Telespace.Manager” for manager, “$Telespace.Member” for participant, and “$Telespace.Guest” for guest. This element is optional. The usage of this element depends on the context: Read operation: value provided by operation. Create operation: value required by operation. Update operation: value required by operation. Events: value provided by events.
Awareness	xs:string	The member's current awareness status. The string values returned in this element include "Offline" and "Online". In the future, other string values may be returned by Groove, so your code should be prepared to handle additional values. String comparisons should be case insensitive because case variations of the strings are possible. For example "Online" can also be returned as "OnLine". This element is optional. The usage of this element depends on the context: Read operation: value provided by operation if a subscription to member events is active. If there is no subscription to member events, Read does not return this element; consequently, you should test this element to ensure it is not null before getting its value. Create operation: value ignored by operation. Update operation: value ignored by operation. Events: value provided by MemberAddEventData, MemberAwarenessEventData, and MemberUpdateEventData events but is not provided by other GrooveMember events.
AwarenessState	xs:string	A string defining the member's current online status. This string is intended for display to the user. It may be identical to the Awareness string above, or it may contain additional user-defined information. This element is optional. The usage of this element depends on the context: Read operation: value provided by operation if a subscription to member events is active. If there is no subscription to member events, Read does not return this element; consequently, you should test this element to ensure it is not null before getting its value. Create operation: value ignored by operation. Update operation: value ignored by operation. Events: value provided by MemberAddEventData, MemberAwarenessEventData, and MemberUpdateEventData events but is not provided by other GrooveMember events.
TimeWentIdle	xs:dateTime	The date-time when the member last was online and actively using the Groove user interface. A user using a Web Services SOAP client and not the Groove user interface is reported as idle. This element is optional. The usage of this element depends on the context: Read operation: value provided by operation if a subscription to member events is active. If there is no subscription to member events or if the member is offline or not idle, Read does not return this element; consequently, you should test this element to ensure it is not null before getting its value. Create operation: value ignored by operation. Update operation: value ignored by operation. Events: If the member is idle, value is provided by MemberAddEventData, MemberAwarenessEventData, and MemberUpdateEventData events. Value is not be provided if the member is not idle for these events or for other GrooveMember events. You should test this element to ensure it is not null before getting its value.
SyncState	xs:string	Describes whether the member is synchronizing updates in the workspace or has been suspended from the workspace and is not receiving updates. A value of "1" indicates that the member is synchronizing updates and a value of "2" indicates that the member has been suspended. This element is optional. The usage of this element depends on the context: Read operation: value provided by operation. Create operation: value ignored by operation. Update operation: value ignored by operation. Events: value provided by events.
ActiveInSpace	xs:anyURI	Specifies whether the member is currently active in the workspace. If the member is active in the workspace, the value of this element is the URI that identifies the workspace. This element is optional. The usage of this element depends on the context: Read operation: value provided by operation if there is a subscription for member events. If there is no subscription to member events, Read does not return this element; consequently, you should test this element to ensure it is not null before getting its value. Create operation: value ignored by operation. Update operation: value ignored by operation. Events: value provided by MemberEnterSpaceEventData and MemberExitSpaceEventData events, but is not provided by other events.
ActiveInTool	Array of xs:anyURI	Each URI specifies the URI of a tool in the workspace that the member is currently active in. The ActiveInTool array can contain zero or more URI elements. This element is optional. The usage of this element depends on the context: Read operation: value provided by operation if there is a subscription for member events. If there is no subscription to member events, Read does not return this element; consequently, you should test this element to ensure it is not null before getting its value. Create operation: value ignored by operation. Update operation: value ignored by operation. Events: value provided by MemberEnterToolEventData and MemberExitToolEventData events, but is not provided by other events.

See Also

Reference

GrooveMembers Web Service