1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/media/webrtc/signaling/src/sipcc/include/ccapi_device_info.h Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,203 @@
1.4 +/* This Source Code Form is subject to the terms of the Mozilla Public
1.5 + * License, v. 2.0. If a copy of the MPL was not distributed with this
1.6 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
1.7 +
1.8 +#ifndef _CCAPI_DEVICE_INFO_H_
1.9 +#define _CCAPI_DEVICE_INFO_H_
1.10 +
1.11 +#include "ccapi_types.h"
1.12 +
1.13 +/**
1.14 + * gets the device name
1.15 + * @returns - a pointer to the device name
1.16 + */
1.17 +cc_deviceinfo_ref_t CCAPI_DeviceInfo_getDeviceHandle() ;
1.18 +
1.19 +/**
1.20 + * gets the device name
1.21 + * @param [in] handle - reference to device info
1.22 + * @returns - a pointer to the device name
1.23 + * NOTE: The memory for return string doesn't need to be freed it will be freed when the info reference is freed
1.24 + */
1.25 +cc_string_t CCAPI_DeviceInfo_getDeviceName(cc_deviceinfo_ref_t handle) ;
1.26 +
1.27 +/**
1.28 + * gets the device idle status
1.29 + * @param [in] handle - reference to device info
1.30 + * @returns boolean - idle status
1.31 + */
1.32 +cc_boolean CCAPI_DeviceInfo_isPhoneIdle(cc_deviceinfo_ref_t handle) ;
1.33 +
1.34 +/**
1.35 + * gets the service state
1.36 + * @param [in] handle - reference to device info
1.37 + * @returns cc_service_state_t - INS/OOS
1.38 + */
1.39 +cc_service_state_t CCAPI_DeviceInfo_getServiceState(cc_deviceinfo_ref_t handle) ;
1.40 +
1.41 +/**
1.42 + * gets the service cause
1.43 + * @param [in] handle - reference to device info
1.44 + * @returns cc_service_cause_t - reason for service state
1.45 + */
1.46 +cc_service_cause_t CCAPI_DeviceInfo_getServiceCause(cc_deviceinfo_ref_t handle) ;
1.47 +
1.48 +/**
1.49 + * gets the cucm mode
1.50 + * @param [in] handle - reference to device info
1.51 + * @returns cc_cucm_mode_t - CUCM mode
1.52 + */
1.53 +cc_cucm_mode_t CCAPI_DeviceInfo_getCUCMMode(cc_deviceinfo_ref_t handle) ;
1.54 +
1.55 +/**
1.56 + * gets list of handles to calls on the device
1.57 + * @param [in] handle - reference to device info
1.58 + * @param [out] handles - array of call handle to be returned
1.59 + * @param [in,out] count number allocated in array/elements returned
1.60 + * @returns
1.61 + */
1.62 +void CCAPI_DeviceInfo_getCalls(cc_deviceinfo_ref_t handle, cc_call_handle_t handles[], cc_uint16_t *count) ;
1.63 +
1.64 +/**
1.65 + * gets list of handles to calls on the device by state
1.66 + * @param [in] handle - reference to device info
1.67 + * @param [in] state - call state for which the calls are requested
1.68 + * @param [out] handles - array of call handle to be returned
1.69 + * @param [in,out] count number allocated in array/elements returned
1.70 + * @returns
1.71 + */
1.72 +void CCAPI_DeviceInfo_getCallsByState(cc_deviceinfo_ref_t handle, cc_call_state_t state,
1.73 + cc_call_handle_t handles[], cc_uint16_t *count) ;
1.74 +
1.75 +/**
1.76 + * gets list of handles to lines on the device
1.77 + * @param [in] handle - reference to device info
1.78 + * @param [in] handles - array of line handle to be returned
1.79 + * @param [in,out] count - pointer to count in array in-> memory allocated out-> num populated
1.80 + * @returns
1.81 + */
1.82 +void CCAPI_DeviceInfo_getLines(cc_deviceinfo_ref_t handle, cc_lineid_t handles[], cc_uint16_t *count) ;
1.83 +
1.84 +/**
1.85 + * gets list of handles to features on the device
1.86 + * @param [in] handle - reference to device info
1.87 + * @param [in] handles - array of feature handle to be returned
1.88 + * @param [in,out] count - pointer to count in array in-> memory allocated out-> num populated
1.89 + * @returns
1.90 + */
1.91 +void CCAPI_DeviceInfo_getFeatures(cc_deviceinfo_ref_t handle, cc_featureinfo_ref_t handles[], cc_uint16_t *count) ;
1.92 +
1.93 +/**
1.94 + * gets handles of call agent servers
1.95 + * @param [in] handle - reference to device info
1.96 + * @param [in] handles - array of handles to call agent servers
1.97 + * @param [in,out] count - pointer to count in array in-> memory allocated out-> num populated
1.98 + * @returns
1.99 + */
1.100 +void CCAPI_DeviceInfo_getCallServers(cc_deviceinfo_ref_t handle, cc_callserver_ref_t handles[], cc_uint16_t *count) ;
1.101 +
1.102 +/**
1.103 + * gets call server name
1.104 + * @param [in] handle - handle of call server
1.105 + * @returns name of the call server
1.106 + * NOTE: The memory for return string doesn't need to be freed it will be freed when the info reference is freed
1.107 + */
1.108 +cc_string_t CCAPI_DeviceInfo_getCallServerName(cc_callserver_ref_t handle);
1.109 +
1.110 +/**
1.111 + * gets call server mode
1.112 + * @param [in] handle - handle of call server
1.113 + * @returns - mode of the call server
1.114 + */
1.115 +cc_cucm_mode_t CCAPI_DeviceInfo_getCallServerMode(cc_callserver_ref_t handle);
1.116 +
1.117 +/**
1.118 + * gets calls erver name
1.119 + * @param [in] handle - handle of call server
1.120 + * @returns status of the call server
1.121 + */
1.122 +cc_ccm_status_t CCAPI_DeviceInfo_getCallServerStatus(cc_callserver_ref_t handle);
1.123 +
1.124 +/**
1.125 + * get the NOTIFICATION PROMPT
1.126 + * @param [in] handle - reference to device info
1.127 + * @returns
1.128 + */
1.129 +cc_string_t CCAPI_DeviceInfo_getNotifyPrompt(cc_deviceinfo_ref_t handle) ;
1.130 +
1.131 +/**
1.132 + * get the NOTIFICATION PROMPT PRIORITY
1.133 + * @param [in] handle - reference to device info
1.134 + * @returns
1.135 + */
1.136 +cc_uint32_t CCAPI_DeviceInfo_getNotifyPromptPriority(cc_deviceinfo_ref_t handle) ;
1.137 +
1.138 +/**
1.139 + * get the NOTIFICATION PROMPT Progress
1.140 + * @param [in] handle - reference to device info
1.141 + * @returns
1.142 + */
1.143 +cc_uint32_t CCAPI_DeviceInfo_getNotifyPromptProgress(cc_deviceinfo_ref_t handle) ;
1.144 +
1.145 +/**
1.146 + * gets provisioing for missed call logging
1.147 + * This value should be reread on CONFIG_UPDATE event
1.148 + * @param [in] handle - reference to device info
1.149 + * @returns boolean - false => disabled true => enabled
1.150 + */
1.151 +cc_boolean CCAPI_DeviceInfo_isMissedCallLoggingEnabled (cc_deviceinfo_ref_t handle);
1.152 +
1.153 +/**
1.154 + * gets provisioing for placed call logging
1.155 + * This value should be reread on CONFIG_UPDATE event
1.156 + * @param [in] handle - reference to device info
1.157 + * @returns boolean - false => disabled true => enabled
1.158 + */
1.159 +cc_boolean CCAPI_DeviceInfo_isPlacedCallLoggingEnabled (cc_deviceinfo_ref_t handle);
1.160 +
1.161 +/**
1.162 + * gets provisioing for received call logging
1.163 + * This value should be reread on CONFIG_UPDATE event
1.164 + * @param [in] handle - reference to device info
1.165 + * @returns boolean - false => disabled true => enabled
1.166 + */
1.167 +cc_boolean CCAPI_DeviceInfo_isReceivedCallLoggingEnabled (cc_deviceinfo_ref_t handle);
1.168 +
1.169 +/**
1.170 + * gets register/in service time
1.171 + * This value should be read once the register completes successfully
1.172 + * @param [in] handle - reference to device info
1.173 + * @returns long - time registration completed successfully.
1.174 + */
1.175 +long long CCAPI_DeviceInfo_getRegTime (cc_deviceinfo_ref_t handle);
1.176 +
1.177 +/**
1.178 + * Returns dot notation IP address used for registering phone. If phone is not
1.179 + * registered, then "0.0.0.0" is returned.
1.180 + * @param [in] handle - reference to device info
1.181 + * @return cc_string_t IP address used to register phone.
1.182 + */
1.183 +cc_string_t CCAPI_DeviceInfo_getSignalingIPAddress(cc_deviceinfo_ref_t handle);
1.184 +
1.185 +/**
1.186 + * Returns camera admin enable/disable status
1.187 + * @param [in] handle - reference to device info
1.188 + * @return cc_boolean - TRUE => enabled
1.189 + */
1.190 +cc_boolean CCAPI_DeviceInfo_isCameraEnabled(cc_deviceinfo_ref_t handle);
1.191 +
1.192 +/**
1.193 + * Returns admin enable/disable video capablity for device
1.194 + * @param [in] handle - reference to device info
1.195 + * @return cc_boolean - TRUE => enabled
1.196 + */
1.197 +cc_boolean CCAPI_DeviceInfo_isVideoCapEnabled(cc_deviceinfo_ref_t handle);
1.198 +
1.199 +/**
1.200 + * gets the device mwi_lamp state
1.201 + * @param [in] handle - reference to device info
1.202 + * @returns boolean - mwi_lamp state
1.203 + */
1.204 +cc_boolean CCAPI_DeviceInfo_getMWILampState(cc_deviceinfo_ref_t handle);
1.205 +
1.206 +#endif /* _CCAPIAPI_DEVICE_INFO_H_ */
