sip.js.referral.md

September 26, 2022 ยท View on GitHub

Home > sip.js > Referral

Referral class

A request to establish a Session elsewhere (incoming REFER).

Signature:

export declare class Referral 

Remarks

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Referral class.

Properties

PropertyModifiersTypeDescription
referredBystring | undefined
referToNameAddrHeader
replacesstring | undefined
requestIncomingRequestMessageIncoming REFER request message.

Methods

MethodModifiersDescription
accept(options)Accept the request.
makeInviter(options)Creates an inviter which may be used to send an out of dialog INVITE request.
reject(options)Reject the request.