Module mod_roster [erl svg]

build_contact_jid_td(X1::JID) -> Result

• JID = jlib:shortjid()
• Result = ejabberd_web:html()

convert_askmessage_to_exmpp(AM) -> any()

convert_jid_to_exmpp(V) -> any()

convert_name_to_exmpp(N) -> any()

convert_to_binary(A) -> any()

fill_subscription_lists(Is::Items, F, T) -> {New_F, New_T}

• Items = [rosteritem()]
• F = [jlib:shortjid()]
• T = [jlib:shortjid()]
• New_F = [jlib:shortjid()]
• New_T = [jlib:shortjid()]

get_in_pending_subscriptions(Ls, User, Server) -> New_Ls

• Ls = [exmpp_xml:xmlel()]
• User = binary()
• Server = binary()
• New_Ls = [exmpp_xml:xmlel()]

get_jid_info(X1::Ignored, User, Server, JID) -> {Subscription, Groups}

• Ignored = term()
• User = binary()
• Server = binary()
• JID = exmpp_jid:jid()
• Subscription = none | to | from | both
• Groups = [binary()]

get_roster(LUser, LServer) -> any()

get_subscription_lists(X1::Ignored, User, Server) -> Subscription_Lists

• Ignored = term()
• User = binary()
• Server = binary()
• Subscription_Lists = {F, T}
• F = [jlib:shortjid()]
• T = [jlib:shortjid()]

get_user_roster(Acc, X2::US) -> New_Acc

• Acc = [rosteritem()]
• US = {User, Server}
• User = binary()
• Server = binary()
• New_Acc = [rosteritem()]

get_versioning_feature(Acc, Host) -> any()

in_auto_reply(X1, X2, X3) -> any()

in_state_change(X1, X2, X3) -> any()

in_subscription(X1::Ignored, User, Server, JID, Type, Reason) -> bool()

• Ignored = term()
• User = binary()
• Server = binary()
• JID = exmpp_jid:jid()
• Type = subscribe | subscribed | unsubscribe | unsubscribed
• Reason = binary() | undefined

item_to_xml(Item) -> XML

• Item = rosteritem()
• XML = exmpp_xml:xmlel()

out_state_change(X1, X2, X3) -> any()

out_subscription(User, Server, JID, Type) -> bool()

• User = binary()
• Server = binary()
• JID = exmpp_jid:jid()
• Type = subscribe | subscribed | unsubscribe | unsubscribed

process_iq(From, To, IQ_Rec) -> IQ_Result

• From = exmpp_jid:jid()
• To = exmpp_jid:jid()
• IQ_Rec = exmpp_iq:iq()
• IQ_Result = exmpp_iq:iq()

process_iq_get(From, To, IQ_Rec) -> IQ_Result

• From = exmpp_jid:jid()
• To = exmpp_jid:jid()
• IQ_Rec = exmpp_iq:iq()
• IQ_Result = exmpp_iq:iq()

process_iq_set(From, To, Iq::IQ_Rec) -> IQ_Result

• From = exmpp_jid:jid()
• To = exmpp_jid:jid()
• IQ_Rec = exmpp_iq:iq()
• IQ_Result = exmpp_iq:iq()

process_item_attrs(Item, Attrs) -> New_Item

• Item = rosteritem()
• Attrs = [exmpp_xml:xmlnsattribute()]
• New_Item = rosteritem()

process_item_attrs_ws(Item, Attrs) -> New_Item

• Item = rosteritem()
• Attrs = [exmpp_xml:xmlnsattribute()]
• New_Item = rosteritem()

process_item_els(Item, Els) -> New_Item

• Item = rosteritem()
• Els = [exmpp_xml:xmlel()]
• New_Item = rosteritem()

process_item_set(From, To, Xmlel::El) -> ok

• From = exmpp_jid:jid()
• To = exmpp_jid:jid()
• El = exmpp_xml:xmlel()

process_item_set_t(LUser, LServer, Xmlel::El) -> term()

• LUser = binary()
• LServer = binary()
• El = exmpp_xml:xmlel()

process_local_iq(From, To, Iq::IQ_Rec) -> IQ_Result

• From = exmpp_jid:jid()
• To = exmpp_jid:jid()
• IQ_Rec = exmpp_iq:iq()
• IQ_Result = exmpp_iq:iq()

process_subscription(Direction, User, Server, JID1, Type, Reason) -> bool()

• Direction = in | out
• User = binary()
• Server = binary()
• JID1 = exmpp_jid:jid()
• Type = subscribe | subscribed | unsubscribe | unsubscribed
• Reason = binary() | undefined

push_item(User, Server, From, Item) -> term()

• User = binary()
• Server = binary()
• From = exmpp_jid:jid()
• Item = rosteritem()

push_item(User, Server, Resource, From, Item) -> term()

• User = binary()
• Server = binary()
• Resource = binary()
• From = exmpp_jid:jid()
• Item = rosteritem()

push_item(User, Server, Resource, From, Item, RosterVersion) -> any()

push_item_version(Server, User, From, Item, RosterVersion) -> any()

remove_user(User, Server) -> term()

• User = binary()
• Server = binary()

roster_hash(Items) -> any()

roster_version(LServer, LUser) -> any()

roster_version_on_db(Host::binary()) -> true | false

roster_versioning_enabled(Host::binary()) -> true | false

send_unsubscribing_presence(From::jid(), Item::roster()) -> ok

send_unsubscription_to_rosteritems(LUser, LServer) -> any()

set_items(User, Server, Xmlel::El) -> term()

• User = binary()
• Server = binary()
• El = exmpp_xml:xmlel()

start(Host, Opts) -> term()

• Host = string()
• Opts = list()

stop(Host) -> term()

• Host = string()

storageroster_to_roster(Rosteritem, Rostergroups) -> any()

try_process_iq_set(From, To, IQ) -> any()

update_table(HostB, Storage) -> any()

us_to_list(X1::{User, Server}) -> string()

• User = binary()
• Server = binary()

user_roster(User, Server, Query, Lang) -> Result

• User = binary()
• Server = binary()
• Query = ejabberd_http:'query'()
• Lang = string()
• Result = [ejabberd_web:html()]

user_roster_item_parse_query(User, Server, Items, Query) -> term()

• User = binary()
• Server = binary()
• Items = [rosteritem()]
• Query = ejabberd_http:'query'()

user_roster_parse_query(User, Server, Items, Query) -> ok | nothing | error

• User = binary()
• Server = binary()
• Items = [rosteritem()]
• Query = ejabberd_http:'query'()

user_roster_subscribe_jid(User, Server, JID) -> term()

• User = binary()
• Server = binary()
• JID = exmpp_jid:jid()

webadmin_page(Acc, Host, Request) -> {stop, Result} | Acc

• Acc = term()
• Host = string()
• Request = ejabberd_http:request()
• Result = [ejabberd_web:html()]

webadmin_user(Acc, User, Server, Lang) -> New_Acc

• Acc = [ejabberd_web:html()]
• User = string()
• Server = string()
• Lang = string()
• New_Acc = [ejabberd_web:html()]