mirror of
https://github.com/apple/device-management.git
synced 2026-02-12 21:03:12 +00:00
72 lines
2.2 KiB
YAML
72 lines
2.2 KiB
YAML
title: Request Mirroring Command
|
|
description: Prompt the user to share their screen using AirPlay Mirroring.
|
|
payload:
|
|
requesttype: RequestMirroring
|
|
supportedOS:
|
|
iOS:
|
|
introduced: '7.0'
|
|
accessrights: None
|
|
supervised: false
|
|
requiresdep: false
|
|
sharedipad:
|
|
mode: allowed
|
|
devicechannel: true
|
|
userchannel: false
|
|
userenrollment:
|
|
mode: allowed
|
|
macOS:
|
|
introduced: '10.10'
|
|
accessrights: None
|
|
devicechannel: true
|
|
userchannel: false
|
|
supervised: false
|
|
requiresdep: false
|
|
userenrollment:
|
|
mode: allowed
|
|
tvOS:
|
|
introduced: n/a
|
|
visionOS:
|
|
introduced: n/a
|
|
watchOS:
|
|
introduced: n/a
|
|
content: This command prompts the user to share their screen using AirPlay Mirroring.
|
|
payloadkeys:
|
|
- key: DestinationName
|
|
type: <string>
|
|
presence: optional
|
|
content: The name of the AirPlay Mirroring destination.
|
|
- key: DestinationDeviceID
|
|
type: <string>
|
|
presence: optional
|
|
content: The hardware address of the AirPlay Mirroring destination that identifies
|
|
the device, in the format `xx:xx:xx:xx:xx`. This value isn't case-sensitive. Not
|
|
available for Apple TV devices running tvOS 18 or later, use `DestinationName`
|
|
instead.
|
|
- key: ScanTime
|
|
type: <integer>
|
|
presence: optional
|
|
content: The number of seconds, from `10` to `300`, for the device to spend searching
|
|
for the destination. The default value is `30`.
|
|
- key: Password
|
|
type: <string>
|
|
presence: optional
|
|
content: The screen-sharing password that the device uses when connecting to the
|
|
destination.
|
|
responsekeys:
|
|
- key: MirroringResult
|
|
type: <string>
|
|
presence: optional
|
|
content: |-
|
|
The result of the request. One of these values:
|
|
|
|
- `Prompting`: The user is receiving a prompt to share their screen.
|
|
- `DestinationNotFound`: The device is unable to reach the destination.
|
|
- `Cancelled`: The user canceled the request.
|
|
- `Unknown`: An unknown error occurred.
|
|
notes:
|
|
- title: ''
|
|
content: |-
|
|
Provide either the `DestinationName` or the `DestinationDeviceID`. If you provide both values, MDM uses `DestinationDeviceID`.
|
|
|
|
Refer to the following sections to determine supported channels and requirements, and to see an example request and response.
|