Knock.Notify (Knock v0.1.3) View Source

Functions for interacting with Knock notify resources.

Link to this section Summary

Functions

Cancels the given notify call fr the workflow with the given key and cancelation key.

Executes a notify call for the notification workflow with the given key. Note: properties must contain at least actor and recipents for the call to be valid.

Link to this section Functions

Link to this function

cancel(client, workflow_key, cancelation_key, properties \\ %{})

View Source

Specs

Cancels the given notify call fr the workflow with the given key and cancelation key.

Can optionally be provided with:

  • recipients: A list of user ids to cancel the notify for
Link to this function

notify(client, key, properties)

View Source

Specs

Executes a notify call for the notification workflow with the given key. Note: properties must contain at least actor and recipents for the call to be valid.