一个实例JsSIP.NameAddrHeader类包含“name addr”或“addr-spec”值,如RFC 3261的BNF语法中所述。
“name addr”值的形式为“display name<URI>”。
From: "Alice" <sip:alice@atlanta.com>
“addr-spec”值的形式为“URI”。
From: sip:alice@atlanta.com
实例
JsSIP.NameAddrHeader
(uri, display_name=null, parameters=null)
如果没有传递uri值,则此类的实例化将引发异常
var parameters = {
'parameter_1': 'value_1',
'parameter_2': null
}
var header = new JsSIP.NameAddrHeader(uri, 'Mrs. Alice', parameters)
header.toString() // Returns '"Mrs. Alice" <sip:alice@atlanta.com>;parameter_1=value_1;parameter_2'
实例属性
display_name
设置或获取指示标头显示名称的字符串。
header.display_name = 'Mrs. Alice';
uri
得到“name addr”形式的JsSIP.URI实例
实例方法
setParam
(key, value=null)
使用给定值创建或替换给定的标头参数。
header.setParam('param_name', 'param_value');
getParam
(key)
获取给定标头参数的值。如果参数集中不存在该参数,则返回undefined。
header.setParam('param_name', 'param_value');
header.getParam('param_name'); // Returns 'param_value'
hasParam
(key)
验证给定标头参数是否存在。如果参数存在,则返回true,否则返回false。
header.setParam('param_name', 'param_value');
header.hasParam('param_name'); // Returns true
deleteParam
(key)
从标头中删除给定的参数。
header.deleteParam('param_name');
clearParams
()
删除标头所有的参数。
clone
()
返回克隆后的标头的JsSIP.NameAddrHeader实例。
cloned_header = header.clone();
cloned_header === header // Returns false
toString
()
返回表示标头的字符串。
header.toString(); // Returns '"Mrs. Alice" <sip:alice@atlanta.com:5060>;param_name=param_value'
模块
parse
(nameAddrHeader)
根据名称-地址标头语法规则分析给定的字符串。返回JsSIP.NameAddrHeader实例(如果解析成功),否则未定义。
var name_addr_hdr = JsSIP.NameAddrHeader.parse('"Mrs. Alice" <sip:alice@atlanta.com:5060>;param_name=param_value');