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_field()

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

pubsub_node_name()

pubsub_node_name() = binary() | undefined

Function Index

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

Function Details

create_node/2

create_node(Id::binary(), Node::pubsub_node_name()) -> exml:element()

create_node/3

create_node(Id::binary(), NodeName::pubsub_node_name(), ConfigFields::[form_field()] | undefined) -> exml:element()

delete_node/2

delete_node(Id::binary(), NodeName::pubsub_node_name()) -> exml:element()

discover_nodes/2

discover_nodes(Id::binary(), NodeName::pubsub_node_name()) -> exml:element()

get_affiliations/2

get_affiliations(Id::binary(), NodeName::pubsub_node_name()) -> exml:element()

get_all_items/2

get_all_items(Id::binary(), NodeName::pubsub_node_name()) -> exml:element()

get_configuration/2

get_configuration(Id::binary(), NodeName::pubsub_node_name()) -> exml:element()

get_default_configuration/1

get_default_configuration(Id::binary()) -> exml:element()

get_item/3

get_item(Id::binary(), ItemId::binary(), NodeName::pubsub_node_name()) -> exml:element()

get_items/3

get_items(Id::binary(), NodeName::pubsub_node_name(), MaxItems::pos_integer()) -> exml:element()

get_node_subscriptions/2

get_node_subscriptions(Id::binary(), NodeName::pubsub_node_name()) -> exml:element()

get_pending_subscriptions/2

get_pending_subscriptions(Id::binary(), NodeName::pubsub_node_name()) -> exml:element()

get_subscription_options/3

get_subscription_options(User::escalus_utils:jid_spec(), Id::binary(), NodeName::pubsub_node_name()) -> exml:element()

get_user_subscriptions/2

get_user_subscriptions(Id::binary(), NodeName::pubsub_node_name()) -> exml:element()

iq/3

iq(Type::binary(), Id::binary(), Elements::[exml:cdata() | exml:element()]) -> exml:element()

publish/2

publish(Id::binary(), Node::pubsub_node_name()) -> exml:element()

publish/3

publish(ContentElement::exml:element(), Id::binary(), Node::pubsub_node_name()) -> exml:element()

publish/4

publish(ItemId::binary() | undefined, ContentElement::exml:element(), Id::binary(), Node::pubsub_node_name()) -> exml:element()

publish_raw/3

publish_raw(Children::[exml:element()], Id::binary(), NodeName::pubsub_node_name()) -> exml:element()

publish_with_options/3

publish_with_options(Id::binary(), Node::pubsub_node_name(), PublishOptions::[form_field()] | undefined) -> exml:element()

publish_with_options/4

publish_with_options(ContentElement::exml:element(), Id::binary(), Node::pubsub_node_name(), PublishOptions::[form_field()] | undefined) -> exml:element()

publish_with_options/5

publish_with_options(ItemId::binary() | undefined, ContentElement::exml:element(), Id::binary(), NodeName::pubsub_node_name(), PublishOptions::[form_field()] | undefined) -> exml:element()

pubsub_iq/3

pubsub_iq(Type::binary(), Id::binary(), Elements::[exml:cdata() | exml:element()]) -> exml:element()

pubsub_iq/4

pubsub_iq(Type::binary(), Id::binary(), Elements::[exml:cdata() | exml:element()], NS::binary()) -> exml:element()

pubsub_owner_iq/3

pubsub_owner_iq(Type::binary(), Id::binary(), Elements::[exml:cdata() | exml:element()]) -> exml:element()

purge_all_items/2

purge_all_items(Id::binary(), NodeName::pubsub_node_name()) -> exml:element()

retract/4

retract(Id::binary(), NodeName::pubsub_node_name(), ItemId::binary(), Attrs::exml:attrs()) -> exml:element()

set_affiliations/3

set_affiliations(Id::binary(), NodeName::pubsub_node_name(), AffChange::[{escalus_utils:jid_spec(), binary()}]) -> exml:element()

set_configuration/3

set_configuration(Id::binary(), NodeName::pubsub_node_name(), ConfigFields::[form_field()] | undefined) -> exml:element()

set_subscription_options/4

set_subscription_options(User::escalus_utils:jid_spec(), Id::binary(), NodeName::pubsub_node_name(), Options::[form_field()] | undefined) -> exml:element()

set_subscriptions/3

set_subscriptions(Id::binary(), Subscriptions::[{escalus_utils:jid_spec(), binary()}], NodeName::pubsub_node_name()) -> exml:element()

submit_subscription_response/2

submit_subscription_response(Id::binary(), Form::[form_field()]) -> exml:element()

subscribe/3

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

subscribe/4

subscribe(User::escalus_utils:jid_spec(), Id::binary(), NodeName::pubsub_node_name(), ConfigFields::[form_field()] | undefined) -> exml:element()

unsubscribe/3

unsubscribe(User::escalus_utils:jid_spec(), Id::binary(), NodeName::pubsub_node_name()) -> exml:element()


Generated by EDoc