InstallMediaResponse
A response from the device after it processes the command to install a book on a device.
Declaration
object InstallMediaResponseProperties
| Name | Type | Description |
|---|---|---|
CommandUUID | string | The unique identifier of the command for this response. |
EnrollmentID Required | string | The per-enrollment identifier for the device. The system requires this value if the enrollment type is a user enrollment. Available in iOS 13 and later, macOS 10.15 and later, and visionOS 2 and later. |
ErrorChain | [InstallMediaResponse.ErrorChainItem] | An array of dictionaries that describes any errors that occur. |
iTunesStoreID | integer | The book’s iTunes Store identifier, if present in the command. |
MediaType | string | The media type, which can only be |
MediaURL | string | The URL to retrieve the book, if present in the command. This value is available in iOS 8 and later. |
PersistentID | string | The book’s persistent identifier, if present in the command. This value is available in iOS 8 and later. |
RejectionReason | string | The reason, if installation fails, which is one of the following values:
|
State | string | The installation state of this book. The |
Status Required | string | The status of the response, which is one of the following values:
|
UDID Required | string | The device’s UDID (unique device identifier). The system requires this value if the enrollment type is a device enrollment. |
UserID | string | For macOS, this value is the ID of the user. For Shared iPad, this value is |
UserShortName | string | For macOS, this value is the short name of the user. For Shared iPad, this value is the Managed Apple Account identifier of the user on Shared iPad. It indicates that the token is for the user channel. |
EnrollmentUserID Required | string | |
NotOnConsole Required | boolean | |
UserLongName Required | string |