Module exmpp_stanza

Description
Function Index
Function Details

The module exmpp_stanza provides helpers to manipulate standard stanza.

Authors: Mickael Remond (mickael.remond@process-one.net), Jean-SÃ©bastien PÃ©dron (js.pedron@meetic-corp.com).

Description

The module exmpp_stanza provides helpers to manipulate standard stanza.

Function Index

error/2	Create an `<error/>` element based on the given `Condition`.
error/3	Create an `<error/>` element based on the given `Condition`.
get_condition/1	Return the child element name corresponding to the stanza error condition.
get_error/1	Return the error element from `Stanza`.
get_error_type/1	Return the type of the error element.
get_id/1	Return the stanza ID.
get_id_from_attrs/1	Return the stanza ID.
get_lang/1	Return the language of the stanza.
get_lang_from_attrs/1	Return the language of the stanza.
get_recipient/1	Return the recipient.
get_recipient_from_attrs/1	Return the recipient.
get_sender/1	Return the sender.
get_sender_from_attrs/1	Return the sender.
get_text/1	Return the text that describes the error.
get_type/1	Return the type of the stanza.
get_type_from_attrs/1	Return the type of the stanza.
is_stanza_error/1	Tell if the stanza transports an error.
remove_recipient/1	Remove the recipient.
remove_recipient_in_attrs/1	Remove the recipient.
remove_sender/1	Remove the sender.
remove_sender_in_attrs/1	Remove the sender.
reply/1	Prepare a reply to `Stanza`.
reply_from_attrs/1	Handles `to` and `from` attributes to prepare a reply stanza.
reply_with_error/2	Prepare an error reply to `Stanza`.
reply_without_content/1	Prepare a reply to `Stanza` with children removed.
set_error_type/2	Set the type of the error element.
set_error_type_from_condition/2	Set the type of the error element, based on the given condition.
set_id/2	Set the ID.
set_id_in_attrs/2	Set the ID.
set_jids/3	Set the sender and the recipient at the same time.
set_jids_in_attrs/3	Set the sender and the recipient at the same time.
set_lang/2	Set the lang.
set_lang_in_attrs/2	Set the lang.
set_recipient/2	Set the recipient.
set_recipient_in_attrs/2	Set the recipient.
set_sender/2	Set the sender.
set_sender_in_attrs/2	Set the sender.
set_type/2	Set the type of the stanza.
set_type_in_attrs/2	Set the type of the stanza.
stanza_error/2	Transform `Stanza` in a stanza error.
stanza_error_without_original/2	Transform `Stanza` in a stanza error.
to_binary/1	Serialize a stanza using common XMPP default namespaces.
to_binary/2	Serialize a stanza using the given default namespace.
to_binary/3	Serialize a stanza using the given namespaces.
to_iolist/1	Serialize a stanza using common XMPP default namespaces.
to_iolist/2	Serialize a stanza using the given default namespace.
to_iolist/3	Serialize a stanza using the given namespaces.
to_list/1	Serialize a stanza using common XMPP default namespaces.
to_list/2	Serialize a stanza using the given default namespace.
to_list/3	Serialize a stanza using the given namespaces.

Function Details

error/2

error(NS, Condition) -> Stanza_Error

NS = atom() | string()
Condition = atom()
Stanza_Error = exmpp_xml:xmlel()

Create an <error/> element based on the given Condition.

A default type is set by set_error_type/2 if NS is jabber:client or jabber:server. This does not contain any text element.

error/3

error(NS, Condition, Text::Text_Spec) -> Stanza_Error

NS = atom() | string()
Condition = atom()
Text_Spec = {Lang, Text} | Text | undefined
Lang = binary() | string() | undefined
Text = binary() | string() | undefined
Stanza_Error = exmpp_xml:xmlel()

Create an <error/> element based on the given Condition.

A default type is set by set_error_type/2 if NS is jabber:client or jabber:server. This does not contain any text element.

get_condition/1

