ChatLog class documentation

Authors

Generated by root

Software documentation for the ChatLog class

ChatLog : NSObject

Declared in:
ChatLog.h
A class encapsulating the log of an XMPP chat. The current implementation logs to a series of RTF files (one per day per user) in a directory structure that mimics the roster.

Instance Variables

Method summary

chatLogWithPerson: 

+ (id) chatLogWithPerson: (JabberPerson*)person;
Returns a ChatLog for the specified person.

logPath 

+ (NSString*) logPath;
Returns the root path from which all logs will be stored.

setLogBasePath: 

+ (void) setLogBasePath: (NSString*)_path;
Sets the base path in which log files are created. This method should not be called after the creation of any ChatLog objects. The behaviour in this case is undefined.

getLogForToday 

- (id) getLogForToday;
Returns a copy of the log for today. Used typically for a client to re-load previous conversations from the same day after exiting.

initWithPerson: 

- (id) initWithPerson: (JabberPerson*)person;
Initialises the chat log for a specific person.

logMessage: 

- (id) logMessage: (Message*)aMessage;
Logs the given message.

save 

- (BOOL) save;
Forces the log to be flushed to disk. If not called, the log will be flushed periodically.



Instance Variables for ChatLog Class

autoSaveTimer

@protected NSTimer* autoSaveTimer;
Description forthcoming.

isXML

@protected BOOL isXML;
Description forthcoming.

log

@protected id log;
Description forthcoming.

logFileName

@protected NSString* logFileName;
Description forthcoming.

remoteEntity

@protected JabberPerson* remoteEntity;
Description forthcoming.

today

@protected NSCalendarDate* today;
Description forthcoming.