Module exmpp_client_pubsub

Authors: Jean-Sébastien Pédron (js.pedron@meetic-corp.com), Karim Gemayel (kgemayel@process-one.net).

Function Index

create_and_configure_node/3Make an <iq> for creating a node on a pubsub service with configuration.
create_and_configure_node/4Make an <iq> for creating a node on a pubsub service with configuration.
create_instant_node/1Make an <iq> for creating an instant node on a pubsub service.
create_instant_node/2Make an <iq> for creating an instant node on a pubsub service.
create_node/2Make an <iq> for creating a node on a pubsub service.
create_node/3Make an <iq> for creating a node on a pubsub service.
delete_node/2Make an <iq> for deleting a node on a pubsub service.
delete_node/3Make an <iq> for deleting a node on a pubsub service.
get_affiliations/1Make an <iq> for retrieving user affiliations.
get_affiliations/2Make an <iq> for retrieving user affiliations.
get_default_configuration/1Make an <iq> for getting default configuration options.
get_default_configuration/2Make an <iq> for getting default configuration options.
get_items/2Make an <iq> for retrieving pubsub items.
get_items/3Make an <iq> for retrieving pubsub items.
get_items_by_id/3Make an <iq> for retrieving pubsub items by id.
get_items_by_id/4Make an <iq> for retrieving pubsub items by id.
get_items_max/3Make an <iq> for retrieving pubsub 'n' items.
get_items_max/4Make an <iq> for retrieving pubsub 'n' items.
get_node_configuration/2Make an <iq> for retrieving default configuration options.
get_node_configuration/3Make an <iq> for retrieving default configuration options.
get_owner_affiliations/2Make an <iq> for getting list of affiliations.
get_owner_affiliations/3Make an <iq> for getting list of affiliations.
get_owner_subscriptions/2Make an <iq> for retrieving list of subscriptions.
get_owner_subscriptions/3Make an <iq> for retrieving list of subscriptions.
get_subscriptions/1Make an <iq> for retrieving user subscriptions.
get_subscriptions/2Make an <iq> for retrieving user subscriptions.
get_subscriptions_options/3Make an <iq> for retrieving subscriptions options.
get_subscriptions_options/4Make an <iq> for retrieving subscriptions options.
publish/2Make an <iq> for publishing an item to a node on a pubsub service as PEP (i.e.
publish/3Make an <iq> for publishing an item to a node on a pubsub service.
publish/4Make an <iq> for creating a node on a pubsub service.
purge_items/2Make an <iq> for purging all items from a pubsub node.
purge_items/3Make an <iq> for purging all items from a pubsub node.
retract/3Make an <iq> for deleting a pubsub item.
retract/4Make an <iq> for deleting a pubsub item.
set_node_configuration/3Make an <iq> for setting configuration options.
set_node_configuration/4Make an <iq> for setting configuration options.
set_owner_affiliations/3Make an <iq> for setting list of affiliations.
set_owner_affiliations/4Make an <iq> for setting list of affiliations.
set_owner_subscriptions/3Make an <iq> for setting list of subscriptions.
set_owner_subscriptions/4Make an <iq> for setting list of subscriptions.
set_subscriptions_options/4Make an <iq> for retrieving subscriptions options.
set_subscriptions_options/5Make an <iq> for retrieving subscriptions options.
subscribe/3Make an <iq> for subscribing to a node on a pubsub service.
subscribe/4Make an <iq> for creating a node on a pubsub service.
subscribe_and_configure/4Make an <iq> for retrieving subscriptions options.
subscribe_and_configure/5Make an <iq> for retrieving subscriptions options.
unsubscribe/3Make an <iq> for unsubscribing from a node on a pubsub service.
unsubscribe/4Make an <iq> for unsubscribing from a node on a pubsub service.

Function Details

create_and_configure_node/3

create_and_configure_node(Service, Node, Options) -> Pubsub_Iq

Make an <iq> for creating a node on a pubsub service with configuration.

The stanza id is generated automatically.

create_and_configure_node/4

create_and_configure_node(Id, Service, Node, Options) -> Pubsub_Iq

Make an <iq> for creating a node on a pubsub service with configuration.

create_instant_node/1

create_instant_node(Service) -> Pubsub_Iq

Make an <iq> for creating an instant node on a pubsub service.

The stanza id is generated automatically.

create_instant_node/2

create_instant_node(Id, Service) -> Pubsub_Iq

Make an <iq> for creating an instant node on a pubsub service.

create_node/2

create_node(Service, Node) -> Pubsub_Iq

Make an <iq> for creating a node on a pubsub service.

The stanza id is generated automatically.

create_node/3

create_node(Id, Service, Node) -> Pubsub_Iq

Make an <iq> for creating a node on a pubsub service.

delete_node/2

delete_node(Service, Node) -> Pubsub_Iq

Make an <iq> for deleting a node on a pubsub service.

The stanza id is generated automatically.

delete_node/3

delete_node(Id, Service, Node) -> Pubsub_Iq

Make an <iq> for deleting a node on a pubsub service.

get_affiliations/1

get_affiliations(Service) -> Pubsub_Iq

Make an <iq> for retrieving user affiliations.

The stanza id is generated automatically.

get_affiliations/2

get_affiliations(Id, Service) -> Pubsub_Iq

Make an <iq> for retrieving user affiliations.

get_default_configuration/1

get_default_configuration(Service) -> Pubsub_Iq

Make an <iq> for getting default configuration options.

The stanza id is generated automatically.

get_default_configuration/2

get_default_configuration(Id, Service) -> Pubsub_Iq

Make an <iq> for getting default configuration options.

get_items/2

get_items(Service, Node) -> Pubsub_Iq

Make an <iq> for retrieving pubsub items.

The stanza id is generated automatically.

get_items/3

get_items(Id, Service, Node) -> Pubsub_Iq

Make an <iq> for retrieving pubsub items.

get_items_by_id/3

get_items_by_id(Service, Node, ItemsID) -> Pubsub_Iq

Make an <iq> for retrieving pubsub items by id.

The stanza id is generated automatically.

get_items_by_id/4

get_items_by_id(Id, Service, Node, ItemsID) -> Pubsub_Iq

Make an <iq> for retrieving pubsub items by id.

get_items_max/3

get_items_max(Service, Node, Max) -> Pubsub_Iq

Make an <iq> for retrieving pubsub 'n' items.

The stanza id is generated automatically.

get_items_max/4

get_items_max(Id, Service, Node, Max) -> Pubsub_Iq

Make an <iq> for retrieving pubsub 'n' items.

get_node_configuration/2

get_node_configuration(Service, Node) -> Pubsub_Iq

Make an <iq> for retrieving default configuration options.

The stanza id is generated automatically.

get_node_configuration/3

get_node_configuration(Id, Service, Node) -> Pubsub_Iq

Make an <iq> for retrieving default configuration options.

get_owner_affiliations/2

get_owner_affiliations(Service, Node) -> Pubsub_Iq

Make an <iq> for getting list of affiliations.

The stanza id is generated automatically.

get_owner_affiliations/3

get_owner_affiliations(Id, Service, Node) -> Pubsub_Iq

Make an <iq> for getting list of affiliations.

get_owner_subscriptions/2

get_owner_subscriptions(Service, Node) -> Pubsub_Iq

Make an <iq> for retrieving list of subscriptions.

The stanza id is generated automatically.

get_owner_subscriptions/3

get_owner_subscriptions(Id, Service, Node) -> Pubsub_Iq

Make an <iq> for retrieving list of subscriptions.

get_subscriptions/1

get_subscriptions(Service) -> Pubsub_Iq

Make an <iq> for retrieving user subscriptions.

The stanza id is generated automatically.

get_subscriptions/2

get_subscriptions(Id, Service) -> Pubsub_Iq

Make an <iq> for retrieving user subscriptions.

get_subscriptions_options/3

get_subscriptions_options(From, Service, Node) -> Pubsub_Iq

Make an <iq> for retrieving subscriptions options.

The stanza id is generated automatically.

get_subscriptions_options/4

get_subscriptions_options(Id, From, Service, Node) -> Pubsub_Iq

Make an <iq> for retrieving subscriptions options.

publish/2

publish(Node, Item_Children::Items) -> Pubsub_Iq

Make an <iq> for publishing an item to a node on a pubsub service as PEP (i.e. without 'to' and 'from').

The stanza id is generated automatically.

publish/3

publish(Service, Node, Item_Child::Items) -> Pubsub_Iq

Make an <iq> for publishing an item to a node on a pubsub service.

The stanza id is generated automatically.

publish/4

publish(Id, Service, Node, Item_Child::Items) -> Pubsub_Iq

Make an <iq> for creating a node on a pubsub service.

purge_items/2

purge_items(Service, Node) -> Pubsub_Iq

Make an <iq> for purging all items from a pubsub node.

The stanza id is generated automatically.

purge_items/3

purge_items(Id, Service, Node) -> Pubsub_Iq

Make an <iq> for purging all items from a pubsub node.

retract/3

retract(Service, Node, ItemID) -> Pubsub_Iq

Make an <iq> for deleting a pubsub item.

The stanza id is generated automatically.

retract/4

retract(Id, Service, Node, ItemID) -> Pubsub_Iq

Make an <iq> for deleting a pubsub item.

set_node_configuration/3

set_node_configuration(Service, Node, Options) -> Pubsub_Iq

Make an <iq> for setting configuration options.

The stanza id is generated automatically.

set_node_configuration/4

set_node_configuration(Id, Service, Node, Options) -> Pubsub_Iq

Make an <iq> for setting configuration options.

set_owner_affiliations/3

set_owner_affiliations(Service, Node, Affiliates) -> Pubsub_Iq

Make an <iq> for setting list of affiliations.

The stanza id is generated automatically.

set_owner_affiliations/4

set_owner_affiliations(Id, Service, Node, Affiliates) -> Pubsub_Iq

Make an <iq> for setting list of affiliations.

set_owner_subscriptions/3

set_owner_subscriptions(Service, Node, Subscribers) -> Pubsub_Iq

Make an <iq> for setting list of subscriptions.

The stanza id is generated automatically.

set_owner_subscriptions/4

set_owner_subscriptions(Id, Service, Node, Subscribers) -> Pubsub_Iq

Make an <iq> for setting list of subscriptions.

set_subscriptions_options/4

set_subscriptions_options(From, Service, Node, DataForm) -> Pubsub_Iq

Make an <iq> for retrieving subscriptions options.

The stanza id is generated automatically.

set_subscriptions_options/5

set_subscriptions_options(Id, From, Service, Node, DataForm) -> Pubsub_Iq

Make an <iq> for retrieving subscriptions options.

subscribe/3

subscribe(From, Service, Node) -> Pubsub_Iq

Make an <iq> for subscribing to a node on a pubsub service.

The stanza id is generated automatically.

subscribe/4

subscribe(Id, From, Service, Node) -> Pubsub_Iq

Make an <iq> for creating a node on a pubsub service.

subscribe_and_configure/4

subscribe_and_configure(From, Service, Node, DataForm) -> Pubsub_Iq

Make an <iq> for retrieving subscriptions options.

The stanza id is generated automatically.

subscribe_and_configure/5

subscribe_and_configure(Id, From, Service, Node, DataForm) -> Pubsub_Iq

Make an <iq> for retrieving subscriptions options.

unsubscribe/3

unsubscribe(From, Service, Node) -> Pubsub_Iq

Make an <iq> for unsubscribing from a node on a pubsub service.

The stanza id is generated automatically.

unsubscribe/4

unsubscribe(Id, From, Service, Node) -> Pubsub_Iq

Make an <iq> for unsubscribing from a node on a pubsub service.


Generated by EDoc, Jan 21 2011, 01:43:54.