XMPPRosterGroup class documentation

Authors

Generated by builder

Software documentation for the XMPPRosterGroup class

XMPPRosterGroup : NSObject

Declared in:
XMPPRosterGroup.h
The XMPPRosterGroup class represents a group in the roster.

Instance Variables

Method summary

groupWithRoster: 

+ (id) groupWithRoster: (id)_roster;
Create a new group in the specified roster.

addIdentity: 

- (void) addIdentity: (XMPPIdentity*)_identity;
Adds a new identity to the group. This identity will either be added to an existing person, or have a new person created for it, depending on the name.

compare: 

- (NSComparisonResult) compare: (XMPPRosterGroup*)otherGroup;
Compares two roster groups by name.

groupName 

- (NSString*) groupName;
Returns the name of the group.

groupName: 

- (void) groupName: (NSString*)_name;
Set the group name.

initWithRoster: 

- (id) initWithRoster: (id)_roster;
Initialise a new group for the specified roster.

numberOfPeopleInGroupMoreOnlineThan: 

- (unsigned int) numberOfPeopleInGroupMoreOnlineThan: (unsigned int)hide;
Returns the number of people in the group who are more online than the specified value.

personAtIndex: 

- (XMPPPerson*) personAtIndex: (unsigned int)_index;
Returns the person at the specified index.

personNamed: 

- (XMPPPerson*) personNamed: (NSString*)_name;
Returns the person in the group with the specified name.

removeIdentity: 

- (void) removeIdentity: (XMPPIdentity*)_identity;
Remove the specified identity from the group. This may also remove a person from the group if the relevant person only has a single identity.



Instance Variables for XMPPRosterGroup Class

name

@protected NSString* name;
Description forthcoming.

people

@protected NSMutableArray* people;
Description forthcoming.

peopleByName

@protected NSMutableDictionary* peopleByName;
Description forthcoming.

roster

@protected id roster;
Description forthcoming.