| 223 | | The actions send a request message back to the notification client |
|---|
| 224 | | when invoked. This functionality may not be implemented by the |
|---|
| 225 | | notification server, conforming clients should check if it is available |
|---|
| 226 | | before using it (see the GetCapabilities message in |
|---|
| 227 | | <xref linkend="protocol"/>). An implementation is free to ignore any |
|---|
| 228 | | requested by the client. As an example one possible rendering of |
|---|
| 229 | | actions would be as buttons in the notification popup. |
|---|
| 230 | | </entry> |
|---|
| 231 | | <entry> |
|---|
| 232 | | Actions are sent over as a list of pairs. Each even element in the |
|---|
| 233 | | list (starting at index 0) represents the identifier for the action. |
|---|
| 234 | | Each odd element in the list is the localized string that will be |
|---|
| 235 | | displayed to the user. |
|---|
| 236 | | </entry> |
|---|
| 237 | | <entry> |
|---|
| 238 | | The default action (usually invoked my clicking the notification) |
|---|
| 239 | | should have a key named <literal>"default"</literal>. The name can |
|---|
| 240 | | be anything, though implementations are free not to display it. |
|---|
| 241 | | <entry> |
|---|
| | 223 | <para> |
|---|
| | 224 | The actions send a request message back to the notification client |
|---|
| | 225 | when invoked. This functionality may not be implemented by the |
|---|
| | 226 | notification server, conforming clients should check if it is available |
|---|
| | 227 | before using it (see the GetCapabilities message in |
|---|
| | 228 | <xref linkend="protocol"/>). An implementation is free to ignore any |
|---|
| | 229 | requested by the client. As an example one possible rendering of |
|---|
| | 230 | actions would be as buttons in the notification popup. |
|---|
| | 231 | </para> |
|---|
| | 232 | <para> |
|---|
| | 233 | Actions are sent over as a list of pairs. Each even element in the |
|---|
| | 234 | list (starting at index 0) represents the identifier for the action. |
|---|
| | 235 | Each odd element in the list is the localized string that will be |
|---|
| | 236 | displayed to the user. |
|---|
| | 237 | </para> |
|---|
| | 238 | <para> |
|---|
| | 239 | The default action (usually invoked my clicking the notification) |
|---|
| | 240 | should have a key named <literal>"default"</literal>. The name can |
|---|
| | 241 | be anything, though implementations are free not to display it. |
|---|
| | 242 | </para> |
|---|
| | 243 | </entry> |
|---|
| 245 | | <entry><para>See <xref linkend="hints"/>.</para></entry> |
|---|
| 246 | | |
|---|
| 247 | | <para> |
|---|
| 248 | | Beyond the core protocol is the hints table. A couple of core |
|---|
| 249 | | elements have been moved to hints mostly because in a huge number |
|---|
| 250 | | of cases their default values would be sufficent. The elements moved |
|---|
| 251 | | to hints are: |
|---|
| 252 | | </para> |
|---|
| 253 | | <segmentedlist> |
|---|
| 254 | | <seglistitem> |
|---|
| 255 | | <seg>Category ID</seg> |
|---|
| 256 | | <seg>An optional ID representing the type of notification (the name |
|---|
| 257 | | has been changed from Notification Type ID in pervious versions). |
|---|
| 258 | | See <xref linkend="categories"/>.</seg> |
|---|
| 259 | | </seglistitem> |
|---|
| 260 | | <seglistitem> |
|---|
| 261 | | <seg>Urgency Level</seg> |
|---|
| 262 | | <seg>The urgency of the notification. See |
|---|
| 263 | | <xref linkend="urgency-levels"/>. (Defaults to 1 - Normal)</seg> |
|---|
| 264 | | </seglistitem> |
|---|
| 265 | | <seglistitem> |
|---|
| 266 | | <seg>Icon Data</seg> |
|---|
| 267 | | <seg>Instead of overloading the icon field we now have an icon_data |
|---|
| 268 | | field that is used when icon is blank.</seg> |
|---|
| 269 | | </seglistitem> |
|---|
| 270 | | </segmentedlist> |
|---|
| | 247 | <entry> |
|---|
| | 248 | <para>See <xref linkend="hints"/>.</para> |
|---|
| | 249 | <para> |
|---|
| | 250 | Beyond the core protocol is the hints table. A couple of core |
|---|
| | 251 | elements have been moved to hints mostly because in a huge number |
|---|
| | 252 | of cases their default values would be sufficent. The elements moved |
|---|
| | 253 | to hints are: |
|---|
| | 254 | </para> |
|---|
| | 255 | <segmentedlist> |
|---|
| | 256 | <title>Elements Moved to Hints</title> |
|---|
| | 257 | <segtitle>Element</segtitle> |
|---|
| | 258 | <segtitle>Description</segtitle> |
|---|
| | 259 | <seglistitem> |
|---|
| | 260 | <seg>Category ID</seg> |
|---|
| | 261 | <seg>An optional ID representing the type of notification (the name |
|---|
| | 262 | has been changed from Notification Type ID in pervious versions). |
|---|
| | 263 | See <xref linkend="categories"/>.</seg> |
|---|
| | 264 | </seglistitem> |
|---|
| | 265 | <seglistitem> |
|---|
| | 266 | <seg>Urgency Level</seg> |
|---|
| | 267 | <seg>The urgency of the notification. See |
|---|
| | 268 | <xref linkend="urgency-levels"/>. (Defaults to 1 - Normal)</seg> |
|---|
| | 269 | </seglistitem> |
|---|
| | 270 | <seglistitem> |
|---|
| | 271 | <seg>Icon Data</seg> |
|---|
| | 272 | <seg>Instead of overloading the icon field we now have an icon_data |
|---|
| | 273 | field that is used when icon is blank.</seg> |
|---|
| | 274 | </seglistitem> |
|---|
| | 275 | </segmentedlist> |
|---|
| | 276 | </entry> |
|---|
