mirror of https://github.com/caronc/apprise
Updated Development_Apprise_Details (markdown)
parent
94d1c51a51
commit
7a43566db9
|
@ -65,9 +65,14 @@ Below is an example of what the output would look like:
|
||||||
"secure_protocols": [
|
"secure_protocols": [
|
||||||
"boxcar"
|
"boxcar"
|
||||||
],
|
],
|
||||||
|
# Only available if show_disabled=True (otherwise ONLY
|
||||||
|
# enabled plugins are returned in this response)
|
||||||
|
"enabled": true,
|
||||||
# Details are discussed a bit lower since there is a lot of information
|
# Details are discussed a bit lower since there is a lot of information
|
||||||
# here.
|
# here.
|
||||||
"details": {...}
|
"details": {...},
|
||||||
|
# Requirements are only shown if show_requirements=True
|
||||||
|
"requirements": {...}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"service_name": "Discord",
|
"service_name": "Discord",
|
||||||
|
@ -78,9 +83,14 @@ Below is an example of what the output would look like:
|
||||||
"secure_protocols": [
|
"secure_protocols": [
|
||||||
"discord"
|
"discord"
|
||||||
],
|
],
|
||||||
|
# Only available if show_disabled=True (otherwise ONLY
|
||||||
|
# enabled plugins are returned in this response)
|
||||||
|
"enabled": true,
|
||||||
# Details are discussed a bit lower since there is a lot of information
|
# Details are discussed a bit lower since there is a lot of information
|
||||||
# here.
|
# here.
|
||||||
"details": {...}
|
"details": {...},
|
||||||
|
# Requirements are only shown if show_requirements=True
|
||||||
|
"requirements": {...}
|
||||||
},
|
},
|
||||||
```
|
```
|
||||||
* `service_name` gives you a general description of the notification service itself.
|
* `service_name` gives you a general description of the notification service itself.
|
||||||
|
@ -88,10 +98,25 @@ Below is an example of what the output would look like:
|
||||||
* `setup_url` provides the URL you can reference to see examples on how to construct your Apprise URL.
|
* `setup_url` provides the URL you can reference to see examples on how to construct your Apprise URL.
|
||||||
* `protocols` identifies the accepted schema for non-encrypted references to the service. It is not uncommon to have this field set to `null` simply stating that there simply isn't a non-encrypted form of using this service.
|
* `protocols` identifies the accepted schema for non-encrypted references to the service. It is not uncommon to have this field set to `null` simply stating that there simply isn't a non-encrypted form of using this service.
|
||||||
* `secure_protocols` identifies the accepted schema for encrypted references to the service.
|
* `secure_protocols` identifies the accepted schema for encrypted references to the service.
|
||||||
|
* `enabled` is set to either True or False if the service/plugin is available (based on administrative/platform/environment dependencies). This field is ONLY present if you specified `show_disabled=True` on your call to **details()**
|
||||||
|
* `requirements` provides details on what is required for a plugin to be functional (With respect to the platform/environment. This field is ONLY present if you specified `show_requirements=True` on your call to **details()**
|
||||||
* `details` goes into a much more granular view of the protocol. This is covered in the next section.
|
* `details` goes into a much more granular view of the protocol. This is covered in the next section.
|
||||||
|
|
||||||
All services will have _AT LEAST_ one protocol/schema you can use to access it by.
|
All services will have _AT LEAST_ one protocol/schema you can use to access it by.
|
||||||
|
|
||||||
|
The details function can also take a few keyword arguments that generate a little more overhead, but can additionally provide you information on services Apprise supports that you do not have access to (due to your Platform/Environment).
|
||||||
|
```python
|
||||||
|
import apprise
|
||||||
|
from json import dumps
|
||||||
|
|
||||||
|
# Our Apprise Object
|
||||||
|
a = apprise.Apprise()
|
||||||
|
|
||||||
|
# Get our details and include all other services available to us as well:
|
||||||
|
details = apprise.details(show_disabled=True)
|
||||||
|
```
|
||||||
|
The payload from the above call will look almost identical as it did except that it will additionally include a variable called **enabled** which is set to either `True` or `False`. One difference is that the call without this flag set ONLY returns enabled plugins.
|
||||||
|
|
||||||
### Details
|
### Details
|
||||||
This identifies a much more granular view of the schema object itself. There is enough details in here on every single supported notification service that an end user could ask for simple to read arguments like `token`, `password`, `target_users` and dynamically construct the URL on their own. You can also just feed these tokens into the [[Apprise Notification Object|Development_API#the-apprise-notification-object]] directly for those using this product at a very low level.
|
This identifies a much more granular view of the schema object itself. There is enough details in here on every single supported notification service that an end user could ask for simple to read arguments like `token`, `password`, `target_users` and dynamically construct the URL on their own. You can also just feed these tokens into the [[Apprise Notification Object|Development_API#the-apprise-notification-object]] directly for those using this product at a very low level.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue