Skip to content

Latest commit

 

History

History
50 lines (38 loc) · 3.4 KB

sip.js.outgoingrequestmessage.md

File metadata and controls

50 lines (38 loc) · 3.4 KB

Home > sip.js > OutgoingRequestMessage

OutgoingRequestMessage class

Outgoing SIP request message.

Signature:

export declare class OutgoingRequestMessage 

Constructors

Constructor Modifiers Description
(constructor)(method, ruri, fromURI, toURI, options, extraHeaders, body) Constructs a new instance of the OutgoingRequestMessage class

Properties

Property Modifiers Type Description
body { body: string; contentType: string; } | undefined
branch string | undefined
callId string
cseq number
extraHeaders Array<string>
from NameAddrHeader
fromTag string
fromURI URI
headers { [name: string]: Array<string>; }
method string
ruri URI
to NameAddrHeader
toTag string | undefined
toURI URI

Methods

Method Modifiers Description
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.
setHeader(name, value) Replace the the given header by the given value.
setViaHeader(branch, transport)

The Via header field indicates the transport used for the transaction and identifies the location where the response is to be sent. A Via header field value is added only after the transport that will be used to reach the next hop has been selected (which may involve the usage of the procedures in [4]).

When the UAC creates a request, it MUST insert a Via into that request. The protocol name and protocol version in the header field MUST be SIP and 2.0, respectively. The Via header field value MUST contain a branch parameter. This parameter is used to identify the transaction created by that request. This parameter is used by both the client and the server. https://tools.ietf.org/html/rfc3261\#section-8.1.1.7

toString()