mirror of
https://github.com/ElementsProject/lightning.git
synced 2025-02-21 14:24:09 +01:00
e94b793f05
- Added missing Example Notifications Heading - Renamed `example_json_notifications` to `example_notifications` - Moved `example_notifications` to the end of the page
95 lines
2.8 KiB
JSON
95 lines
2.8 KiB
JSON
{
|
|
"$schema": "../rpc-schema-draft.json",
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"rpc": "notifications",
|
|
"title": "Command to set up notifications.",
|
|
"description": [
|
|
"The **notifications** the RPC command enabled notifications for this JSON-RPC connection. By default (and for backwards-compatibility) notifications are disabled.",
|
|
"",
|
|
"Various commands, especially complex and slow ones, offer notifications which indicate their progress."
|
|
],
|
|
"request": {
|
|
"required": [
|
|
"enable"
|
|
],
|
|
"properties": {
|
|
"enable": {
|
|
"type": "boolean",
|
|
"description": [
|
|
"Whether to enable or disable notifications."
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"response": {
|
|
"properties": {},
|
|
"post_return_value_notes": [
|
|
"On success, if *enable* was *true*, notifications will be forwarded from then on."
|
|
]
|
|
},
|
|
"notifications": [
|
|
"Notifications are JSON-RPC objects without an *id* field. *lightningd* sends notifications (once enabled with this *notifications* command) with a *params* *id* field indicating which command the notification refers to.",
|
|
"",
|
|
"Implementations should ignore notifications without an *id* parameter, or unknown *method*.",
|
|
"",
|
|
"Common *method*s include:",
|
|
" *message*: param *message*: a descriptional string indicating something which occurred relating to the command. Param *level* indicates the level, as per lightning-getlog(7): *info* and *debug* are typical.",
|
|
" *progress*: param *num* and *total*, where *num* starts at 0 and is always less than *total*. Optional param *stage* with fields *num* and *total*, indicating what stage we are progressing through."
|
|
],
|
|
"errors": [
|
|
"On failure, one of the following error codes may be returned:",
|
|
"",
|
|
"- -32602: Error in given parameters."
|
|
],
|
|
"author": [
|
|
"Rusty Russell <<rusty@blockstream.com>> wrote the initial version of this man page."
|
|
],
|
|
"resources": [
|
|
"Main web site: <https://github.com/ElementsProject/lightning>"
|
|
],
|
|
"example_notifications": [
|
|
{
|
|
"method": "message",
|
|
"params": {
|
|
"id": 1,
|
|
"message": "This is a test message",
|
|
"level": "DEBUG"
|
|
}
|
|
},
|
|
{
|
|
"method": "progress",
|
|
"params": {
|
|
"id": 2,
|
|
"num": 0,
|
|
"total": 30,
|
|
"stage": {
|
|
"num": 0,
|
|
"total": 2
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"examples": [
|
|
{
|
|
"request": {
|
|
"id": "example:notifications#1",
|
|
"method": "notifications",
|
|
"params": {
|
|
"enable": true
|
|
}
|
|
},
|
|
"response": {}
|
|
},
|
|
{
|
|
"request": {
|
|
"id": "example:notifications#2",
|
|
"method": "notifications",
|
|
"params": {
|
|
"enable": false
|
|
}
|
|
},
|
|
"response": {}
|
|
}
|
|
]
|
|
}
|