XMPPIdentity class documentation

Authors

Generated by builder

Software documentation for the XMPPIdentity class

XMPPIdentity : ETXMLNullHandler

Declared in:
XMPPIdentity.h
A XMPPIdentity represents a unique endpoint in the Jabber network. Each person may have a collection of identities, corresponding to different client or different means of accessing them (e.g. a pure Jabber ID and a legacy-protocol gateway Jabber ID both of which are used from the same client. This abstraction allows conversations to be tied to people, rather than to clients. The roster will assume that entries in the same group with the same name correspond to the same person. Similarly, different resources of the same JID will be treated as different identities belonging to the same person.

Instance Variables

Method summary

ask 

- (NSString*) ask;
Type of subscription being requested by this contact.

compareByJID: 

- (NSComparisonResult) compareByJID: (XMPPIdentity*)_other;
Compare two identities by their JID. Commonly used to sort identities for display in a UI.

compareByPriority: 

- (NSComparisonResult) compareByPriority: (XMPPIdentity*)_other;
Compare two identities by their priority. Used to determine which should be the default recipient of messages.

group 

- (NSString*) group;
Return the roster group of the identity.

initWithJID: withName: inGroup: forPerson: 

- (id) initWithJID: (JID*)_jid withName: (NSString*)_name inGroup: (NSString*)_group forPerson: (id)_person;
Create a new identity for the specified person. The name and group should match that of the person.

jid 

- (JID*) jid;
Return the Jabber ID of the identity.

name 

- (NSString*) name;
Return the name of the identity.

person 

- (id) person;
Return the person with whom this identity is associated.

person: 

- (void) person: (id)_person;
Set the person with whom this identity is associated.

presence 

- (XMPPPresence*) presence;
Return the current presence of the identity.

priority 

- (int) priority;
Return the priority associated with the current presence of the identity.

setGroup: 

- (void) setGroup: (NSString*)aGroup;
Description forthcoming.

setName: 

- (void) setName: (NSString*)aName;
Description forthcoming.

setPresence: 

- (void) setPresence: (XMPPPresence*)_presence;
Set the presence of the identity. Used whenever a presence stanza is received.

subscription 

- (NSString*) subscription;
The type of subscription that the user has to this contact.



Instance Variables for XMPPIdentity Class

ask

@protected NSString* ask;
Description forthcoming.

basePriority

@protected int basePriority;
Description forthcoming.

group

@protected NSString* group;
Description forthcoming.

jid

@protected JID* jid;
Description forthcoming.

name

@protected NSString* name;
Description forthcoming.

person

@protected id person;
Description forthcoming.

presence

@protected XMPPPresence* presence;
Description forthcoming.

priority

@protected int priority;
Description forthcoming.

subscription

@protected NSString* subscription;
Description forthcoming.