2.2.3.167 Set
The Set element is an optional child element of the Oof element, the DevicePassword element, and the DeviceInformation element in Settings command requests. It sets OOF information, device password settings, or device information settings on the server.
All elements referenced in this section are defined in the Settings namespace.
Command request/response |
Parent elements |
Child elements |
Data type |
Number allowed |
---|---|---|---|---|
Settings command Oof request (section 2.2.1.18) |
Oof (section 2.2.3.122) |
OofState (section 2.2.3.124) StartTime (section 2.2.3.176.2) EndTime (section 2.2.3.61.2) OofMessage (section 2.2.3.123) |
container ([MS-ASDTYPE] section 2.2) |
0...1 (optional) |
Settings command DevicePassword request |
DevicePassword (section 2.2.3.46) |
Password (section 2.2.3.132.3) |
container |
0...1 (optional) |
Settings command DeviceInformation request |
DeviceInformation (section 2.2.3.45) |
Model (section 2.2.3.115) IMEI (section 2.2.3.91) FriendlyName (section 2.2.3.81) OS (section 2.2.3.127) OSLanguage (section 2.2.3.128) PhoneNumber (section 2.2.3.134) UserAgent (section 2.2.3.190) EnableOutboundSMS (section 2.2.3.60) MobileOperator (section 2.2.3.113) |
container |
0...1 (optional) |
Using the Settings command Oof request, the client can set the following:
§ OOF state
§ Start time and end time, if the user wants to schedule an OOF message
§ OOF message or messages for one or more of the supported audiences
Using the Settings command DevicePassword request, the client can set or clear the recovery password of the device.
Using the Settings command DeviceInformation request, clients SHOULD<14> send DeviceInformation parameters to the server before the FolderSync command (section 2.2.1.5). If the server allows non-provisionable devices, non-provisionable client SHOULD send DeviceInformation parameters to the server; otherwise, client SHOULD send DeviceInformation parameters to the server as soon as possible after the client has been provisioned. Set enables the client to specify values for any of the DeviceInformation parameters. The following statements apply to the Set element request implementation:
§ The client SHOULD specify all supported DeviceInformation parameters in the Set request. An error is not returned if all DeviceInformation parameters are not set if at least one DeviceInformation parameter is set.
§ The client or server makes no assumptions about ordering. The DeviceInformation parameters can be specified in any order.
§ To delete a given DeviceInformation value, the client MUST send the Set element as an empty element.
Protocol Versions
The following table specifies the protocol versions that support this element. The client indicates the protocol version being used by setting either the MS-ASProtocolVersion header, as specified in [MS-ASHTTP] section 2.2.1.1.2.6, or the Protocol version field, as specified in [MS-ASHTTP] section 2.2.1.1.1.1, in the request.
Protocol version |
Element support |
---|---|
2.5 |
|
12.0 |
Yes |
12.1 |
Yes |
14.0 |
Yes |
14.1 |
Yes |
16.0 |
Yes |
16.1 |
Yes |