get_condition(Stanza) -> Condition | undefined

Stanza = exmpp_xml:xmlel()
Condition = atom()

throws {stanza_error, condition, no_error_element_found, Stanza} | {stanza_error, condition, no_condition_found, Error}

Return the child element name corresponding to the stanza error condition.

If the namespace isn't neither jabber:client nor jabber:server, the name of the first child is returned.

get_error/1

get_error(Xmlel::Stanza) -> Error | undefined

Stanza = exmpp_xml:xmlel() | iq()
Error = exmpp_xml:xmlel()

Return the error element from Stanza.

The error element is supposed to have the name error and the same namespace as the stanza.

get_error_type/1

get_error_type(Stanza) -> Type

Stanza = exmpp_xml:xmlel()
Type = binary()

throws {stanza_error, error_type, no_error_element_found, Stanza}

Return the type of the error element.

get_id/1

get_id(Xmlel::Stanza) -> ID | undefined

Stanza = exmpp_xml:xmlel() | exmpp_iq:iq()
ID = binary()

Return the stanza ID.

get_id_from_attrs/1

get_id_from_attrs(Attrs) -> ID | undefined

Attrs = [exmpp_xml:xmlattr()]
ID = binary()

Return the stanza ID.

get_lang/1

get_lang(Xmlel::Stanza) -> Lang | undefined

Stanza = exmpp_xml:xmlel() | exmpp_iq:iq()
Lang = binary()

Return the language of the stanza.

get_lang_from_attrs/1

get_lang_from_attrs(Attrs) -> Lang | undefined

Attrs = [exmpp_xml:xmlattr()]
Lang = binary()

Return the language of the stanza.

get_recipient/1

get_recipient(Xmlel::Stanza) -> Recipient | undefined

Stanza = exmpp_xml:xmlel()
Recipient = binary()

Return the recipient.

The return value should be a JID and may be parsed with exmpp_jid:parse/1.

get_recipient_from_attrs/1

get_recipient_from_attrs(Attrs) -> Recipient | undefined

Attrs = [exmpp_xml:xmlattr()]
Recipient = binary()

Return the recipient.

The return value should be a JID and may be parsed with exmpp_jid:parse/1.

get_sender/1

get_sender(Xmlel::Stanza) -> Sender | undefined

Stanza = exmpp_xml:xmlel()
Sender = binary()

Return the sender.

The return value should be a JID and may be parsed with exmpp_jid:parse/1.

get_sender_from_attrs/1

get_sender_from_attrs(Attrs) -> Sender | undefined

Attrs = [exmpp_xml:xmlattr()]
Sender = binary()

Return the sender.

The return value should be a JID and may be parsed with exmpp_jid:parse/1.

get_text/1

get_text(Stanza) -> Text | undefined

Stanza = exmpp_xml:xmlel()
Text = binary()

throws {stanza_error, text, no_error_element_found, Stanza}

Return the text that describes the error.

If there is no <text/> element, an empty string is returned.

get_type/1

get_type(Xmlel::Stanza) -> Type | undefined

Stanza = exmpp_xml:xmlel() | exmpp_iq:iq()
Type = binary()

Return the type of the stanza.

get_type_from_attrs/1

get_type_from_attrs(Attrs) -> Type | undefined

Attrs = [exmpp_xml:xmlattr()]
Type = binary()

Return the type of the stanza.

is_stanza_error/1

is_stanza_error(Stanza) -> boolean()

Stanza = exmpp_xml:xmlel()

Tell if the stanza transports an error.

remove_recipient/1

remove_recipient(Xmlel::Stanza) -> New_Stanza

Stanza = exmpp_xml:xmlel()
New_Stanza = exmpp_xml:xmlel()

Remove the recipient.

remove_recipient_in_attrs/1

remove_recipient_in_attrs(Attrs) -> New_Attrs

Attrs = [exmpp_xml:xmlattr()]
New_Attrs = [exmpp_xml:xmlnattribute()]

