| Overview |  |
attrs() = #{binary() => binary() | undefined}
caps_version() = v1 | v2
context() = [{atom(), binary() | list() | exml:element()}]
xml_snippet() = string() | binary()
adhoc_request(Node::binary()) -> exml:element()
adhoc_request(Node::binary(), Payload::[exml:cdata() | exml:element()]) -> exml:element()
auth(Mechanism::binary()) -> exml:element()
auth(Mechanism::binary(), Children::[exml:cdata() | exml:element()]) -> exml:element()
auth_response() -> exml:element()
auth_response(Children::[exml:cdata() | exml:element()]) -> exml:element()
bind(Resource::binary()) -> exml:element()
caps(HashAlg::binary(), HashValue::binary(), X3::caps_version()) -> exml:element()
caps_to_node(Xmlel::exml:element()) -> binary()
carbons_disable() -> exml:element()
carbons_enable() -> exml:element()
chat(Sender::escalus_utils:jid_spec(), Recipient::escalus_utils:jid_spec(), Msg::binary()) -> exml:element()
chat_marker(To::escalus_utils:jid_spec(), MarkerName::binary(), MessageId::binary()) -> exml:element()
chat_to(Recipient::escalus_utils:jid_spec(), Msg::binary()) -> exml:element()
chat_to_short_jid(Recipient::escalus_utils:jid_spec(), Msg::binary()) -> exml:element()
chat_to_with_id(Recipient::escalus_utils:jid_spec(), Msg::binary()) -> exml:element()
chat_to_with_id_and_timestamp(Recipient::escalus_utils:jid_spec(), Msg::binary()) -> exml:element()
chat_without_carbon_to(Recipient::escalus_utils:jid_spec(), Msg::binary()) -> exml:element()
compress(Method::binary()) -> exml:element()
disco_info(JID::escalus_utils:jid_spec()) -> exml:element()
disco_info(JID::escalus_utils:jid_spec(), Node::binary()) -> exml:element()
disco_items(JID::escalus_utils:jid_spec()) -> exml:element()
disco_items(JID::escalus_utils:jid_spec(), Node::binary()) -> exml:element()
enable_sm() -> exml:element()
enable_sm(Opts::proplists:proplist()) -> exml:element()
error_element(Type::binary(), Condition::binary()) -> exml:element()
feature(Feature::binary()) -> exml:element()
field_el(Name::binary(), Type::undefined | binary(), Values::undefined | binary() | [binary()]) -> undefined | exml:element()
from(Stanza::exml:element(), Recipient::escalus_utils:jid_spec()) -> exml:element()
An xml_snippet() is a textual representation of XML, possibly with formatting parameters (places where to insert substitutions). It may be a string() or a binary(). A parameterless snippet might look like:
<example_element/>
Snippet with formatting parameters will look like:
<example_element some_attr="{{attr_value}}"/>
Parameter names must be valid atoms, so if you want to use punctuation use single quotes:
<example_element some_attr="{{'fancy:param-name'}}"/>
If the argument you pass as the parameter value is an xmlterm() then use triple brackets at the parameter expansion site. Otherwise, the argument term will end up HTML-encoded after expansion.
<example_element>
{{{argument_will_be_xmlterm}}}
</example_element>
It's also possible to substitute whole attributes, not just their values:
<example_element {{myattr}}/>
Refer to escalus_stanza_SUITE for usage examples.
get_registration_fields() -> exml:element()
groupchat_to(Recipient::escalus_utils:jid_spec(), Msg::binary()) -> exml:element()
id() -> binary()
identity(Category::binary() | undefined, Type::binary() | undefined, Name::binary() | undefined) -> exml:element()
identity(Category::binary() | undefined, Type::binary() | undefined, Name::binary() | undefined, ExtraAttrs::#{binary() => binary()}) -> exml:element()
iq(Type::binary(), Body::[exml:cdata() | exml:element()]) -> exml:element()
iq(To::escalus_utils:jid_spec(), Type::binary(), Body::[exml:cdata() | exml:element()]) -> exml:element()
iq_get(NS::binary(), Payload::[exml:cdata() | exml:element()]) -> exml:element()
iq_result(Request::exml:element()) -> exml:element()
iq_result(Request::exml:element(), Payload::[exml:cdata() | exml:element()]) -> exml:element()
iq_set(NS::binary(), Payload::[exml:cdata() | exml:element()]) -> exml:element()
iq_set_nonquery(NS::binary(), Payload::[exml:cdata() | exml:element()]) -> exml:element()
last_activity(User::escalus_utils:jid_spec()) -> exml:element()
mam_archive_query(QueryId::binary()) -> exml:element()
mam_lookup_messages_iq(QueryId::binary(), Start::binary(), End::binary(), WithJID::binary()) -> exml:element()
mam_lookup_messages_iq(QueryId::binary(), Start::binary(), End::binary(), WithJID::binary(), Simple::term()) -> exml:element()
mam_lookup_messages_iq(QueryId::binary(), Start::binary(), End::binary(), WithJID::binary(), DirectionWMessageId::term(), Simple::boolean()) -> exml:element()
markable(Message::exml:element()) -> exml:element()
message(Text::binary(), Attrs) -> exml:element()
Attrs = #{to => escalus_utils:jid_spec(), atom() | binary() => binary()}
message(From, Recipient, Type, Msg) -> exml:element()
From = undefined | binary()Recipient = escalus_utils:jid_spec()Type = binary()Msg = binary()
ns_caps(X1::caps_version()) -> binary()
ping_request(To::escalus_utils:jid_spec()) -> exml:element()
presence(Type::binary()) -> exml:element()
presence(Type::binary(), Children::[exml:element() | exml:cdata()]) -> exml:element()
presence_direct(Recipient::escalus_utils:jid_spec(), Type::binary()) -> exml:element()
presence_direct(Client::escalus_utils:jid_spec(), Type::binary(), Body::[exml:element() | exml:cdata()]) -> exml:element()
presence_show(Show::binary()) -> exml:element()
privacy_activate(ListName::term()) -> exml:element()
privacy_deactivate() -> exml:element()
privacy_get_all() -> exml:element()
privacy_get_lists(ListNames::[term()]) -> exml:element()
privacy_list(Name::binary(), Items::[exml:cdata() | exml:element()]) -> exml:element()
privacy_list_item(Order::binary(), Action::binary(), Content::[binary()]) -> exml:element()
privacy_list_item(Order::binary(), Action::binary(), Type::binary(), Value::binary(), Content::[binary()]) -> exml:element()
privacy_list_jid_item(Order::binary(), Action::binary(), Who::escalus_utils:jid_spec(), Contents::[binary()]) -> exml:element()
privacy_no_default() -> exml:element()
privacy_set_default(ListName::term()) -> exml:element()
privacy_set_list(PrivacyList::exml:element()) -> exml:element()
private_get(NS::term(), Name::term()) -> exml:element()
private_set(Element::exml:element()) -> exml:element()
query_el(NS::binary(), Children::[exml:cdata() | exml:element()]) -> exml:element()
query_el(NS::binary(), Attrs::exml:attrs(), Children::[exml:cdata() | exml:element()]) -> exml:element()
receipt_conf(Xmlel::exml:element()) -> exml:element()
receipt_req(Xmlel::exml:element()) -> exml:element()
register_account(Body::[exml:cdata() | exml:element()]) -> exml:element()
remove_account() -> exml:element()
resume(SMID::binary(), PrevH::integer()) -> exml:element()
roster_add_contact(User::escalus_utils:jid_spec(), Groups::[binary()], Nick::binary()) -> exml:element()
roster_add_contacts(ItemSpecs::[{escalus_utils:jid_spec(), list(), binary()}]) -> exml:element()
roster_get() -> exml:element()
roster_get(Ver::binary()) -> exml:element()
roster_remove_contact(User::escalus_utils:jid_spec()) -> exml:element()
search_fields(Rest::[null | {binary(), binary()} | term()]) -> [exml:element()]
search_fields_iq(JID::escalus_utils:jid_spec()) -> exml:element()
search_iq(JID::escalus_utils:jid_spec(), Fields::[exml:cdata() | exml:element()]) -> exml:element()
service_discovery(Server::binary()) -> exml:element()
session() -> exml:element()
set_id(Stanza::exml:element(), ID::binary()) -> exml:element()
setattr(Stanza::exml:element(), Key::binary(), Val::binary()) -> exml:element()
sm_ack(H::integer()) -> exml:element()
sm_request() -> exml:element()
starttls() -> exml:element()
stream_end() -> exml_stream:stop()
stream_start(To::binary() | undefined) -> exml_stream:start()
stream_start(To::binary() | undefined, ExtraAttrs::attrs()) -> exml_stream:start()
tags(KVs::[{binary(), binary()}]) -> [exml:element()]
to(Stanza::exml:element(), Recipient::escalus_utils:jid_spec()) -> exml:element()
uuid_v4() -> binary()
vcard_request() -> exml:element()
vcard_request(JID::binary()) -> exml:element()
vcard_update(Fields::list()) -> exml:element()
vcard_update(JID::binary(), Fields::list()) -> exml:element()
ws_close() -> exml:element()
ws_close(ExtraAttrs::attrs()) -> exml:element()
ws_open(To::binary() | undefined) -> exml:element()
ws_open(To::binary() | undefined, ExtraAttrs::attrs()) -> exml:element()
x_data_form(Type::binary(), Children::[exml:cdata() | exml:element()]) -> exml:element()
Generated by EDoc