pjsua_msg_data class final

This structure describes additional information to be sent with outgoing SIP message. It can (optionally) be specified for example with #pjsua_call_make_call(), #pjsua_call_answer(), #pjsua_call_hangup(), #pjsua_call_set_hold(), #pjsua_call_send_im(), and many more.

Application MUST call #pjsua_msg_data_init() to initialize this structure before setting its values.

Inheritance

• Object
• Struct
• pjsua_msg_data

Implemented types

• NativeType

Available extensions

• StructAddress

Constructors

pjsua_msg_data.new()

Properties

address → Pointer<T>

Available on T, provided by the StructAddress extension

The memory address of the underlying data.

no setter

content_type ↔ pj_str_t

MIME type of optional message body.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

hdr_list ↔ pjsip_hdr

Additional message headers as linked list. Application can add headers to the list by creating the header, either from the heap/pool or from temporary local variable, and add the header using linked list operation. See pjsua_app.c for some sample codes.

getter/setter pair

local_uri ↔ pj_str_t

Optional local URI (i.e. From header). If NULL, the account ID \a pjsua_acc_config.id is used for the From header. This field is currently used only by pjsua_call_make_call() and pjsua_im_send().

getter/setter pair

msg_body ↔ pj_str_t

Optional message body to be added to the message, only when the message doesn't have a body.

getter/setter pair

multipart_ctype ↔ pjsip_media_type

Content type of the multipart body. If application wants to send multipart message bodies, it puts the parts in \a parts and set the content type in \a multipart_ctype. If the message already contains a body, the body will be added to the multipart bodies.

getter/setter pair

multipart_parts ↔ pjsip_multipart_part

List of multipart parts. If application wants to send multipart message bodies, it puts the parts in \a parts and set the content type in \a multipart_ctype. If the message already contains a body, the body will be added to the multipart bodies.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

target_uri ↔ pj_str_t

Optional remote target URI (i.e. Target header). If NULL, the target will be set to the remote URI (To header). This field is used by pjsua_call_make_call(), pjsua_im_send(), pjsua_call_reinvite(), pjsua_call_set_hold(), and pjsua_call_update().

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited