DoNotDisturb 1

The DoNotDisturb interface exposes directives and events to enable the Alexa client to control the Do Not Disturb capability.

{
    "namespace": "DoNotDisturb",
    "version": 1
}

Directives

Outbound messages from the Alexa client about the control of DoNotDisturb.

setDoNotDisturbState

The Alexa client sends this message to the Alexa client as the result of an AVS SetDoNotDisturb directive, or when the Alexa client sends the doNotDisturbStateRequest event.

Example message

{
    "header": {
        "version": 1
        "namespace": "DoNotDisturb",
        "name": "setDoNotDisturbState"
    },
    "payload": {
        "enabled": {{BOOLEAN}}
    }
}
 

Payload parameters

Parameter Description Type Required
enabled Indicates whether the DoNotDisturbed setting is enabled. Boolean Yes

Events

Inbound messages from the IPC client about control of the DoNotDisturb state.

doNotDisturbStateChanged

Send this event to instruct the Alexa client to change the state of the DoNotDisturb setting, resulting in the corresponding DoNotDisturbChanged AVS event.

Example message

{
    "header": {
        "version": 1
        "namespace": "DoNotDisturb",
        "name": "doNotDisturbStateChanged"
    },
    "payload": {
        "enabled": {{BOOLEAN}}
    }
}
 

Payload parameters

Parameter Description Type
enabled Indicates if DoNotDisturb should be enabled in the Alexa client. Set to TRUE if enabled. Boolean

doNotDisturbStateRequest

Send this event to request the Alexa client to return the current state of the DoNotDisturb setting. The Alexa client responds with a setDoNotDisturbState directive.

Example message

{
    "header": {
        "version": 1
        "namespace": "DoNotDisturb",
        "name": "doNotDisturbStateRequest"
    },
    "payload": {}
}

Payload parameters

The payload is an empty object.