Remove the recipient.

remove_sender/1

remove_sender(Xmlel::Stanza) -> New_Stanza

Stanza = exmpp_xml:xmlel()
New_Stanza = exmpp_xml:xmlel()

Remove the sender.

remove_sender_in_attrs/1

remove_sender_in_attrs(Attrs) -> New_Attrs

Attrs = [exmpp_xml:xmlattr()]
New_Attrs = [exmpp_xml:xmlnattribute()]

Remove the sender.

reply/1

reply(Xmlel::Stanza) -> Stanza_Reply

Stanza = exmpp_xml:xmlel()
Stanza_Reply = exmpp_xml:xmlel()

Prepare a reply to Stanza.

See also: reply_from_attrs/1.

reply_from_attrs/1

reply_from_attrs(Attrs) -> New_Attrs

Attrs = [exmpp_xml:xmlattr()]
New_Attrs = [exmpp_xml:xmlattr()]

Handles to and from attributes to prepare a reply stanza.

reply_with_error/2

reply_with_error(Stanza, Condition::Error) -> Stanza_Reply

Stanza = exmpp_xml:xmlel()
Error = exmpp_xml:xmlel() | atom()
Stanza_Reply = exmpp_xml:xmlel()

Prepare an error reply to Stanza.

If Error is an atom, it must be a standard condition defined by XMPP Core.

reply_without_content/1

reply_without_content(Xmlel::Stanza) -> Stanza_Reply

Stanza = exmpp_xml:xmlel()
Stanza_Reply = exmpp_xml:xmlel()

Prepare a reply to Stanza with children removed.

See also: reply_from_attrs/1.

set_error_type/2

set_error_type(Stanza, Type) -> New_Stanza

Stanza = exmpp_xml:xmlel()
Type = binary() | string()
New_Stanza = exmpp_xml:xmlel()

throws {stanza_error, error_type, no_error_element_found, Stanza}

Set the type of the error element.

set_error_type_from_condition/2

set_error_type_from_condition(Stanza, Condition) -> New_Stanza

Stanza = exmpp_xml:xmlel()
Condition = atom()
New_Stanza = exmpp_xml:xmlel()

throws {stanza_error, error_type, no_error_element_found, Stanza} | {stanza_error, error_type, invalid_condition, {NS, Condition}}

Set the type of the error element, based on the given condition.

If the condition is undefined-condition, the type is unchanged.

set_id/2

set_id(Xmlel::Stanza, ID) -> New_Stanza

Stanza = exmpp_xml:xmlel() | exmpp_iq:iq()
ID = binary() | string() | random | undefined
New_Stanza = exmpp_xml:xmlel() | exmpp_iq:iq()

Set the ID.

If ID is undefined or empty, it's removed. If ID is random, a random value is set.

set_id_in_attrs/2

set_id_in_attrs(Attrs, ID) -> New_Attrs

Attrs = [exmpp_xml:xmlattr()]
ID = binary() | string() | random | undefined
New_Attrs = [exmpp_xml:xmlnattribute()]

Set the ID.

If ID is undefined or empty, it's removed. If ID is random, a random value is set.

set_jids/3

set_jids(Stanza, From::Sender, To::Recipient) -> New_Stanza

Stanza = exmpp_xml:xmlel()
Sender = exmpp_jid:jid() | binary() | string() | undefined
Recipient = exmpp_jid:jid() | binary() | string() | undefined
New_Stanza = exmpp_xml:xmlel()

Set the sender and the recipient at the same time.

If Sender is set to undefined, the sender is removed. If Recipient is set to undefined, the recipient is removed.

set_jids_in_attrs/3

set_jids_in_attrs(Attrs, From::Sender, To::Recipient) -> New_Attrs

Attrs = [exmpp_xml:xmlattr()]
Sender = exmpp_jid:jid() | binary() | string() | undefined
Recipient = exmpp_jid:jid() | binary() | string() | undefined
New_Attrs = [exmpp_xml:xmlnattribute()]

