1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/media/webrtc/signaling/src/sipcc/include/ccapi_line_info.h Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,165 @@
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_LINE_INFO_H_
1.9 +#define _CCAPI_LINE_INFO_H_
1.10 +
1.11 +#include "ccapi_types.h"
1.12 +
1.13 +/**
1.14 + * Get the line ID
1.15 + * @param [in] line - line reference handle
1.16 + * @return cc_call_handle_t - handle of the call created
1.17 + */
1.18 +cc_uint32_t CCAPI_lineInfo_getID(cc_lineinfo_ref_t line);
1.19 +
1.20 +/**
1.21 + * Get the line Name
1.22 + * @param [in] line - line reference handle
1.23 + * @return cc_string_t - line Name
1.24 + * NOTE: The memory for return string doesn't need to be freed it will be freed when the info reference is freed
1.25 + */
1.26 +cc_string_t CCAPI_lineInfo_getName(cc_lineinfo_ref_t line);
1.27 +
1.28 +/**
1.29 + * Get the line Label
1.30 + * @param [in] line - line reference handle
1.31 + * @return cc_string_t - line Label
1.32 + * NOTE: The memory for return string doesn't need to be freed it will be freed when the info reference is freed
1.33 + */
1.34 +cc_string_t CCAPI_lineInfo_getLabel(cc_lineinfo_ref_t line);
1.35 +
1.36 +/**
1.37 + * Get the line DN Number
1.38 + * @param [in] line - line reference handle
1.39 + * @return cc_string_t - line DN
1.40 + * NOTE: The memory for return string doesn't need to be freed it will be freed when the info reference is freed
1.41 + */
1.42 +cc_string_t CCAPI_lineInfo_getNumber(cc_lineinfo_ref_t line);
1.43 +
1.44 +/**
1.45 + * Get the line External Number
1.46 + * @param [in] line - line reference handle
1.47 + * @return cc_string_t - line DN
1.48 + * NOTE: The memory for return string doesn't need to be freed it will be freedwhen the info reference is freed
1.49 + */
1.50 +cc_string_t CCAPI_lineInfo_getExternalNumber(cc_lineinfo_ref_t line);
1.51 +
1.52 +/**
1.53 + * Get the physical button number on which this line is configured
1.54 + * @param [in] line - line reference handle
1.55 + * @return cc_uint32_t - button number
1.56 + * NOTE: This API is deprecated please don't use this. the CCAPI_lineInfo_getID() returns the button number
1.57 + * as we use the button as line id
1.58 + */
1.59 +cc_uint32_t CCAPI_lineInfo_getButton(cc_lineinfo_ref_t line);
1.60 +
1.61 +/**
1.62 + * Get the Line Type
1.63 + * @param [in] line - line reference handle
1.64 + * @return cc_uint32_t - line featureID ( Line )
1.65 + */
1.66 +cc_line_feature_t CCAPI_lineInfo_getLineType(cc_lineinfo_ref_t line);
1.67 +
1.68 +/**
1.69 + * Get the physical button number on which this line is configured
1.70 + * @param [in] line - line reference handle
1.71 + * @return cc_uint32_t - button number
1.72 + */
1.73 +cc_boolean CCAPI_lineInfo_getRegState(cc_lineinfo_ref_t line);
1.74 +
1.75 +/**
1.76 + * Get the CFWDAll status for the line
1.77 + * @param [in] line - line reference handle
1.78 + * @return cc_boolean - isForwarded
1.79 + */
1.80 +cc_boolean CCAPI_lineInfo_isCFWDActive(cc_lineinfo_ref_t line);
1.81 +
1.82 +/**
1.83 + * Get the CFWDAll destination
1.84 + * @param [in] line - line reference handle
1.85 + * @return cc_string_t - cfwd target
1.86 + * NOTE: The memory for return string doesn't need to be freed it will be freed when the info reference is freed
1.87 + */
1.88 +cc_string_t CCAPI_lineInfo_getCFWDName(cc_lineinfo_ref_t line);
1.89 +
1.90 +/**
1.91 + * Get calls on line
1.92 + * @param [in] line - lineID
1.93 + * @param [in, out] handles[] - Array of callinfo references
1.94 + * @param [in,out] count - count of call references populated
1.95 + * @return void
1.96 + */
1.97 +void CCAPI_LineInfo_getCalls(cc_lineid_t line, cc_call_handle_t handles[], int *count);
1.98 +
1.99 +/**
1.100 + * Get calls on line by state
1.101 + * @param [in] line - lineID
1.102 + * @param [in] state - state
1.103 + * @param [in, out] handles[] - Array of callinfo references
1.104 + * @param [in,out] count - count of call references populated
1.105 + * @return void
1.106 + */
1.107 +void CCAPI_LineInfo_getCallsByState(cc_lineid_t line, cc_call_state_t state,
1.108 + cc_call_handle_t handles[], int *count);
1.109 +
1.110 +/**
1.111 + * Get the MWI Status
1.112 + * @param line - line reference handle
1.113 + * @return cc_uint32_t - MWI status (boolean 0 => no MWI)
1.114 + */
1.115 +cc_uint32_t CCAPI_lineInfo_getMWIStatus(cc_lineinfo_ref_t line);
1.116 +
1.117 +/**
1.118 + * Get the MWI Type
1.119 + * @param line - line reference handle
1.120 + * @return cc_uint32_t - MWI Type
1.121 + */
1.122 +cc_uint32_t CCAPI_lineInfo_getMWIType(cc_lineinfo_ref_t line);
1.123 +
1.124 +/**
1.125 + * Get the MWI new msg count
1.126 + * @param line - line reference handle
1.127 + * @return cc_uint32_t - MWI new msg count
1.128 + */
1.129 +cc_uint32_t CCAPI_lineInfo_getMWINewMsgCount(cc_lineinfo_ref_t line);
1.130 +
1.131 +/**
1.132 + * Get the MWI old msg count
1.133 + * @param line - line reference handle
1.134 + * @return cc_uint32_t - MWI old msg count
1.135 + */
1.136 +cc_uint32_t CCAPI_lineInfo_getMWIOldMsgCount(cc_lineinfo_ref_t line);
1.137 +
1.138 +/**
1.139 + * Get the MWI high priority new msg count
1.140 + * @param line - line reference handle
1.141 + * @return cc_uint32_t - MWI new msg count
1.142 + */
1.143 +cc_uint32_t CCAPI_lineInfo_getMWIPrioNewMsgCount(cc_lineinfo_ref_t line);
1.144 +
1.145 +/**
1.146 + * Get the MWI high priority old msg count
1.147 + * @param line - line reference handle
1.148 + * @return cc_uint32_t - MWI old msg count
1.149 + */
1.150 +cc_uint32_t CCAPI_lineInfo_getMWIPrioOldMsgCount(cc_lineinfo_ref_t line);
1.151 +
1.152 +/**
1.153 + * has capability - is the feature allowed
1.154 + * @param [in] handle - call info handle
1.155 + * @param [in] feat_id - feature id
1.156 + * @return boolean - is Allowed
1.157 + */
1.158 +cc_boolean CCAPI_LineInfo_hasCapability(cc_lineinfo_ref_t line, cc_int32_t feat_id);
1.159 +
1.160 +/**
1.161 + * get Allowed Feature set
1.162 + * @param [in] handle - call info handle
1.163 + * @param [in,out] feat_set - array of len CC_CALL_CAP_MAX
1.164 + * @return cc_return_t - CC_SUCCESS or CC_FAILURE
1.165 + */
1.166 +cc_return_t CCAPI_LineInfo_getCapabilitySet(cc_lineinfo_ref_t line, cc_int32_t feat_set[]);
1.167 +
1.168 +#endif /* _CCAPIAPI_LINE_INFO_H_ */
