media/webrtc/signaling/src/sipcc/include/ccapi_device_info.h@ac0c01689b40
media/webrtc/signaling/src/sipcc/include/ccapi_device_info.h
Thu, 15 Jan 2015 15:59:08 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Thu, 15 Jan 2015 15:59:08 +0100
- branch
- TOR_BUG_9701
- changeset 10
- ac0c01689b40
- permissions
- -rw-r--r--
Implement a real Private Browsing Mode condition by changing the API/ABI;
This solves Tor bug #9701, complying with disk avoidance documented in
https://www.torproject.org/projects/torbrowser/design/#disk-avoidance.
1 /* This Source Code Form is subject to the terms of the Mozilla Public
2 * License, v. 2.0. If a copy of the MPL was not distributed with this
3 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
5 #ifndef _CCAPI_DEVICE_INFO_H_
6 #define _CCAPI_DEVICE_INFO_H_
8 #include "ccapi_types.h"
10 /**
11 * gets the device name
12 * @returns - a pointer to the device name
13 */
14 cc_deviceinfo_ref_t CCAPI_DeviceInfo_getDeviceHandle() ;
16 /**
17 * gets the device name
18 * @param [in] handle - reference to device info
19 * @returns - a pointer to the device name
20 * NOTE: The memory for return string doesn't need to be freed it will be freed when the info reference is freed
21 */
22 cc_string_t CCAPI_DeviceInfo_getDeviceName(cc_deviceinfo_ref_t handle) ;
24 /**
25 * gets the device idle status
26 * @param [in] handle - reference to device info
27 * @returns boolean - idle status
28 */
29 cc_boolean CCAPI_DeviceInfo_isPhoneIdle(cc_deviceinfo_ref_t handle) ;
31 /**
32 * gets the service state
33 * @param [in] handle - reference to device info
34 * @returns cc_service_state_t - INS/OOS
35 */
36 cc_service_state_t CCAPI_DeviceInfo_getServiceState(cc_deviceinfo_ref_t handle) ;
38 /**
39 * gets the service cause
40 * @param [in] handle - reference to device info
41 * @returns cc_service_cause_t - reason for service state
42 */
43 cc_service_cause_t CCAPI_DeviceInfo_getServiceCause(cc_deviceinfo_ref_t handle) ;
45 /**
46 * gets the cucm mode
47 * @param [in] handle - reference to device info
48 * @returns cc_cucm_mode_t - CUCM mode
49 */
50 cc_cucm_mode_t CCAPI_DeviceInfo_getCUCMMode(cc_deviceinfo_ref_t handle) ;
52 /**
53 * gets list of handles to calls on the device
54 * @param [in] handle - reference to device info
55 * @param [out] handles - array of call handle to be returned
56 * @param [in,out] count number allocated in array/elements returned
57 * @returns
58 */
59 void CCAPI_DeviceInfo_getCalls(cc_deviceinfo_ref_t handle, cc_call_handle_t handles[], cc_uint16_t *count) ;
61 /**
62 * gets list of handles to calls on the device by state
63 * @param [in] handle - reference to device info
64 * @param [in] state - call state for which the calls are requested
65 * @param [out] handles - array of call handle to be returned
66 * @param [in,out] count number allocated in array/elements returned
67 * @returns
68 */
69 void CCAPI_DeviceInfo_getCallsByState(cc_deviceinfo_ref_t handle, cc_call_state_t state,
70 cc_call_handle_t handles[], cc_uint16_t *count) ;
72 /**
73 * gets list of handles to lines on the device
74 * @param [in] handle - reference to device info
75 * @param [in] handles - array of line handle to be returned
76 * @param [in,out] count - pointer to count in array in-> memory allocated out-> num populated
77 * @returns
78 */
79 void CCAPI_DeviceInfo_getLines(cc_deviceinfo_ref_t handle, cc_lineid_t handles[], cc_uint16_t *count) ;
81 /**
82 * gets list of handles to features on the device
83 * @param [in] handle - reference to device info
84 * @param [in] handles - array of feature handle to be returned
85 * @param [in,out] count - pointer to count in array in-> memory allocated out-> num populated
86 * @returns
87 */
88 void CCAPI_DeviceInfo_getFeatures(cc_deviceinfo_ref_t handle, cc_featureinfo_ref_t handles[], cc_uint16_t *count) ;
90 /**
91 * gets handles of call agent servers
92 * @param [in] handle - reference to device info
93 * @param [in] handles - array of handles to call agent servers
94 * @param [in,out] count - pointer to count in array in-> memory allocated out-> num populated
95 * @returns
96 */
97 void CCAPI_DeviceInfo_getCallServers(cc_deviceinfo_ref_t handle, cc_callserver_ref_t handles[], cc_uint16_t *count) ;
99 /**
100 * gets call server name
101 * @param [in] handle - handle of call server
102 * @returns name of the call server
103 * NOTE: The memory for return string doesn't need to be freed it will be freed when the info reference is freed
104 */
105 cc_string_t CCAPI_DeviceInfo_getCallServerName(cc_callserver_ref_t handle);
107 /**
108 * gets call server mode
109 * @param [in] handle - handle of call server
110 * @returns - mode of the call server
111 */
112 cc_cucm_mode_t CCAPI_DeviceInfo_getCallServerMode(cc_callserver_ref_t handle);
114 /**
115 * gets calls erver name
116 * @param [in] handle - handle of call server
117 * @returns status of the call server
118 */
119 cc_ccm_status_t CCAPI_DeviceInfo_getCallServerStatus(cc_callserver_ref_t handle);
121 /**
122 * get the NOTIFICATION PROMPT
123 * @param [in] handle - reference to device info
124 * @returns
125 */
126 cc_string_t CCAPI_DeviceInfo_getNotifyPrompt(cc_deviceinfo_ref_t handle) ;
128 /**
129 * get the NOTIFICATION PROMPT PRIORITY
130 * @param [in] handle - reference to device info
131 * @returns
132 */
133 cc_uint32_t CCAPI_DeviceInfo_getNotifyPromptPriority(cc_deviceinfo_ref_t handle) ;
135 /**
136 * get the NOTIFICATION PROMPT Progress
137 * @param [in] handle - reference to device info
138 * @returns
139 */
140 cc_uint32_t CCAPI_DeviceInfo_getNotifyPromptProgress(cc_deviceinfo_ref_t handle) ;
142 /**
143 * gets provisioing for missed call logging
144 * This value should be reread on CONFIG_UPDATE event
145 * @param [in] handle - reference to device info
146 * @returns boolean - false => disabled true => enabled
147 */
148 cc_boolean CCAPI_DeviceInfo_isMissedCallLoggingEnabled (cc_deviceinfo_ref_t handle);
150 /**
151 * gets provisioing for placed call logging
152 * This value should be reread on CONFIG_UPDATE event
153 * @param [in] handle - reference to device info
154 * @returns boolean - false => disabled true => enabled
155 */
156 cc_boolean CCAPI_DeviceInfo_isPlacedCallLoggingEnabled (cc_deviceinfo_ref_t handle);
158 /**
159 * gets provisioing for received call logging
160 * This value should be reread on CONFIG_UPDATE event
161 * @param [in] handle - reference to device info
162 * @returns boolean - false => disabled true => enabled
163 */
164 cc_boolean CCAPI_DeviceInfo_isReceivedCallLoggingEnabled (cc_deviceinfo_ref_t handle);
166 /**
167 * gets register/in service time
168 * This value should be read once the register completes successfully
169 * @param [in] handle - reference to device info
170 * @returns long - time registration completed successfully.
171 */
172 long long CCAPI_DeviceInfo_getRegTime (cc_deviceinfo_ref_t handle);
174 /**
175 * Returns dot notation IP address used for registering phone. If phone is not
176 * registered, then "0.0.0.0" is returned.
177 * @param [in] handle - reference to device info
178 * @return cc_string_t IP address used to register phone.
179 */
180 cc_string_t CCAPI_DeviceInfo_getSignalingIPAddress(cc_deviceinfo_ref_t handle);
182 /**
183 * Returns camera admin enable/disable status
184 * @param [in] handle - reference to device info
185 * @return cc_boolean - TRUE => enabled
186 */
187 cc_boolean CCAPI_DeviceInfo_isCameraEnabled(cc_deviceinfo_ref_t handle);
189 /**
190 * Returns admin enable/disable video capablity for device
191 * @param [in] handle - reference to device info
192 * @return cc_boolean - TRUE => enabled
193 */
194 cc_boolean CCAPI_DeviceInfo_isVideoCapEnabled(cc_deviceinfo_ref_t handle);
196 /**
197 * gets the device mwi_lamp state
198 * @param [in] handle - reference to device info
199 * @returns boolean - mwi_lamp state
200 */
201 cc_boolean CCAPI_DeviceInfo_getMWILampState(cc_deviceinfo_ref_t handle);
203 #endif /* _CCAPIAPI_DEVICE_INFO_H_ */
