Module exmpp_presence

Description
Function Index
Function Details

The module exmpp_presence provides helpers to do presence common operations.

Authors: Jean-SÃ©bastien PÃ©dron (js.pedron@meetic-corp.com).

Description

The module exmpp_presence provides helpers to do presence common operations.

Function Index

available/0	Create a presence stanza to tell that the sender is available.
error/2	Prepare a presence stanza to notify an error.
get_priority/1	Return the priority attribute of the presence.
get_show/1	Return the show attribute of the presence.
get_status/1	Return the status attribute of the presence.
get_type/1	Return the type of the given presence stanza.
is_presence/1	Tell if `El` is a presence.
presence/2	Create a presence stanza with given type and status.
probe/0	Create a probe presence stanza.
set_priority/2	Set the `<priority/>` field of a presence stanza.
set_show/2	Set the `<show/>` field of a presence stanza.
set_status/2	Set the `<status/>` field of a presence stanza.
set_type/2	Set the type of the given presence stanza.
subscribe/0	Create a presence stanza to tell that the sender wants to subscribe to the receiver's presence.
subscribed/0	Create a presence stanza to tell that the receiver was subscribed from the sender's presence.
unavailable/0	Create a presence stanza to tell that the sender is not available.
unsubscribe/0	Create a presence stanza to tell that the sender wants to unsubscribe to the receiver's presence.
unsubscribed/0	Create a presence stanza to tell that the receiver was unsubscribed from the sender's presence.

Function Details

available/0

available() -> Presence

Presence = exmpp_xml:xmlel()

Create a presence stanza to tell that the sender is available.

error/2

error(Presence, Condition::Error) -> New_Presence

Presence = exmpp_xml:xmlel()
Error = exmpp_xml:xmlel() | atom()
New_Presence = exmpp_xml:xmlel()

Prepare a presence stanza to notify an error.

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

get_priority/1

get_priority(Xmlel::Presence) -> Priority

Presence = exmpp_xml:xmlel()
Priority = integer()

Return the priority attribute of the presence.

get_show/1

get_show(Xmlel::Presence) -> Show | undefined

Presence = exmpp_xml:xmlel()
Show = online | away | chat | dnd | xa | undefined

Return the show attribute of the presence.

get_status/1

get_status(Xmlel::Presence) -> Status | undefined

Presence = exmpp_xml:xmlel()
Status = binary()

Return the status attribute of the presence.

get_type/1

get_type(Presence) -> Type

Presence = exmpp_xml:xmlel()
Type = available | unavailable | subscribe | subscribed | unsubscribe | unsubscribed | probe | error | undefined

Return the type of the given presence stanza.

is_presence/1

is_presence(Presence::El) -> bool

El = exmpp_xml:xmlel()

Tell if El is a presence.

You should probably use the IS_PRESENCE(El) guard expression.

presence/2

presence(Type, Status) -> Presence

Type = available | unavailable | subscribe | subscribed | unsubscribe | unsubscribed | probe | error
Status = string() | binary()
Presence = exmpp_xml:xmlel()

Create a presence stanza with given type and status.

probe/0

probe() -> Presence

Presence = exmpp_xml:xmlel()

Create a probe presence stanza.

set_priority/2

set_priority(Xmlel::Presence, Priority) -> New_Presence

Presence = exmpp_xml:xmlel()
Priority = integer()
New_Presence = exmpp_xml:xmlel()

Set the <priority/> field of a presence stanza.

set_show/2

set_show(Xmlel::Presence, Show) -> New_Presence

Presence = exmpp_xml:xmlel()
Show = online | away | chat | dnd | xa | binary() | string()
New_Presence = exmpp_xml:xmlel()

Set the <show/> field of a presence stanza.

If Type is an empty string or the atom online, the <show/> element is removed.

set_status/2

set_status(Xmlel::Presence, Status) -> New_Presence

Presence = exmpp_xml:xmlel()
Status = string() | binary()
New_Presence = exmpp_xml:xmlel()

Set the <status/> field of a presence stanza.

If Status is an empty string (or an empty binary), the previous status is removed.

set_type/2

set_type(Presence, Type) -> New_Presence

Presence = exmpp_xml:xmlel()
Type = available | unavailable | subscribe | subscribed | unsubscribe | unsubscribed | probe | error | binary() | string()
New_Presence = exmpp_xml:xmlel()

Set the type of the given presence stanza.

subscribe/0

subscribe() -> Presence

Presence = exmpp_xml:xmlel()

Create a presence stanza to tell that the sender wants to subscribe to the receiver's presence.

subscribed/0

subscribed() -> Presence

Presence = exmpp_xml:xmlel()

Create a presence stanza to tell that the receiver was subscribed from the sender's presence.

unavailable/0

unavailable() -> Presence

Presence = exmpp_xml:xmlel()

Create a presence stanza to tell that the sender is not available.

unsubscribe/0

unsubscribe() -> Presence

Presence = exmpp_xml:xmlel()

Create a presence stanza to tell that the sender wants to unsubscribe to the receiver's presence.

unsubscribed/0

unsubscribed() -> Presence

Presence = exmpp_xml:xmlel()

Create a presence stanza to tell that the receiver was unsubscribed from the sender's presence.

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