XMPPPerson class documentation

Authors

Generated by builder

Software documentation for the XMPPPerson class

XMPPPerson : NSObject

Declared in:
XMPPPerson.h
Conforms to:
PresenceHandler
XMPPInfoQueryStanzaHandler
A XMPPPerson is an abstract interface to a person on the Jabber network. A Jabber person has at least one client (JID) associated with them, in the form of an identity. The concept of a person is fairly fuzzy, but should roughly correspond to real-world people. Other unique actors in the Jabber network might also be modeled as people, for example a groupchat room could be a person and all members of it identities of that person.

Instance Variables

Method summary

personWithIdentity: forRoster: 

+ (id) personWithIdentity: (XMPPIdentity*)_identity forRoster: (id)_roster;
Instantiate a new person from an identity and associate them with a roster. Note that the XMPPIdentity class is used to parse roster items, and so it will duplicate the name and group for the person.

addIdentity: 

- (void) addIdentity: (XMPPIdentity*)anIdentity;
Add a new identity to an existing person.

avatar 

- (NSImage*) avatar;
Returns the user's avatar.

compare: 

- (NSComparisonResult) compare: (XMPPPerson*)otherPerson;
Compares two people by their name.

defaultIdentity 

- (XMPPIdentity*) defaultIdentity;
Returns the most identity that should be used to communicate with this person when none is specified by the user.

group 

- (NSString*) group;
Returns the name of the roster group containing the person.

group: 

- (void) group: (NSString*)_group;
Set the name of the roster group containing the person.

identities 

- (NSUInteger) identities;
Returns the number of identities. Deprecated (use the array directly).

identityForJID: 

- (XMPPIdentity*) identityForJID: (JID*)jid;
Returns the identity for a specified Jabber ID.

identityList 

- (NSArray*) identityList;
Returns all identities associated with this person.

initWithIdentity: forRoster: 

- (id) initWithIdentity: (XMPPIdentity*)_identity forRoster: (id)_roster;
Initialise a new person with a specified identity and roster.

name 

- (NSString*) name;
Returns the name of the person.

name: 

- (void) name: (NSString*)_name;
Sets the name of the person.

removeIdentity: 

- (void) removeIdentity: (XMPPIdentity*)_identity;
Remove an identity from an existing person.



Instance Variables for XMPPPerson Class

avatar

@protected NSImage* avatar;
Description forthcoming.

currentHash

@protected NSString* currentHash;
Description forthcoming.

group

@protected NSString* group;
Description forthcoming.

hash

@protected NSUInteger hash;
Description forthcoming.

identities

@protected NSMutableDictionary* identities;
Description forthcoming.

identityCount

@protected NSUInteger identityCount;
Description forthcoming.

identityList

@protected NSMutableArray* identityList;
Description forthcoming.

name

@protected NSString* name;
Description forthcoming.

photoHashes

@protected NSMutableDictionary* photoHashes;
Description forthcoming.

roster

@protected id roster;
Description forthcoming.

vCard

@protected ABPerson* vCard;
Description forthcoming.