3.1.4.13 AmIAlone Subrequest

  • Article

This operation is used to find out if the user is alone in a coauthoring session.<63>

The protocol client sends an AmIAlone SubRequest message, which is of type AmIAloneSubRequestType as specified in section 2.3.1.46. The protocol server responds with an AmIAlone SubResponse message, which is of type AmIAloneSubResponseType as specified in section 2.3.1.48. This is done as follows:

  • The protocol client prepares a request containing a URL for the file, a unique request token, and one or more SubRequest elements, as defined in section 2.2.3.2 and section 2.2.3.8. The SubRequest element is of type "AmIAlone".

  • The protocol server receives the request and parses the logic to request the information about whether the user is alone. The requested information is prepared as a response and sent back to the protocol client.

The Response element is defined in section 2.2.3.5, and the SubResponse element is defined in section 2.2.3.10. The AmIAloneSubResponseDataType defines the type of the SubResponseData element inside the AmIAlone SubResponse element. The AmIAloneSubResponseDataType is defined in section 2.3.1.47. The protocol server sends the requested information as AmIAlone attribute in the AmIAlone SubResponseData element. The AmIAlone attribute sent by the protocol server are defined in section 2.3.1.47.

The protocol returns results based on the following conditions:

  • If the processing of the AmIAlone subrequest by the protocol server failed to get the requested versions information or encountered an unknown exception, the protocol server returns an error code value set to "SubRequestFail".

Otherwise, the protocol server sets the error code value to "Success" to indicate success in processing the AmIAlone subrequest.