summaryrefslogtreecommitdiffstats
path: root/doc/smartmessaging-api.txt
blob: ebf192671eed646f0738faa3741090ffca947ced (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
Smart Messaging hierarchy
===============

Service		org.ofono
Interface	org.ofono.SmartMessaging
Object path	[variable prefix]/{modem0,modem1,...}

Methods		object SendAppointment(array{bytes} appointment)

			Sends a vCalendar object via SMS.  The object is given
			in the appointment argument.  It is not interpreted
			by oFono in any way.  If the object is too large to
			fit into a single SMS, it is fragmented as
			appropriate.  This method call returns the object
			path of the queued SMS.

		object SendBusinessCard(array{bytes} card)

			Sends a vCard object via SMS.  The object is given
			in the card argument.  It is not interpreted
			by oFono in any way.  If the object is too large to
			fit into a single SMS, it is fragmented as
			appropriate.  This method call returns the object
			path of the queued SMS.

		void RegisterAgent(object path)

			Registers an agent which will be called whenever a
			new Smart Messaging based SMS arrives.

		void UnregisterAgent(object path)

			Unregisters an agent.

SmartMessagingAgent Hierarchy [experimental]
===============

Service		unique name
Interface	org.ofono.SimToolkitAgent
Object path	freely definable

Methods		void ReceiveAppointment(array{byte} appointment, dict info)

			Requests the agent to process a new SMS that has
			arrived containing a vCalendar object.  The info
			dictionary contains 'Sender', 'LocalSentTime' and
			'SentTime' properties.

			Possible Errors: None

		void ReceiveBusinessCard(array{byte} card, dict info)

			Requests the agent to process a new SMS that has
			arrived containing a vCalendar object.  The info
			dictionary contains 'Sender', 'LocalSentTime' and
			'SentTime' properties.

			Possible Errors: None

		void Release()

			Agent is being released, possibly because of oFono
			terminating, SMS interface is being torn down or modem
			off.  No UnregisterAgent call is needed.