platypush.message.event.assistant

class platypush.message.event.assistant.AlarmEndEvent(*args, **kwargs)[source]

Event triggered when an alarm ends on the assistant

__init__(*args, **kwargs)[source]

Params: target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict]

class platypush.message.event.assistant.AlarmStartedEvent(*args, **kwargs)[source]

Event triggered when an alarm starts on the assistant

__init__(*args, **kwargs)[source]

Params: target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict]

class platypush.message.event.assistant.AlertEndEvent(*args, **kwargs)[source]

Event triggered when an alert ends on the assistant

__init__(*args, **kwargs)[source]

Params: target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict]

class platypush.message.event.assistant.AlertStartedEvent(*args, **kwargs)[source]

Event triggered when an alert starts on the assistant

__init__(*args, **kwargs)[source]

Params: target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict]

class platypush.message.event.assistant.AssistantEvent(assistant=None, *args, **kwargs)[source]

Base class for assistant events

__init__(assistant=None, *args, **kwargs)[source]

Params: target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict]

class platypush.message.event.assistant.ConversationEndEvent(with_follow_on_turn=False, *args, **kwargs)[source]

Event triggered when a conversation ends

__init__(with_follow_on_turn=False, *args, **kwargs)[source]
Parameters:with_follow_on_turn (str) – Set to true if the conversation expects a user follow-up, false otherwise
class platypush.message.event.assistant.ConversationStartEvent(*args, **kwargs)[source]

Event triggered when a new conversation starts

__init__(*args, **kwargs)[source]

Params: target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict]

class platypush.message.event.assistant.ConversationTimeoutEvent(*args, **kwargs)[source]

Event triggered when a conversation times out

__init__(*args, **kwargs)[source]
Parameters:with_follow_on_turn (str) – Set to true if the conversation expects a user follow-up, false otherwise
class platypush.message.event.assistant.HotwordDetectedEvent(hotword=None, *args, **kwargs)[source]

Event triggered when a custom hotword is detected

__init__(hotword=None, *args, **kwargs)[source]
Parameters:hotword (str) – The detected user hotword
class platypush.message.event.assistant.MicMutedEvent(assistant=None, *args, **kwargs)[source]

Event triggered when the microphone is muted.

class platypush.message.event.assistant.MicUnmutedEvent(assistant=None, *args, **kwargs)[source]

Event triggered when the microphone is muted.

class platypush.message.event.assistant.NoResponseEvent(*args, **kwargs)[source]

Event triggered when a conversation ends with no response

__init__(*args, **kwargs)[source]
Parameters:with_follow_on_turn (str) – Set to true if the conversation expects a user follow-up, false otherwise
class platypush.message.event.assistant.ResponseEvent(response_text, *args, **kwargs)[source]

Event triggered when a response is processed by the assistant

__init__(response_text, *args, **kwargs)[source]
Parameters:response_text (str) – Response text processed by the assistant
class platypush.message.event.assistant.SpeechRecognizedEvent(phrase, *args, **kwargs)[source]

Event triggered when a speech is recognized

__init__(phrase, *args, **kwargs)[source]
Parameters:phrase (str) – Recognized user phrase
matches_condition(condition)[source]

Overrides matches condition, and stops the conversation to prevent the default assistant response if the event matched some event hook condition

class platypush.message.event.assistant.TimerEndEvent(*args, **kwargs)[source]

Event triggered when a timer ends on the assistant

__init__(*args, **kwargs)[source]

Params: target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict]

class platypush.message.event.assistant.TimerStartedEvent(*args, **kwargs)[source]

Event triggered when a timer starts on the assistant

__init__(*args, **kwargs)[source]

Params: target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict]

class platypush.message.event.assistant.VolumeChangedEvent(volume, *args, **kwargs)[source]

Event triggered when the volume of the assistant changes

__init__(volume, *args, **kwargs)[source]

Params: target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict]