status-im
/
snorenotify
mirror of https://github.com/status-im/snorenotify.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

update doc

This commit is contained in:
Patrick von Reth 2015-06-29 21:17:54 +02:00
parent 4f96a52aa8
commit fc2a42e51a
2 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/libsnore/application.h
View File

@ -100,14 +100,17 @@ public:
bool isValid() const;
/**
* Returns application specific hints:
* Key | Value | Required
* ------------- | ----------- | -----------
* use-markup | Enable markup support for title and message, strings must be html escaped.| Many Backends.
* desktop-entry | The name of the desktop enty associated with the application. | Used for The freedesktop backend.
* windows-app-id | The app id associated with the application. | Needed for the Windows 8 backend [See MSDN Documentation](http://msdn.microsoft.com/en-us/library/windows/apps/dd378459.aspx).
* tray-icon | A QPointer<QSystemTray> item. | Needed for the System Tray Backend.
* pushover-token | The token associated with your application. | Needed to associate pushover notification with your application, to register your application visit [Pushover](https://pushover.net/apps/build).
* Returns application specific hints.
* Hints are inherited by Notification's.
* Key | Type | Value | Required
* ------------- | ----------- | ----------- | -----------
* use-markup | QString |Enable markup support for title and message, strings must be html escaped. | Many Backends.
* desktop-entry | QString | The name of the desktop enty associated with the application. | Used for The freedesktop backend.
* windows-app-id | QString | The app id associated with the application. | Needed for the Windows 8 backend [See MSDN Documentation](http://msdn.microsoft.com/en-us/library/windows/apps/dd378459.aspx).
* tray-icon | QPointer<QSystemTray> | A QSystemTray item. | Needed for the System Tray Backend.
* pushover-token | QString | The token associated with your application. | Needed to associate pushover notification with your application, to register your application visit [Pushover](https://pushover.net/apps/build).
* silent | bool | Don't play notification sounds. | Multiple backends.
* sound | QString | Local uri to a sound file. | Secondary Backend Sound.
*/
Hint &hints();

8
src/libsnore/notification/notification.h
View File

@ -232,11 +232,9 @@ public:
const Notification::CloseReasons &closeReason();
/**
* Returns notification specific hints:
* Key | Type | Value | Used In
* ------------- | ----------- | ----------- | -----------
* silent | bool | Don't play notification sounds. | Multiple backends.
* sound | QString | Local uri to a sound file. | Secondary Backend Sound.
* Returns notification specific hints.
* A notification inherits the hints of its application.
* @see Application::hints()
*/
Hint &hints();