sip.js.incomingmessage.md

September 26, 2022 ยท View on GitHub

Home > sip.js > IncomingMessage

IncomingMessage class

Incoming message.

Signature:

export declare class IncomingMessage 

Properties

PropertyModifiersTypeDescription
bodystring
callIdstring
cseqnumber
datastring
fromNameAddrHeader
fromTagstring
headers{ [name: string]: Array<{ parsed?: any; raw: string; }>; }
methodstring
referTostring | undefined
toNameAddrHeader
toTagstring
via{ host: string; port: number; }
viaBranchstring

Methods

MethodModifiersDescription
addHeader(name, value)Insert a header of the given name and value into the last position of the header array.
getHeader(name)Get the value of the given header name at the given position.
getHeaders(name)Get the header/s of the given name.
hasHeader(name)Verify the existence of the given header.
parseHeader(name, idx)Parse the given header on the given index.
s(name, idx)Message Header attribute selector. Alias of parseHeader.
setHeader(name, value)Replace the value of the given header by the value.
toString()