michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: #ifndef _CCAPI_DEVICE_INFO_H_
michael@0: #define _CCAPI_DEVICE_INFO_H_
michael@0: 
michael@0: #include "ccapi_types.h"
michael@0: 
michael@0: /**
michael@0:  * gets the device name
michael@0:  * @returns - a pointer to the device name
michael@0:  */
michael@0: cc_deviceinfo_ref_t CCAPI_DeviceInfo_getDeviceHandle() ;
michael@0: 
michael@0: /**
michael@0:  * gets the device name
michael@0:  * @param [in] handle - reference to device info
michael@0:  * @returns - a pointer to the device name
michael@0:  * NOTE: The memory for return string doesn't need to be freed it will be freed when the info reference is freed
michael@0:  */
michael@0: cc_string_t CCAPI_DeviceInfo_getDeviceName(cc_deviceinfo_ref_t handle) ;
michael@0: 
michael@0: /**
michael@0:  * gets the device idle status
michael@0:  * @param [in] handle - reference to device info
michael@0:  * @returns boolean - idle status
michael@0:  */
michael@0: cc_boolean CCAPI_DeviceInfo_isPhoneIdle(cc_deviceinfo_ref_t handle) ;
michael@0: 
michael@0: /**
michael@0:  * gets the service state
michael@0:  * @param [in] handle - reference to device info
michael@0:  * @returns cc_service_state_t - INS/OOS
michael@0:  */
michael@0: cc_service_state_t CCAPI_DeviceInfo_getServiceState(cc_deviceinfo_ref_t handle) ;
michael@0: 
michael@0: /**
michael@0:  * gets the service cause
michael@0:  * @param [in] handle - reference to device info
michael@0:  * @returns cc_service_cause_t - reason for service state
michael@0:  */
michael@0: cc_service_cause_t CCAPI_DeviceInfo_getServiceCause(cc_deviceinfo_ref_t handle) ;
michael@0: 
michael@0: /**
michael@0:  * gets the cucm mode
michael@0:  * @param [in] handle - reference to device info
michael@0:  * @returns cc_cucm_mode_t - CUCM mode
michael@0:  */
michael@0: cc_cucm_mode_t CCAPI_DeviceInfo_getCUCMMode(cc_deviceinfo_ref_t handle) ;
michael@0: 
michael@0: /**
michael@0:  * gets list of handles to calls on the device
michael@0:  * @param [in] handle - reference to device info
michael@0:  * @param [out] handles - array of call handle to be returned
michael@0:  * @param [in,out] count number allocated in array/elements returned
michael@0:  * @returns
michael@0:  */
michael@0: void CCAPI_DeviceInfo_getCalls(cc_deviceinfo_ref_t handle, cc_call_handle_t handles[], cc_uint16_t *count) ;
michael@0: 
michael@0: /**
michael@0:  * gets list of handles to calls on the device by state
michael@0:  * @param [in] handle - reference to device info
michael@0:  * @param [in] state - call state for which the calls are requested
michael@0:  * @param [out] handles - array of call handle to be returned
michael@0:  * @param [in,out] count number allocated in array/elements returned
michael@0:  * @returns
michael@0:  */
michael@0: void CCAPI_DeviceInfo_getCallsByState(cc_deviceinfo_ref_t handle, cc_call_state_t state,
michael@0:                 cc_call_handle_t handles[], cc_uint16_t *count) ;
michael@0: 
michael@0: /**
michael@0:  * gets list of handles to lines on the device
michael@0:  * @param [in] handle - reference to device info
michael@0:  * @param [in] handles - array of line handle to be returned
michael@0:  * @param [in,out] count - pointer to count in array in-> memory allocated out-> num populated
michael@0:  * @returns
michael@0:  */
michael@0: void CCAPI_DeviceInfo_getLines(cc_deviceinfo_ref_t handle, cc_lineid_t handles[], cc_uint16_t *count) ;
michael@0: 
michael@0: /**
michael@0:  * gets list of handles to features on the device
michael@0:  * @param [in] handle - reference to device info
michael@0:  * @param [in] handles - array of feature handle to be returned
michael@0:  * @param [in,out] count - pointer to count in array in-> memory allocated out-> num populated
michael@0:  * @returns
michael@0:  */
michael@0: void CCAPI_DeviceInfo_getFeatures(cc_deviceinfo_ref_t handle, cc_featureinfo_ref_t handles[], cc_uint16_t *count) ;
michael@0: 
michael@0: /**
michael@0:  * gets handles of call agent servers
michael@0:  * @param [in] handle - reference to device info
michael@0:  * @param [in] handles - array of handles to call agent servers
michael@0:  * @param [in,out] count - pointer to count in array in-> memory allocated out-> num populated
michael@0:  * @returns
michael@0:  */
michael@0: void CCAPI_DeviceInfo_getCallServers(cc_deviceinfo_ref_t handle, cc_callserver_ref_t handles[], cc_uint16_t *count) ;
michael@0: 
michael@0: /**
michael@0:  * gets call server name
michael@0:  * @param [in] handle - handle of call server
michael@0:  * @returns name of the call server
michael@0:  * NOTE: The memory for return string doesn't need to be freed it will be freed when the info reference is freed
michael@0:  */
michael@0: cc_string_t CCAPI_DeviceInfo_getCallServerName(cc_callserver_ref_t handle);
michael@0: 
michael@0: /**
michael@0:  * gets call server mode
michael@0:  * @param [in] handle - handle of call server
michael@0:  * @returns - mode of the call server
michael@0:  */
michael@0: cc_cucm_mode_t CCAPI_DeviceInfo_getCallServerMode(cc_callserver_ref_t handle);
michael@0: 
michael@0: /**
michael@0:  * gets calls erver name
michael@0:  * @param [in] handle - handle of call server
michael@0:  * @returns status of the call server
michael@0:  */
michael@0: cc_ccm_status_t CCAPI_DeviceInfo_getCallServerStatus(cc_callserver_ref_t handle);
michael@0: 
michael@0: /**
michael@0:  * get the NOTIFICATION PROMPT
michael@0:  * @param [in] handle - reference to device info
michael@0:  * @returns
michael@0:  */
michael@0: cc_string_t CCAPI_DeviceInfo_getNotifyPrompt(cc_deviceinfo_ref_t handle) ;
michael@0: 
michael@0: /**
michael@0:  * get the NOTIFICATION PROMPT PRIORITY
michael@0:  * @param [in] handle - reference to device info
michael@0:  * @returns
michael@0:  */
michael@0: cc_uint32_t CCAPI_DeviceInfo_getNotifyPromptPriority(cc_deviceinfo_ref_t handle) ;
michael@0: 
michael@0: /**
michael@0:  * get the NOTIFICATION PROMPT Progress
michael@0:  * @param [in] handle - reference to device info
michael@0:  * @returns
michael@0:  */
michael@0: cc_uint32_t CCAPI_DeviceInfo_getNotifyPromptProgress(cc_deviceinfo_ref_t handle) ;
michael@0: 
michael@0: /**
michael@0:  * gets provisioing for missed call logging
michael@0:  * This value should be reread on CONFIG_UPDATE event
michael@0:  * @param [in] handle - reference to device info
michael@0:  * @returns boolean - false => disabled true => enabled
michael@0:  */
michael@0: cc_boolean CCAPI_DeviceInfo_isMissedCallLoggingEnabled (cc_deviceinfo_ref_t handle);
michael@0: 
michael@0: /**
michael@0:  * gets provisioing for placed call logging
michael@0:  * This value should be reread on CONFIG_UPDATE event
michael@0:  * @param [in] handle - reference to device info
michael@0:  * @returns boolean - false => disabled true => enabled
michael@0:  */
michael@0: cc_boolean CCAPI_DeviceInfo_isPlacedCallLoggingEnabled (cc_deviceinfo_ref_t handle);
michael@0: 
michael@0: /**
michael@0:  * gets provisioing for received call logging
michael@0:  * This value should be reread on CONFIG_UPDATE event
michael@0:  * @param [in] handle - reference to device info
michael@0:  * @returns boolean - false => disabled true => enabled
michael@0:  */
michael@0: cc_boolean CCAPI_DeviceInfo_isReceivedCallLoggingEnabled (cc_deviceinfo_ref_t handle);
michael@0: 
michael@0: /**
michael@0:  * gets register/in service time
michael@0:  * This value should be read once the register completes successfully
michael@0:  * @param [in] handle - reference to device info
michael@0:  * @returns long - time registration completed successfully.
michael@0:  */
michael@0: long long CCAPI_DeviceInfo_getRegTime (cc_deviceinfo_ref_t handle);
michael@0: 
michael@0: /**
michael@0:  * Returns dot notation IP address used for registering phone. If phone is not
michael@0:  * registered, then "0.0.0.0" is returned.
michael@0:  * @param [in] handle - reference to device info
michael@0:  * @return  cc_string_t  IP address used to register phone.
michael@0:  */
michael@0: cc_string_t CCAPI_DeviceInfo_getSignalingIPAddress(cc_deviceinfo_ref_t handle);
michael@0: 
michael@0: /**
michael@0:  * Returns camera admin enable/disable status
michael@0:  * @param [in] handle - reference to device info
michael@0:  * @return  cc_boolean  - TRUE => enabled
michael@0:  */
michael@0: cc_boolean CCAPI_DeviceInfo_isCameraEnabled(cc_deviceinfo_ref_t handle);
michael@0: 
michael@0: /**
michael@0:  * Returns admin enable/disable video capablity for device
michael@0:  * @param [in] handle - reference to device info
michael@0:  * @return  cc_boolean  - TRUE => enabled
michael@0:  */
michael@0: cc_boolean CCAPI_DeviceInfo_isVideoCapEnabled(cc_deviceinfo_ref_t handle);
michael@0: 
michael@0: /**
michael@0:  * gets the device mwi_lamp state
michael@0:  * @param [in] handle - reference to device info
michael@0:  * @returns boolean - mwi_lamp state
michael@0:  */
michael@0: cc_boolean CCAPI_DeviceInfo_getMWILampState(cc_deviceinfo_ref_t handle);
michael@0: 
michael@0: #endif /* _CCAPIAPI_DEVICE_INFO_H_ */