XMPPAccount class documentation

Authors

Generated by builder

Software documentation for the XMPPAccount class

XMPPAccount : NSObject

Declared in:
XMPPAccount.h
The XMPPAccount class represents a single XMPP account. The JID is retrieved from the address book, and the password from the keychain (OS X) or user defaults (GNUstep).

Instance Variables

Method summary

setDefaultJID: 

+ (void) setDefaultJID: (JID*)aJID;
Sets the default JID (stored in address book)

setDefaultJID: withServer: 

+ (void) setDefaultJID: (JID*)aJID withServer: (NSString*)aServer;
Sets the default JID along with a server to use for connection.

connection 

- (XMPPConnection*) connection;
Returns the connection associated with the account.

initWithName: withJid: withPassword: 

- (id) initWithName: (NSString*)aName withJid: (JID*)aJid withPassword: (NSString*)aPassword;
Initialize an Account with a given Name a Jid and a password

jid 

- (JID*) jid;
Returns the JID associated with the account.

name 

- (NSString*) name;
Returns the name of the current account.

reconnect 

- (void) reconnect;
Attempt to reconnect after disconnection.

roster 

- (XMPPRoster*) roster;
Returns the roster associated with the account.



Instance Variables for XMPPAccount Class

connection

@protected XMPPConnection* connection;
Description forthcoming.

myJID

@protected JID* myJID;
Description forthcoming.

name

@protected NSString* name;
Description forthcoming.

roster

@protected XMPPRoster* roster;
Description forthcoming.