Set the sender and the recipient at the same time.

If Sender is set to undefined, the sender is removed. If Recipient is set to undefined, the recipient is removed.

set_lang/2

set_lang(Xmlel::Stanza, Lang) -> New_Stanza

Stanza = exmpp_xml:xmlel() | exmpp_iq:iq()
Lang = binary() | string() | undefined
New_Stanza = exmpp_xml:xmlel() | exmpp_iq:iq()

Set the lang.

If Lang is undefined or empty, it's removed.

set_lang_in_attrs/2

set_lang_in_attrs(Attrs, Lang) -> New_Attrs

Attrs = [exmpp_xml:xmlattr()]
Lang = binary() | string() | undefined
Attrs = [exmpp_xml:xmlattr()]

Set the lang.

If Lang is undefined or empty, it's removed.

set_recipient/2

set_recipient(Xmlel::Stanza, Recipient) -> New_Stanza

Stanza = exmpp_xml:xmlel()
Recipient = exmpp_jid:jid() | binary() | string() | undefined
New_Stanza = exmpp_xml:xmlel()

Set the recipient.

If Recipient is set to undefined, the recipient is removed.

set_recipient_in_attrs/2

set_recipient_in_attrs(Attrs, Recipient) -> New_Attrs

Attrs = [exmpp_xml:xmlattr()]
Recipient = exmpp_jid:jid() | binary() | string() | undefined
New_Attrs = [exmpp_xml:xmlnattribute()]

Set the recipient.

If Recipient is set to undefined, the recipient is removed.

set_sender/2

set_sender(Xmlel::Stanza, Sender) -> New_Stanza

Stanza = exmpp_xml:xmlel()
Sender = exmpp_jid:jid() | binary() | string() | undefined
New_Stanza = exmpp_xml:xmlel()

Set the sender.

If Sender is set to undefined, the sender is removed.

set_sender_in_attrs/2

set_sender_in_attrs(Attrs, Sender) -> New_Attrs

Attrs = [exmpp_xml:xmlattr()]
Sender = exmpp_jid:jid() | binary() | string() | undefined
New_Attrs = [exmpp_xml:xmlattr()]

Set the sender.

If Sender is set to undefined, the sender is removed.

set_type/2

set_type(Xmlel::Stanza, Type) -> New_Stanza

Stanza = exmpp_xml:xmlel() | exmpp_iq:iq()
Type = atom() | binary() | string()
New_Stanza = exmpp_xml:xmlel() | exmpp_iq:iq()

Set the type of the stanza.

set_type_in_attrs/2

set_type_in_attrs(Attrs, Type) -> New_Attrs

Attrs = [exmpp_xml:xmlattr()]
Type = atom() | binary() | string()
New_Attrs = [exmpp_xml:xmlattr()]

Set the type of the stanza.

stanza_error/2

stanza_error(Stanza, Error) -> Stanza_Error

Stanza = exmpp_xml:xmlel()
Error = exmpp_xml:xmlel()
Stanza_Error = exmpp_xml:xmlel()

Transform Stanza in a stanza error.

The type attribute is set and an error condition is added. The caller is still responsible to set or modify the to attribute correctly.

See also: error/2, error/3.

stanza_error_without_original/2

stanza_error_without_original(Stanza, Error) -> Stanza_Error

Stanza = exmpp_xml:xmlel()
Error = exmpp_xml:xmlel()
Stanza_Error = exmpp_xml:xmlel()

Transform Stanza in a stanza error.

Previous child elements from Stanza are not kept.

See also: stanza_error/2.

to_binary/1

to_binary(El) -> XML_Text

El = exmpp_xml:xmlel() | exmpp_iq:iq() | list()
XML_Text = binary()

Serialize a stanza using common XMPP default namespaces.

This function calls to_binary/2 with Default_NS set to

