build: Whitespace & keep vim happy
[platform/upstream/ofono.git] / doc / call-barring-api.txt
1 Call Barring hierarchy
2 ======================
3
4 Service         org.ofono
5 Interface       org.ofono.CallBarring
6 Object path     [variable prefix]/{modem0,modem1,...}
7
8 Methods         dict GetProperties()
9
10                         Contains the properties for this object.
11
12                         Possible Errors: [service].Error.InProgress
13                                          [service].Error.NotImplemented
14
15                 void ChangePassword(string old_password, string new_password)
16
17                         Register new network password for the barring
18                         services.
19
20                         Possible Errors: [service].Error.InProgress
21                                          [service].Error.InvalidFormat
22                                          [service].Error.Failed
23
24                 void DisableAll(string password)
25
26                         Disables all call barrings.
27
28                         Possible Errors: [service].Error.InProgress
29                                          [service].Error.NotImplemented
30                                          [service].Error.InvalidArguments
31                                          [service].Error.InvalidFormat
32                                          [service].Error.Failed
33
34                 void DisableAllIncoming(string password)
35
36                         Disables barrings for incoming calls.
37
38                         Possible Errors: [service].Error.InProgress
39                                          [service].Error.NotImplemented
40                                          [service].Error.InvalidArguments
41                                          [service].Error.InvalidFormat
42                                          [service].Error.Failed
43
44                 void DisableAllOutgoing(string password)
45
46                         Disables barrings for outgoing calls.
47
48                         Possible Errors: [service].Error.InProgress
49                                          [service].Error.NotImplemented
50                                          [service].Error.InvalidArguments
51                                          [service].Error.InvalidFormat
52                                          [service].Error.Failed
53
54                 void SetProperty(string property, variant value, string pin2)
55
56                         Sets the given property value to that specified in
57                         call parameter.  For all properties, the password
58                         (typically PIN2) must be provided.
59
60                         Possible Errors: [service].Error.InProgress
61                                          [service].Error.NotImplemented
62                                          [service].Error.InvalidArguments
63                                          [service].Error.InvalidFormat
64                                          [service].Error.Failed
65
66 Signals         PropertyChanged(string property, variant value)
67
68                         Signal is emitted whenever a property has changed.
69                         The new value is passed as the signal argument.
70
71 Properties      string VoiceIncoming [readwrite]
72
73                         Contains the value of the barrings for the incoming
74                         voice calls. The possible values are:
75                         - "always" bar all incoming voice calls
76                         - "whenroaming" bar incoming voice calls when roaming,
77                         - "disabled" if no barring is active
78
79                 string VoiceOutgoing [readwrite]
80
81                         Contains the value of the barrings for the outgoing
82                         voice calls. The possible values are:
83                         - "all" bar all outgoing calls
84                         - "international" bar all outgoing international calls
85                         - "internationalnothome" bar all outgoing
86                           international calls except to home country
87                         - "disabled" if no barring is active