Skip to content

Settings ​

System toggles and device settings.

import Settings;

getHotspotPassword ​

Returns the password of your Personal Hotspot.

getHotspotPassword() -> Text

Shortcuts action: is.workflow.actions.personalhotspot.password.get

setAirdropReceiving ​

setAirdropReceiving(state: Text)
ParameterTypeDefault
stateText—

Shortcuts action: is.workflow.actions.setairdropreceiving

setAirplaneMode ​

Sets the device’s Airplane Mode to on or off.

setAirplaneMode(operation: BooleanSettingOperation, OnValue: Boolean)
ParameterTypeDefault
operationTurn On | Turn Off | Toggle—
OnValueBoolean—

Shortcuts action: is.workflow.actions.airplanemode.set

setAlwaysOnDisplay ​

Sets the Always On Display setting of your iPhone to on or off.

setAlwaysOnDisplay(operation: BooleanSettingOperation, OnValue: Boolean)
ParameterTypeDefault
operationTurn On | Turn Off | Toggle—
OnValueBoolean—

Shortcuts action: is.workflow.actions.display.always-on.set

setAnnounceNotifications ​

Sets Announce Notifications to on or off. When on, Siri will announce notifications from new apps that send Time Sensitive notifications or direct messages.

setAnnounceNotifications(operation: BooleanSettingOperation, OnValue: Boolean)
ParameterTypeDefault
operationTurn On | Turn Off | Toggle—
OnValueBoolean—

Shortcuts action: is.workflow.actions.announcenotifications.set

setAppearance ​

setAppearance(operation: BooleanSettingOperation, style: DeviceAppearanceType)
ParameterTypeDefault
operationTurn On | Turn Off | Toggle—
styleLight | Dark—

Shortcuts action: is.workflow.actions.appearance

setBluetooth ​

Sets the device’s Bluetooth to on or off.

setBluetooth(operation: BooleanSettingOperation, OnValue: Boolean)
ParameterTypeDefault
operationTurn On | Turn Off | Toggle—
OnValueBoolean—

Shortcuts action: is.workflow.actions.bluetooth.set

setBrightness ​

Sets the device brightness.

setBrightness(WFBrightness: Any)
ParameterTypeDefault
WFBrightnessAny—

Shortcuts action: is.workflow.actions.setbrightness

setCellularData ​

Sets the device’s Cellular Data to on or off.

setCellularData(operation: BooleanSettingOperation, OnValue: Boolean)
ParameterTypeDefault
operationTurn On | Turn Off | Toggle—
OnValueBoolean—

Shortcuts action: is.workflow.actions.cellulardata.set

setFlashlight ​

Turns on or off the flashlight near the device's camera.

setFlashlight(operation: BooleanSettingOperation, state: Boolean, WFFlashlightLevel: Any)
ParameterTypeDefault
operationTurn On | Turn Off | Toggle—
stateBoolean—
WFFlashlightLevelAny—

Shortcuts action: is.workflow.actions.flashlight

setHotspotPassword ​

Sets the Personal Hotspot password.

setHotspotPassword(password: Text)
ParameterTypeDefault
passwordText—

Shortcuts action: is.workflow.actions.personalhotspot.password.set

setLowPowerMode ​

setLowPowerMode(operation: BooleanSettingOperation, OnValue: Boolean)
ParameterTypeDefault
operationTurn On | Turn Off | Toggle—
OnValueBoolean—

Shortcuts action: is.workflow.actions.lowpowermode.set

setNightShift ​

Enables or disables Night Shift. When enabled, the colors of your display will be shifted to the warmer end of the color spectrum after dark. This may help you get a better night’s sleep.

setNightShift(operation: BooleanSettingOperation, OnValue: Boolean)
ParameterTypeDefault
operationTurn On | Turn Off | Toggle—
OnValueBoolean—

Shortcuts action: is.workflow.actions.nightshift.set

setNoiseControlMode ​

Sets a Noise Control mode on your selected device

setNoiseControlMode(device: Text, noiseControlMode: Text)
ParameterTypeDefault
deviceText—
noiseControlModeText—

Shortcuts action: is.workflow.actions.listeningmode.set

setOrientationLock ​

Turns on or off orientation lock on your device.

setOrientationLock(operation: BooleanSettingOperation, OnValue: Boolean)
ParameterTypeDefault
operationTurn On | Turn Off | Toggle—
OnValueBoolean—

Shortcuts action: is.workflow.actions.orientationlock.set

setPersonalHotspot ​

Sets the device's Personal Hotspot to on or off.

setPersonalHotspot(operation: BooleanSettingOperation, OnValue: Boolean)
ParameterTypeDefault
operationTurn On | Turn Off | Toggle—
OnValueBoolean—

When turning Personal Hotspot on, this action will make the hotspot discoverable for only a short period of time, in order to preserve battery life.

Shortcuts action: is.workflow.actions.personalhotspot.set

setSilenceUnknownCallers ​

Sets Silence Unknown Callers to on or off. When on, calls from unknown numbers will be silenced and sent to voicemail. Calls will still be displayed on the Recents list. Incoming calls will continue to ring from people in your contacts, recent outgoing calls, and Siri Suggestions.

setSilenceUnknownCallers(operation: BooleanSettingOperation, OnValue: Boolean)
ParameterTypeDefault
operationTurn On | Turn Off | Toggle—
OnValueBoolean—

Shortcuts action: is.workflow.actions.silenceunknowncallers.set

setStageManager ​

Enables or disables Stage Manager on the device.

setStageManager(operation: BooleanSettingOperation, state: Boolean, showDock: Boolean, showRecentApps: Boolean)
ParameterTypeDefault
operationTurn On | Turn Off | Toggle—
stateBoolean—
showDockBoolean—
showRecentAppsBoolean—

Shortcuts action: is.workflow.actions.stagemanager.set

setTrueTone ​

Enables or disables True Tone. When enabled, your device display will automatically adapt based on ambient lighting conditions to make colors appear consistent in different environments.

setTrueTone(operation: BooleanSettingOperation, OnValue: Boolean)
ParameterTypeDefault
operationTurn On | Turn Off | Toggle—
OnValueBoolean—

Shortcuts action: is.workflow.actions.truetone.set

setVolume ​

Sets the volume of the device.

setVolume(volumeSetting: Enum, volume: Number)
ParameterTypeDefault
volumeSettingMedia | Ringtone"Media"
volumeNumber0.5

Shortcuts action: is.workflow.actions.setvolume

setVpn ​

Connects, disconnects or changes the On Demand setting for a VPN Configuration on this device.

setVpn(operation: Enum, setOnDemandTo: Boolean, vpn: Text)
ParameterTypeDefault
operationConnect | Disconnect | Toggle | Set On Demand | Toggle On Demand"Connect"
setOnDemandToBooleantrue
vpnText—

VPN Configurations can be set up in the Settings app. On macOS, you must authenticate as an administrator to change the On Demand setting for a VPN Configuration.

Shortcuts action: is.workflow.actions.vpn.set

setWiFi ​

Sets the device’s Wi-Fi to on or off.

setWiFi(operation: BooleanSettingOperation, OnValue: Boolean)
ParameterTypeDefault
operationTurn On | Turn Off | Toggle—
OnValueBoolean—

Shortcuts action: is.workflow.actions.wifi.set