mirror of
https://github.com/caronc/apprise.git
synced 2024-12-13 10:21:51 +01:00
Updated Development_API (markdown)
parent
fbe208c29e
commit
1ac9cedd1b
@ -10,10 +10,11 @@
|
|||||||
* [`details()`](#details-dynamic-view-into-available-notification-services-apprise-offers)
|
* [`details()`](#details-dynamic-view-into-available-notification-services-apprise-offers)
|
||||||
* [`async_notify()`](#async_notify--leveraging-await-to-send-notifications)
|
* [`async_notify()`](#async_notify--leveraging-await-to-send-notifications)
|
||||||
* [The Apprise Asset Object](#the-apprise-asset-object)
|
* [The Apprise Asset Object](#the-apprise-asset-object)
|
||||||
|
* [The Apprise Notification Object](#the-apprise-notification-object)
|
||||||
* **Features**:
|
* **Features**:
|
||||||
* [Pickle Support](#pickleserialization-support)
|
* [Pickle Support](#pickleserialization-support)
|
||||||
* **Advanced**:
|
|
||||||
* [The Apprise Notification Object](#the-apprise-notification-object)
|
|
||||||
<!--te-->
|
<!--te-->
|
||||||
|
|
||||||
# Development API
|
# Development API
|
||||||
@ -359,6 +360,38 @@ apobj = apprise.Apprise(asset=asset)
|
|||||||
# default configuration has been over-ridden.
|
# default configuration has been over-ridden.
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## The Apprise Notification Object
|
||||||
|
The **[[The Apprise Object|Development_API#the-apprise-object]]** actually already does a really good managing these for you. But if you want to manage the notifications yourself here is how you can do it:
|
||||||
|
|
||||||
|
```python
|
||||||
|
# Import this library
|
||||||
|
import apprise
|
||||||
|
|
||||||
|
# Instantiate an object. This is what the apprise object
|
||||||
|
# would have otherwise done under the hood:
|
||||||
|
obj = apprise.Apprise.instantiate('glib://')
|
||||||
|
|
||||||
|
# Now you can use the notify() function to pass notifications.
|
||||||
|
# notify() is similar to Apprise.notify() except the overhead of
|
||||||
|
# of tagging is not present. There also no handling of the
|
||||||
|
# the text input type (HTML, MARKUP, etc). This is on you
|
||||||
|
# to manipulate before passing in the content.
|
||||||
|
obj.notify(
|
||||||
|
body=u"A test message",
|
||||||
|
title=u"a title",
|
||||||
|
)
|
||||||
|
|
||||||
|
# send() is a very low level call which directly posts the
|
||||||
|
# body and title you specify to the remote notification server
|
||||||
|
# There is NO data manipulation here, no overflow handling
|
||||||
|
# nothing. But this allows you to free form your own
|
||||||
|
# messages and pass them along using the apprise handling
|
||||||
|
obj.send(
|
||||||
|
body=u"A test message",
|
||||||
|
title=u"a title",
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
# Features
|
# Features
|
||||||
## Pickle/Serialization Support
|
## Pickle/Serialization Support
|
||||||
You can Serialize your loaded notifications so they can be restored later on:
|
You can Serialize your loaded notifications so they can be restored later on:
|
||||||
@ -392,36 +425,3 @@ apobj = pickle.loads(serialized)
|
|||||||
with open("myfile.txt", "r+") as file:
|
with open("myfile.txt", "r+") as file:
|
||||||
apobj = pickle.loads(file.read())
|
apobj = pickle.loads(file.read())
|
||||||
```
|
```
|
||||||
|
|
||||||
# Advanced
|
|
||||||
## The Apprise Notification Object
|
|
||||||
The **[[The Apprise Object|Development_API#the-apprise-object]]** actually already does a really good managing these for you. But if you want to manage the notifications yourself here is how you can do it:
|
|
||||||
|
|
||||||
```python
|
|
||||||
# Import this library
|
|
||||||
import apprise
|
|
||||||
|
|
||||||
# Instantiate an object. This is what the apprise object
|
|
||||||
# would have otherwise done under the hood:
|
|
||||||
obj = apprise.Apprise.instantiate('glib://')
|
|
||||||
|
|
||||||
# Now you can use the notify() function to pass notifications.
|
|
||||||
# notify() is similar to Apprise.notify() except the overhead of
|
|
||||||
# of tagging is not present. There also no handling of the
|
|
||||||
# the text input type (HTML, MARKUP, etc). This is on you
|
|
||||||
# to manipulate before passing in the content.
|
|
||||||
obj.notify(
|
|
||||||
body=u"A test message",
|
|
||||||
title=u"a title",
|
|
||||||
)
|
|
||||||
|
|
||||||
# send() is a very low level call which directly posts the
|
|
||||||
# body and title you specify to the remote notification server
|
|
||||||
# There is NO data manipulation here, no overflow handling
|
|
||||||
# nothing. But this allows you to free form your own
|
|
||||||
# messages and pass them along using the apprise handling
|
|
||||||
obj.send(
|
|
||||||
body=u"A test message",
|
|
||||||
title=u"a title",
|
|
||||||
)
|
|
||||||
```
|
|
Loading…
Reference in New Issue
Block a user