Authors
- Generated by builder
-
- Declared in:
- XMPPRoster.h
- Conforms to:
- PresenceHandler
- XMPPInfoQueryStanzaHandler
The Roster class implements the roster. At the basic
level, the roster is simply a collection of people.
This class maintains the list, and allows new people to
be added and removed.
Instance Variables
Method summary
- (void)
addRosterFromQuery: (
XMPPInfoQueryStanza*)rosterQuery;
Add items to the roster from an iq with type result
containing one or more roster items.
- (void)
authorise: (
JID*)aJid;
Authorises the specified JID to add the user to
their roster.
- (id)
connection;
Returns the connection used by this roster.
- (id)
delegate;
Returns the roster's delegate.
- (
XMPPDispatcher*)
dispatcher;
Returns the dispatcher used by this roster.
- (
XMPPRosterGroup*)
groupForIndex: (int)anIndex;
Returns the group at a given index.
- (
XMPPRosterGroup*)
groupForIndex: (int)anIndex
ignoringPeopleLessOnlineThan: (unsigned int)onlineState;
Returns the group at a specified index when only
groups containing people more online than the given
onlineState value are counted.
- (
XMPPRoster*)
initWithAccount: (id)anAccount;
Initialise a roster for a specified account.
- (
NSUInteger)
numberOfGroups;
Returns the number of groups.
- (int)
numberOfGroupsContainingPeopleMoreOnlineThan: (unsigned int)onlineState;
Returns the number of groups when only groups
containing people more online than the given
onlineState value are counted.
- (void)
offline;
Takes the roster offline. This sets the presence of
all identities to unknown (since we can not be certain
of any online states while we are not on the XMPP
network).
- (
XMPPPerson*)
personForJID: (
JID*)aJid;
Returns a person for a given JID if one exists in
the roster.
- (void)
setGroup: (
NSString*)aGroup
forIdentity: (
XMPPIdentity*)anIdentity;
Moves an identity to a new group. This will cause the
identity to be assigned to a new person.
- (void)
setInitialStatus: (unsigned char)aStatus
withMessage: (
NSString*)aMessage;
Sets the initial presence. This will be the presence
when connecting is complete. It would probably be more
sensibly handled in XMPPConnection or XMPPAccount.
It is currently here so that the client can set itself
as online once the latest copy of the roster has been
received.
- (void)
setName: (
NSString*)aName
group: (
NSString*)aGroup
forIdentity: (
XMPPIdentity*)anIdentity;
Renames an identity. This will cause the identity
to be assigned to a new person.
- (void)
subscribe: (
JID*)aJid
withName: (
NSString*)aName
inGroup: (
NSString*)aGroup;
Adds the specified JID to the roster, with the given
name in the given group.
- (void)
unauthorise: (
JID*)aJid;
Remove the authorisation granted to the specified
JID. This JID will no longer receive presence stanzas
from you.
- (void)
unsubscribe: (
JID*)aJid;
Removes the specified JID from the roster.
- (void)
update: (id)anObject;
Triggers an update of the specified object in the
roster. This would be better handled by
notifications.
Instance Variables for XMPPRoster Class
@protected id account;
Description forthcoming.
@protected BOOL connected;
Description forthcoming.
@protected id connection;
Description forthcoming.
@protected id delegate;
Description forthcoming.
@protected XMPPServiceDiscovery* disco;
Description forthcoming.
@protected XMPPDispatcher* dispatcher;
Description forthcoming.
@protected NSMutableArray* groups;
Description forthcoming.
@protected NSMutableDictionary* groupsByName;
Description forthcoming.
@protected NSString* initialMessage;
Description forthcoming.
@protected unsigned char initialStatus;
Description forthcoming.
@protected NSMutableDictionary* peopleByJID;
Description forthcoming.
@protected NSMutableSet* queriedServers;
Description forthcoming.
- Declared in:
- XMPPRoster.h
Protocol to be implemented by a roster UI component.
Method summary
- (void)
update: (id)anObject;
Update the display of the specified object.