build: Whitespace & keep vim happy
[platform/upstream/ofono.git] / doc / pushnotification-api.txt
1 Push Notification hierarchy
2 ===============
3
4 Service         org.ofono
5 Interface       org.ofono.PushNotification
6 Object path     [variable prefix]/{modem0,modem1,...}
7
8 Methods         void RegisterAgent(object path)
9
10                         Registers an agent which will be called whenever a
11                         new Smart Messaging based SMS arrives.
12
13                         Possible Errors: [service].Error.InProgress
14                                          [service].Error.InvalidArguments
15                                          [service].Error.InvalidFormat
16                                          [service].Error.Failed
17
18                 void UnregisterAgent(object path)
19
20                         Unregisters an agent.
21
22                         Possible Errors: [service].Error.InvalidArguments
23                                          [service].Error.Failed
24
25 PushNotificationAgent Hierarchy [experimental]
26 ===============
27
28 Service         unique name
29 Interface       org.ofono.PushNotificationAgent
30 Object path     freely definable
31
32 Methods         void ReceiveNotification(array{byte} notification, dict info)
33
34                         Requests the agent to process a new SMS that has
35                         arrived containing a WAP PUSH.  The dictionary
36                         info contains 'Sender', 'LocalSentTime' and
37                         'SentTime' properties.
38
39                         Possible Errors: None
40
41                 void Release() [noreply]
42
43                         Agent is being released, possibly because of oFono
44                         terminating, SMS interface is being torn down or modem
45                         off.  No UnregisterAgent call is needed.