build: Whitespace & keep vim happy
[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                         Possible Errors: [service].Error.InProgress
12                                          [service].Error.NotImplemented
13
14                 void DisableAll(string type)
15
16                         Disables all call forwarding rules for type.
17                         Type can be one of:
18                                 "all" or "" - Disables all rules
19                                 "conditional" - Disables all conditional rules,
20                                         e.g. busy, no reply and not reachable.
21
22                         Possible Errors: [service].Error.InProgress
23                                          [service].Error.NotImplemented
24                                          [service].Error.InvalidArguments
25                                          [service].Error.InvalidFormat
26                                          [service].Error.Failed
27
28                 void SetProperty(string property, variant value)
29
30                         Sets the given property value to that specified in
31                         call parameter.
32
33                         Possible Errors: [service].Error.NotAvailable
34                                          [service].Error.InProgress
35                                          [service].Error.NotImplemented
36                                          [service].Error.InvalidArguments
37                                          [service].Error.InvalidFormat
38                                          [service].Error.Failed
39
40 Signals         PropertyChanged(string property, variant value)
41
42                         Signal is emitted whenever a property has changed.
43                         The new value is passed as the signal argument.
44
45 Properties      string VoiceUnconditional [readwrite]
46
47                         Contains the value of the voice unconditional call
48                         forwarding property.  If the value is an empty string,
49                         then this call forwarding rule is not active.
50                         Otherwise the rule is active with the string value
51                         as the phone number.
52
53                 string VoiceBusy [readwrite]
54
55                         Contains the value of the voice "Busy" call forwarding
56                         rule.
57
58                 string VoiceNoReply [readwrite]
59
60                         Contains the value of the voice "No Reply" call
61                         forwarding rule.
62
63                 uint16 VoiceNoReplyTimeout [readwrite]
64
65                         Contains the value of the voice "No Reply" timeout in
66                         seconds. The timeout can be between 1 and 30 seconds.
67                         Please note that it is not possible to set this
68                         property's value if GetProperties() has not been
69                         previously called or the VoiceNoReply property
70                         has not been set.
71
72                 string VoiceNotReachable [readwrite]
73
74                         Contains the value of the voice "Not Reachable" call
75                         forwarding rule.
76
77                 boolean ForwardingFlagOnSim [readonly]
78
79                         Boolean representing the voice unconditional call
80                         forwarding rule status.