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_LINE_INFO_H_
michael@0: #define _CCAPI_LINE_INFO_H_
michael@0: 
michael@0: #include "ccapi_types.h"
michael@0: 
michael@0: /**
michael@0:  * Get the line ID
michael@0:  * @param [in] line - line reference handle
michael@0:  * @return cc_call_handle_t - handle of the call created
michael@0:  */
michael@0: cc_uint32_t CCAPI_lineInfo_getID(cc_lineinfo_ref_t line);
michael@0: 
michael@0: /**
michael@0:  * Get the line Name
michael@0:  * @param [in] line - line reference handle
michael@0:  * @return cc_string_t - line 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_lineInfo_getName(cc_lineinfo_ref_t line);
michael@0: 
michael@0: /**
michael@0:  * Get the line Label
michael@0:  * @param [in] line - line reference handle
michael@0:  * @return cc_string_t - line Label
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_lineInfo_getLabel(cc_lineinfo_ref_t line);
michael@0: 
michael@0: /**
michael@0:  * Get the line DN Number
michael@0:  * @param [in] line - line reference handle
michael@0:  * @return cc_string_t - line DN
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_lineInfo_getNumber(cc_lineinfo_ref_t line);
michael@0: 
michael@0: /**
michael@0:  * Get the line External Number
michael@0:  * @param [in] line - line reference handle
michael@0:  * @return cc_string_t - line DN
michael@0:  * NOTE: The memory for return string doesn't need to be freed it will be freedwhen the info reference is freed
michael@0:  */
michael@0: cc_string_t CCAPI_lineInfo_getExternalNumber(cc_lineinfo_ref_t line);
michael@0: 
michael@0: /**
michael@0:  * Get the physical button number on which this line is configured
michael@0:  * @param [in] line - line reference handle
michael@0:  * @return cc_uint32_t - button number
michael@0:  * NOTE: This API is deprecated please don't use this. the CCAPI_lineInfo_getID() returns the button number
michael@0:  * as we use the button as line id
michael@0:  */
michael@0: cc_uint32_t CCAPI_lineInfo_getButton(cc_lineinfo_ref_t line);
michael@0: 
michael@0: /**
michael@0:  * Get the Line Type
michael@0:  * @param [in] line - line reference handle
michael@0:  * @return cc_uint32_t - line featureID ( Line )
michael@0:  */
michael@0: cc_line_feature_t CCAPI_lineInfo_getLineType(cc_lineinfo_ref_t line);
michael@0: 
michael@0: /**
michael@0:  * Get the physical button number on which this line is configured
michael@0:  * @param [in] line - line reference handle
michael@0:  * @return cc_uint32_t - button number
michael@0:  */
michael@0: cc_boolean CCAPI_lineInfo_getRegState(cc_lineinfo_ref_t line);
michael@0: 
michael@0: /**
michael@0:  * Get the CFWDAll status for the line
michael@0:  * @param [in] line - line reference handle
michael@0:  * @return cc_boolean - isForwarded
michael@0:  */
michael@0: cc_boolean CCAPI_lineInfo_isCFWDActive(cc_lineinfo_ref_t line);
michael@0: 
michael@0: /**
michael@0:  * Get the CFWDAll destination
michael@0:  * @param [in] line - line reference handle
michael@0:  * @return cc_string_t - cfwd target
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_lineInfo_getCFWDName(cc_lineinfo_ref_t line);
michael@0: 
michael@0: /**
michael@0:  * Get calls on line
michael@0:  * @param [in] line - lineID
michael@0:  * @param [in, out] handles[] - Array of callinfo references
michael@0:  * @param [in,out] count - count of call references populated
michael@0:  * @return void
michael@0:  */
michael@0: void CCAPI_LineInfo_getCalls(cc_lineid_t line, cc_call_handle_t handles[], int *count);
michael@0: 
michael@0: /**
michael@0:  * Get calls on line by state
michael@0:  * @param [in] line - lineID
michael@0:  * @param [in] state - state
michael@0:  * @param [in, out] handles[] - Array of callinfo references
michael@0:  * @param [in,out] count - count of call references populated
michael@0:  * @return void
michael@0:  */
michael@0: void CCAPI_LineInfo_getCallsByState(cc_lineid_t line, cc_call_state_t state,
michael@0:                 cc_call_handle_t handles[], int *count);
michael@0: 
michael@0: /**
michael@0:  * Get the MWI Status
michael@0:  * @param line - line reference handle
michael@0:  * @return cc_uint32_t - MWI status (boolean 0 => no MWI)
michael@0:  */
michael@0: cc_uint32_t CCAPI_lineInfo_getMWIStatus(cc_lineinfo_ref_t line);
michael@0: 
michael@0: /**
michael@0:  * Get the MWI Type
michael@0:  * @param line - line reference handle
michael@0:  * @return cc_uint32_t - MWI Type
michael@0:  */
michael@0: cc_uint32_t CCAPI_lineInfo_getMWIType(cc_lineinfo_ref_t line);
michael@0: 
michael@0: /**
michael@0:  * Get the MWI new msg count
michael@0:  * @param line - line reference handle
michael@0:  * @return cc_uint32_t - MWI new msg count
michael@0:  */
michael@0: cc_uint32_t CCAPI_lineInfo_getMWINewMsgCount(cc_lineinfo_ref_t line);
michael@0: 
michael@0: /**
michael@0:  * Get the MWI old msg count
michael@0:  * @param line - line reference handle
michael@0:  * @return cc_uint32_t - MWI old msg count
michael@0:  */
michael@0: cc_uint32_t CCAPI_lineInfo_getMWIOldMsgCount(cc_lineinfo_ref_t line);
michael@0: 
michael@0: /**
michael@0:  * Get the MWI high priority new msg count
michael@0:  * @param line - line reference handle
michael@0:  * @return cc_uint32_t - MWI new msg count
michael@0:  */
michael@0: cc_uint32_t CCAPI_lineInfo_getMWIPrioNewMsgCount(cc_lineinfo_ref_t line);
michael@0: 
michael@0: /**
michael@0:  * Get the MWI high priority old msg count
michael@0:  * @param line - line reference handle
michael@0:  * @return cc_uint32_t - MWI old msg count
michael@0:  */
michael@0: cc_uint32_t CCAPI_lineInfo_getMWIPrioOldMsgCount(cc_lineinfo_ref_t line);
michael@0: 
michael@0: /**
michael@0:  * has capability - is the feature allowed
michael@0:  * @param [in] handle - call info handle
michael@0:  * @param [in] feat_id - feature id
michael@0:  * @return boolean - is Allowed
michael@0:  */
michael@0: cc_boolean  CCAPI_LineInfo_hasCapability(cc_lineinfo_ref_t line, cc_int32_t feat_id);
michael@0: 
michael@0: /**
michael@0:  * get Allowed Feature set
michael@0:  * @param [in] handle - call info handle
michael@0:  * @param [in,out] feat_set - array of len CC_CALL_CAP_MAX
michael@0:  * @return cc_return_t - CC_SUCCESS or CC_FAILURE
michael@0:  */
michael@0: cc_return_t  CCAPI_LineInfo_getCapabilitySet(cc_lineinfo_ref_t line, cc_int32_t feat_set[]);
michael@0: 
michael@0: #endif /* _CCAPIAPI_LINE_INFO_H_ */