Class OverSIP::SIP::NameAddr

An instance of the OverSIP::SIP::NameAddr class contains a “name-addr” or a “addr-spec” value as stated in the BNF grammar of the RFC 3261.

  • A “name-addr” value is in the form “display name <URI>”. Example:
    From: "Alice" <sip:alice@atlanta.com>
    
  • A “addr-spec” value is an URI. Example:
    From: sip:alice@atlanta.com
    

Parent class

OverSIP::SIP::NameAddr inherits all the methods of OverSIP::SIP::Uri and thus all the parent methods are available for retrieving data from the URI.

Class instance methods

display_name

Gets the display name value (String or nil if not present).

Example

request.from.display_name
#=> "Alice"

display_name=(value)

Sets the display name.

value
The new display name (String or nil for removing it).

Example

request.from.display_name = "Bob"
#=> "Bob"