Class Xmpp4Js.Roster.RosterItemManager

map

Xmpp4Js.Roster.RosterEntry Array of Xmpp4Js.Roster.RosterEntry. map

organized by jid, including resource

Xmpp4Js.Roster.RosterItemManager

Xmpp4Js.Roster.RosterItemManager()

get

 get(jid)

Get a roster entry by JID. Roster entries are not stored by resource, so it is always stripped to a bare JID.

Parameters:
String or Xmpp4Js.Jid jid

Returns:
Xmpp4Js.Roster.RosterEntry

getGroup

 getGroup(name)

Get a roster group by name. See documentation on return type for exact details.

Parameters:
String name - The name of the group

Returns:
Xmpp4Js.Roster.RosterGroup

getGroups

 getGroups()

Get an array of all groups

Returns:
Xmpp4Js.Roster.RosterGroup[] an array of Groups

getUnfiledContacts

 getUnfiledContacts()

Get the special unfiled contacts group, and all entries that are not in any group.

Returns:
Xmpp4Js.Roster.RosterGroup

remove

remove(jid)

Remove a contact from the roster. Fires the remove event and deletes the entry from the local map.

Parameters:
jid

rosterPacketListener

rosterPacketListener(packet)

Listens for regular roster packets and calls update as needed. FIXME This must be manually added to a connection.

Parameters:
Xmpp4Js.Packet.IQ packet - Could be class of roster packet.

rosterSubSyncPacketListener

rosterSubSyncPacketListener(packet)

Listens for roster information from legacy services. That is, these items exist on a transport's legacy roster but not necessarily in this account's native jabber roster. Calls update as needed. FIXME This must be manually added to a connection. See this document: http://delx.net.au/projects/pymsnt/jep/roster-subsync/

Parameters:
Xmpp4Js.Packet.IQ packet - Could be class of roster packet.

update

update(jid, alias, subscription, ask, groups)

Fires events after add/modify and before delete. Items are stored without taking resource into account.

Parameters:
String or Xmpp4Js.Jid jid
String alias
String subscription
String ask
String Array groups