SeanOMik
/
znc-push
mirror of https://github.com/SeanOMik/znc-push.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

reorganized configuration section of docs and default options of module. 

docs and default options should now be properly aligned.
This commit is contained in:
Ming Tang 2013-03-01 12:30:28 -08:00
parent 98d422c854
commit 9182bfdb96
2 changed files with 36 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
README.md
View File

@ -220,6 +220,39 @@ to something similar to "http://domain/#channel/2011-03-09 14:25:09", or
notifications to; if blank or unset, notifications will be sent to all devices.
### Notifications
* `message_sound = ""`
If you're using the Pushover.net API, you can specify a <a href="https://pushover.net/api#sounds">specific sound</a> for the notifications.
* `message_uri = ""`
URI that will be sent with the push notification. This could be a web address or a
local scheme to access a mobile application. Keyword expansion is performed on this
value.
* `message_length = 100`
Maximum length of the notification message to be sent. The message will be nicely
truncated and ellipsized at or before this length is reached. A value of 0 (zero) will
disable this option.
When using the custom URL service, this options allows you to specify the URL to send
a GET request to, and has keyword expansion performed on portions of it, including the
path and any query parameter values.
* `message_title = "{title}"`
Title that will be provided for the push notification. Keyword expansion is performed
on this value.
* `message_content = "{message}"`
Message content that will be sent for the push notification. Keyword expansion is
performed on this value.
### Conditions
* `away_only = "no"`
@ -302,38 +335,6 @@ to something similar to "http://domain/#channel/2011-03-09 14:25:09", or
query window more recently than the last time a notification was sent for that context.
### Notifications
* `message_sound = {sound}`
If you're using the Pushover.net API, you can specify a <a href="https://pushover.net/api#sounds">specific sound</a> for the notifications.
* `message_uri = ""`
URI that will be sent with the push notification. This could be a web address or a
local scheme to access a mobile application. Keyword expansion is performed on this
value.
* `message_length = 100`
Maximum length of the notification message to be sent. The message will be nicely
truncated and ellipsized at or before this length is reached. A value of 0 (zero) will
disable this option.
When using the custom URL service, this options allows you to specify the URL to send
a GET request to, and has keyword expansion performed on portions of it, including the
path and any query parameter values.
* `message_title = "{title}"`
Title that will be provided for the push notification. Keyword expansion is performed
on this value.
* `message_content = "{message}"`
Message content that will be sent for the push notification. Keyword expansion is
performed on this value.
### Advanced
* `channel_conditions = "all"`

7
push.cpp
View File

@ -117,10 +117,6 @@ class CPushMod : public CModule
defaults["message_title"] = "{title}";
defaults["message_content"] = "{message}";
// Condition strings
defaults["channel_conditions"] = "all";
defaults["query_conditions"] = "all";
// Notification conditions
defaults["away_only"] = "no";
defaults["client_count_less_than"] = "0";
@ -131,6 +127,9 @@ class CPushMod : public CModule
defaults["nick_blacklist"] = "";
defaults["replied"] = "yes";
// Advanced
defaults["channel_conditions"] = "all";
defaults["query_conditions"] = "all";
defaults["debug"] = "off";
}
virtual ~CPushMod() {}