Share via

2.3.3.7 EditorsTableSubRequestDataOptionalAttributes

  • Article

The EditorsTableSubRequestDataOptionalAttributes attribute group contains attributes that MUST be used only for SubRequestData elements associated with the parent SubRequest element for an editors table subrequest. The attributes in EditorsTableSubRequestDataOptionalAttributes are used as input parameters for processing the data associated with an editors table subrequest. The definition of the EditorsTableSubRequestDataOptionalAttributes attribute group is as follows:

 <xs:attributeGroup name="EditorsTableSubRequestDataOptionalAttributes">
     <xs:attribute name="EditorsTableRequestType" type="tns:EditorsTableRequestTypes" use="optional"/>
 </xs:attributeGroup>

EditorsTableRequestType: An EditorsTableRequestTypes that specifies the type of editors table subrequest. EditorsTableRequestTypes is defined in section 2.3.2.5.

Depending on the type of the editors table subrequest, the following table shows a mapping between the type of editors table subrequest and the attributes that MUST be specified for that EditorsTableRequestType.

In the following table, Timeout, ClientID, AsEditor, Key, and Value are attributes that MUST be specified for the SubRequestData element associated with the editors table subrequest, depending on the type of editors table subrequest.

In the following table, “Yes” signifies that the attribute MUST be specified as part of the SubRequestData element associated with the editors table subrequest.

Value of

EditorsTableRequestType

Timeout

ClientID

AsEditor

Key

Value

"JoinEditingSession"

(Join Editing Session)

Yes

Yes

Yes

"LeaveEditingSession"

(Leave Editing Session)

Yes

"RefreshEditingSession"

(Refresh Editing Session)

Yes

Yes

Yes

"UpdateEditorMetadata"

(Update Editor Metadata)

Yes

Yes

Yes

"RemoveEditorMetadata"

(Remove Editor Metadata)

Yes

Yes