API referenceovok_sdk.resources
ovok_sdk.resources.omnichannel_alerts
Omni-channel alerts: the rule that decides who hears of each Signals alert event, and its preview.
- Stable unknown
- Release candidate not available
- Development since 0.2.0-dev.33+c6e0f70
Omni-channel alerts: the rule that decides who hears of each Signals alert event, and its preview.
NotificationsRulesResource
NotificationsRulesResource(http: HttpClient)The project's alert notifications rule; access it as ovok.omnichannel_alerts.rules.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
http | HttpClient | The HTTP client scoped to the omni-channel alerts routes. |
retrieve()
retrieve() -> AnyRead the rule.
Returns
Any: The rule undernotifications, None when the project has none.
update()
update(rule: JsonObject) -> AnySet the rule; Ovok checks the channels and recipients it names.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
rule | JsonObject | The rule, with its JSON Logic under logic. |
Returns
Any: The rule as Ovok now runs it.
remove()
remove() -> NoneRemove the rule, so nobody is told of a new alert.
OmnichannelAlertsResource
OmnichannelAlertsResource(http: HttpClient)Ovok runs the project's rule on each Signals alert event and tells the people it names.
For project admins. Created by Ovok; access it as ovok.omnichannel_alerts.
preview()
preview(preview: JsonObject) -> AnyPreview who the rule tells of a sample alert event; nothing is sent.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
preview | JsonObject | The patientId, an optional event (alert.triggered when omitted), an optional sample alert and an optional notifications rule to try. |
Returns
Any: Thenotifyentries the rule answers, each with the people it reaches.
Last updated on