TODO: mark CDIP task as done
[platform/upstream/ofono.git] / doc / call-forwarding-api.txt
1 Call Forwarding hierarchy
2 ===============
3 Service         org.ofono
4 Interface       org.ofono.CallForwarding
5 Object path     [variable prefix]/{modem0,modem1,...}
6
7 Methods         dict GetProperties()
8
9                         Contains the properties for this object.
10
11                 void DisableAll(string type)
12
13                         Disables all call forwarding rules for type.
14                         Type can be one of:
15                                 "all" or "" - Disables all rules
16                                 "conditional" - Disables all conditional rules,
17                                         e.g. busy, no reply and not reachable.
18
19                 void SetProperty(string property, variant value)
20
21                         Sets the given property value to that specified in
22                         call parameter.
23
24 Signals         PropertyChanged(string property, variant value)
25
26                         Signal is emitted whenever a property has changed.
27                         The new value is passed as the signal argument.
28
29 Properties      string VoiceUnconditional [readwrite]
30
31                         Contains the value of the voice unconditional call
32                         forwarding property.  If the value is an empty string,
33                         then this call forwarding rule is not active.
34                         Otherwise the rule is active with the string value
35                         as the phone number.
36
37                 string VoiceBusy [readwrite]
38
39                         Contains the value of the voice "Busy" call forwarding
40                         rule.
41
42                 string VoiceNoReply [readwrite]
43
44                         Contains the value of the voice "No Reply" call
45                         forwarding rule.
46
47                 uint16 VoiceNoReplyTimeout [readwrite]
48
49                         Contains the value of the voice "No Reply" timeout in
50                         seconds. The timeout can be between 1 and 30 seconds.
51                         Please note that it is not possible to set this
52                         property's value if GetProperties() has not been
53                         previously called or the VoiceNoReply property
54                         has not been set.
55
56                 string VoiceNotReachable [readwrite]
57
58                         Contains the value of the voice "Not Reachable" call
59                         forwarding rule.
60
61                 boolean ForwardingFlagOnSim [readonly]
62
63                         Boolean representing the voice unconditional call
64                         forwarding rule status.