ersip_hdr_refer_to.md

Module ersip_hdr_refer_to

• Data Types
• Function Index
• Function Details

Data Types

parse_result()

parse_result() = {ok, refer_to()} | {error, term()}

raw()

raw() = #{uri => ersip_uri:raw(), params => ersip_hparams:raw(), display_name => ersip_display_name:raw()}

refer_to()

refer_to() = #refer_to{display_name = ersip_display_name:display_name(), uri = ersip_uri:uri(), hparams = ersip_hparams:hparams()}

Function Index

all_raw_params/1	Get all raw parmeters of Refer-To header.
assemble/1	Assemble Refer-To to iolist().
assemble_bin/1	Assemble Refer-To to binary().
build/2	Build SIP raw header.
display_name/1	Display name in Refer-To header.
make/1	Make Refer-To from binary or raw value.
new/1	Create Refer-To header from URI.
parse/1	Parse Refer-To from binary or raw SIP header representation.
raw/1	Raw representation of Refer-To header.
set_display_name/2	Set display name of Refer-To header.
set_uri/2	Set URI of Refer-To header.
uri/1	URI in Refer-To header.

Function Details

all_raw_params/1

all_raw_params(Refer_to::refer_to()) -> [{binary(), binary()} | binary()]

Get all raw parmeters of Refer-To header.

assemble/1

assemble(Refer_to::refer_to()) -> iolist()

Assemble Refer-To to iolist()

assemble_bin/1

assemble_bin(Refer_to::refer_to()) -> binary()

Assemble Refer-To to binary().

build/2

build(HdrName::binary(), Refer_to::refer_to()) -> ersip_hdr:header()

Build SIP raw header.

display_name/1

display_name(Refer_to::refer_to()) -> ersip_nameaddr:display_name()

Display name in Refer-To header.

make/1

make(Bin::binary() | raw()) -> refer_to()

Make Refer-To from binary or raw value.

new/1

new(URI::ersip_uri:uri()) -> refer_to()

Create Refer-To header from URI.

parse/1

parse(Bin::ersip_hdr:header() | binary()) -> parse_result()

Parse Refer-To from binary or raw SIP header representation.

raw/1

raw(Refer_to::refer_to()) -> raw()

Raw representation of Refer-To header.

set_display_name/2

set_display_name(DN::ersip_nameaddr:display_name(), Refer_to::refer_to()) -> refer_to()

Set display name of Refer-To header.

set_uri/2

set_uri(URI::ersip_uri:uri(), Refer_to::refer_to()) -> refer_to()

Set URI of Refer-To header.

uri/1

uri(Refer_to::refer_to()) -> ersip_uri:uri()

URI in Refer-To header.