[?NS_JABBER_CLIENT, ?NS_JABBER_SERVER, ?NS_COMPONENT_ACCEPT,
  ?NS_COMPONENT_CONNECT]

to_binary/2

to_binary(El, Default_NS) -> XML_Text

El = exmpp_xml:xmlel() | exmpp_iq:iq() | list()
Default_NS = NS | Equivalent_NSs
NS = atom() | string()
Equivalent_NSs = [NS]
XML_Text = binary()

Serialize a stanza using the given default namespace.

The XMPP namespace http://etherx.jabber.org/streams and the Server Dialback jabber:server:dialback are included as a prefixed namespace, with the stream prefix.

to_binary/3

to_binary(Iq::El, Default_NS, Prefixed_NS::Prefix) -> XML_Text

El = exmpp_xml:xmlel() | exmpp_iq:iq() | list()
Default_NS = [NS]
Prefixed_NS = [{NS, Prefix}]
NS = atom() | string()
Prefix = string()
XML_Text = binary()

Serialize a stanza using the given namespaces.

To understand Default_NS, see exmpp_xml:xmlel_to_xmlelement/3.

to_iolist/1

to_iolist(El) -> XML_Text

El = exmpp_xml:xmlel() | exmpp_iq:iq() | list()
XML_Text = iolist()

Serialize a stanza using common XMPP default namespaces.

This function calls to_iolist/2 with Default_NS set to

[?NS_JABBER_CLIENT, ?NS_JABBER_SERVER, ?NS_COMPONENT_ACCEPT,
  ?NS_COMPONENT_CONNECT]

to_iolist/2

to_iolist(El, Default_NS) -> XML_Text

El = exmpp_xml:xmlel() | exmpp_iq:iq() | list()
Default_NS = NS | Equivalent_NSs
NS = atom() | string()
Equivalent_NSs = [NS]
XML_Text = iolist()

Serialize a stanza using the given default namespace.

The XMPP namespace http://etherx.jabber.org/streams and the Server Dialback jabber:server:dialback are included as a prefixed namespace, with the stream prefix.

to_iolist/3

to_iolist(Iq::El, Default_NS, Prefixed_NS::Prefix) -> XML_Text

El = exmpp_xml:xmlel() | exmpp_iq:iq() | list()
Default_NS = [NS]
Prefixed_NS = [{NS, Prefix}]
NS = atom() | string()
Prefix = string()
XML_Text = iolist()

Serialize a stanza using the given namespaces.

To understand Default_NS, see exmpp_xml:xmlel_to_xmlelement/3.

to_list/1

to_list(El) -> XML_Text

El = exmpp_xml:xmlel() | exmpp_iq:iq() | list()
XML_Text = string()

Serialize a stanza using common XMPP default namespaces.

This function calls to_list/2 with Default_NS set to

[?NS_JABBER_CLIENT, ?NS_JABBER_SERVER, ?NS_COMPONENT_ACCEPT,
  ?NS_COMPONENT_CONNECT]

to_list/2

to_list(El, Default_NS) -> XML_Text

El = exmpp_xml:xmlel() | exmpp_iq:iq() | list()
Default_NS = NS | Equivalent_NSs
NS = atom() | string()
Equivalent_NSs = [NS]
XML_Text = string()

Serialize a stanza using the given default namespace.

The XMPP namespace http://etherx.jabber.org/streams and the Server Dialback jabber:server:dialback are included as a prefixed namespace, with the stream prefix.

to_list/3

to_list(Iq::El, Default_NS, Prefixed_NS::Prefix) -> XML_Text

El = exmpp_xml:xmlel() | exmpp_iq:iq() | list()
Default_NS = [NS]
Prefixed_NS = [{NS, Prefix}]
NS = atom() | string()
Prefix = string()
XML_Text = string()

Serialize a stanza using the given namespaces.

To understand Default_NS, see exmpp_xml:xmlel_to_xmlelement/3.

Generated by EDoc, Feb 19 2012, 12:53:55.