Module escalus_pubsub_stanza

Stanzas for testing XEP-0060 PubSub.

Copyright © (C) 2016, Erlang Solutions Ltd.

Description

Stanzas for testing XEP-0060 PubSub

Data Types

form()

form() = [form_field()]

form_field()

form_field() = {Var::binary(), Value::binary()} | {Var::binary(), Type::binary(), Value::binary()}

publish_options()

publish_options() = [{binary(), binary()}]

pubsub_node_id()

pubsub_node_id() = {pep | binary(), binary()}

Function Index

create_node/3
create_node/4
delete_node/3
discover_nodes/3
get_affiliations/3
get_all_items/3
get_configuration/3
get_item/4
get_items/4
get_node_subscriptions/3
get_pending_subscriptions/3
get_subscription_options/3
get_user_subscriptions/3
iq/5
publish/3
publish/4
publish/5
publish_with_options/4
publish_with_options/5
publish_with_options/6
pubsub_iq/5
pubsub_owner_iq/5
purge_all_items/3
retract/4
set_affiliations/4
set_configuration/4
set_subscription_options/4
set_subscriptions/4
submit_subscription_response/4
subscribe/3
subscribe/4
unsubscribe/3

Function Details

create_node/3

create_node(User::escalus_utils:jid_spec(), Id::binary(), Node::pubsub_node_id()) -> exml:element()

create_node/4

create_node(User::escalus_utils:jid_spec(), Id::binary(), X3::pubsub_node_id(), ConfigFields::[{binary(), binary()}]) -> exml:element()

delete_node/3

delete_node(User::escalus_utils:jid_spec(), Id::binary(), X3::pubsub_node_id()) -> exml:element()

discover_nodes/3

discover_nodes(User::escalus_utils:jid_spec(), Id::binary(), NodeAddr::binary() | pubsub_node_id()) -> exml:element()

get_affiliations/3

get_affiliations(User::escalus_utils:jid_spec(), Id::binary(), X3::pubsub_node_id()) -> exml:element()

get_all_items/3

get_all_items(User::escalus_utils:jid_spec(), Id::binary(), X3::pubsub_node_id()) -> exml:element()

get_configuration/3

get_configuration(User::escalus_utils:jid_spec(), Id::binary(), X3::pubsub_node_id()) -> exml:element()

get_item/4

get_item(User::escalus_utils:jid_spec(), Id::binary(), ItemId::binary(), X4::pubsub_node_id()) -> exml:element()

get_items/4

get_items(User::escalus_utils:jid_spec(), Id::binary(), X3::pubsub_node_id(), MaxItems::pos_integer()) -> exml:element()

get_node_subscriptions/3

get_node_subscriptions(User::escalus_utils:jid_spec(), Id::binary(), X3::pubsub_node_id()) -> exml:element()

get_pending_subscriptions/3

get_pending_subscriptions(User::escalus_utils:jid_spec(), Id::binary(), NodesAddr::pubsub_node_id() | binary()) -> exml:element()

get_subscription_options/3

get_subscription_options(User, Id, X3) -> any()

get_user_subscriptions/3

get_user_subscriptions(User::escalus_utils:jid_spec(), Id::binary(), Node::pubsub_node_id() | binary()) -> exml:element()

iq/5

iq(Type, From, Id, To, Elements) -> any()

publish/3

publish(User::escalus_utils:jid_spec(), Id::binary(), X3::pubsub_node_id()) -> exml:element()

publish/4

publish(User::escalus_utils:jid_spec(), ContentElement::exml:element(), Id::binary(), X4::pubsub_node_id()) -> exml:element()

publish/5

publish(User::escalus_utils:jid_spec(), ItemId::binary(), ContentElement::exml:element(), Id::binary(), X5::pubsub_node_id()) -> exml:element()

publish_with_options/4

publish_with_options(User::escalus_utils:jid_spec(), Id::binary(), X3::pubsub_node_id(), PublishOptions::publish_options()) -> exml:element()

publish_with_options/5

publish_with_options(User::escalus_utils:jid_spec(), ContentElement::exml:element(), Id::binary(), X4::pubsub_node_id(), PublishOptions::publish_options()) -> exml:element()

publish_with_options/6

publish_with_options(User::escalus_utils:jid_spec(), ItemId::binary(), ContentElement::exml:element(), Id::binary(), X5::pubsub_node_id(), PublishOptions::publish_options()) -> exml:element()

pubsub_iq/5

pubsub_iq(Type, User, Id, NodeAddr, Elements) -> any()

pubsub_owner_iq/5

pubsub_owner_iq(Type, User, Id, NodeAddr, Elements) -> any()

purge_all_items/3

purge_all_items(User::escalus_utils:jid_spec(), Id::binary(), X3::pubsub_node_id()) -> exml:element()

retract/4

retract(User::escalus_utils:jid_spec(), Id::binary(), X3::pubsub_node_id(), ItemId::binary()) -> exml:element()

set_affiliations/4

set_affiliations(User::escalus_utils:jid_spec(), Id::binary(), X3::pubsub_node_id(), AffChange::[{escalus_utils:jid_spec(), binary()}]) -> exml:element()

set_configuration/4

set_configuration(User::escalus_utils:jid_spec(), Id::binary(), X3::pubsub_node_id(), ConfigFields::[{binary(), binary()}]) -> exml:element()

set_subscription_options/4

set_subscription_options(User, Id, X3, Options) -> any()

set_subscriptions/4

set_subscriptions(User::escalus_utils:jid_spec(), Id::binary(), Subscriptions::[{escalus_utils:jid_spec(), binary()}], X4::pubsub_node_id()) -> exml:element()

submit_subscription_response/4

submit_subscription_response(User::escalus_utils:jid_spec(), Id::binary(), X3::pubsub_node_id(), Form::form()) -> exml:element()

subscribe/3

subscribe(User::escalus_utils:jid_spec(), Id::binary(), Node::pubsub_node_id()) -> exml:element()

subscribe/4

subscribe(User::escalus_utils:jid_spec(), Id::binary(), X3::pubsub_node_id(), ConfigFields::[{binary(), binary()}]) -> exml:element()

unsubscribe/3

unsubscribe(User::escalus_utils:jid_spec(), Id::binary(), X3::pubsub_node_id()) -> exml:element()


Generated by EDoc