github
/
apprise
mirror of https://github.com/caronc/apprise
1
0
Fork 0
Code Issues Releases Wiki Activity

Updated decorator_notify (markdown)

master
Chris Caron 2022-07-15 14:50:34 -04:00
parent 69b579b1d9
commit aaa9ab2cd7
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
decorator_notify.md

@ -40,7 +40,7 @@ When you define your wrapper function that `@notify` will control, you will need
| body | Yes | The message body the calling user passed along
| title | No | The message title which is an optional switch for Apprise so it wont' always be populated.
| notify_type | No | The message type will be `info`, `success`, `warning` or `failure`
| meta | No | The **combined** URL configuration passed into your my_wrapper. By the time your wrapper function is called, it will have been defined twice. First it's declaration (by the `@notify(on=schema)`, second by how the user called your `schema://`. The `@notify` declaration makes up the base of the URL while whatever the user provides to trigger your wrapper is applied on top.<br/>[See here](#the-meta-variable) for more details on the `meta` variable.
| meta | No | The **combined** URL configuration passed into your my_wrapper. By the time your wrapper function is called, it will have been defined twice. First it's declaration (by the `@notify(on=schema)`, second by how the user called your `schema://`. The `@notify` declaration makes up the base of the URL while whatever the user provides to trigger your wrapper is applied on top. [See here](#the-meta-variable) for more details on the `meta` variable.
| attach | No | If the call to trigger your wrapper includes one or more attachment, you can find it here as `list()` of `AppriseAttachment()` objects. If there is no attachment specified, then this will be set to None.
| body_format | No | The message body format as identified by the calling user. For the CLI this defaults to `text`, but for developers, they can optionally set this or not. Possible values would be `None`, `"text"`, `"html"` or `"markdown"`.