XMPPConversation class documentation

Authors

Generated by builder

Contents -

  1. Software documentation for the XMPPConversation class
  2. Software documentation for the MessageFilter protocol
  3. Software documentation for the XMPPConversationDelegate protocol

Software documentation for the XMPPConversation class

XMPPConversation : NSObject

Declared in:
XMPPConversation.h
Conforms to:
MessageHandler
The XMPPConversation class is an encapsulation of an abstract conversation. This is a dialogue between two parties; the local user and some other person. The remote person is not a client, but some abstraction of a person which may span multiple identities. The same abstraction can be used for group chats, where the remote 'person' will be the chat room, and each identity will be a user within that room.

Instance Variables

Method summary

conversationForPerson: 

+ (id) conversationForPerson: (XMPPPerson*)corespondent;
Create a new conversation with the specified person associated with the default account.

conversationWithPerson: forAccount: 

+ (id) conversationWithPerson: (XMPPPerson*)corespondent forAccount: (XMPPAccount*)_account;
Create a new conversation with the specified person, associated with a given account. If a conversation with the specified person already exists, a copy will be returned.

releaseAllXMPPConversations 

+ (void) releaseAllXMPPConversations;
Release all conversations. The class maintains a reference to all created conversations. This is used to clean-up all references. After calling this method, existing conversations should not be used; requesting a conversation may cause two conversations with the same person to exist, which could confuse the user.

setViewClass: 

+ (void) setViewClass: (Class)aClass;
Sets the class of the object used to create a view for each conversation. This should probably be moved out into the application code and removed from here.

delegate 

- (id<NSObject,XMPPConversationDelegate>) delegate;
Returns the delegate.

name 

- (NSString*) name;
Returns the name of the remote user.

objectStoreForObjectWithUUID: andApplication: 

- (XMPPObjectStore*) objectStoreForObjectWithUUID: (ETUUID*)uuid andApplication: (NSString*)registeredName;
Description forthcoming.

remoteJID 

- (JID*) remoteJID;
Returns the currently active JID of the remote party. This may change for a variety of reasons.

remotePerson 

- (XMPPPerson*) remotePerson;
Returns the remote user.

sendText: 

- (void) sendText: (id)_message;
Send a string as a message to the remote party.

setDelegate: 

- (void) setDelegate: (id<NSObject,XMPPConversationDelegate>)_delegate;
Sets the delegate.

setJID: 

- (void) setJID: (JID*)jid;
Overrides the automatic JID selection, and forces messages to be sent to that JID.



Instance Variables for XMPPConversation Class

connection

@protected XMPPConnection* connection;
Description forthcoming.

delegate

@protected id delegate;
Description forthcoming.

name

@protected NSString* name;
Description forthcoming.

remoteJID

@protected JID* remoteJID;
Description forthcoming.

remotePerson

@protected XMPPPerson* remotePerson;
Description forthcoming.




Software documentation for the MessageFilter protocol

MessageFilter

Declared in:
XMPPConversation.h
Conforms to:
NSObject
A message filter is an object that performs some modifications to a message before it is displayed.
Method summary

filterMessage: 

- (void) filterMessage: (XMPPMessage*)aMessage;
Process the message in some way. If the message should not be displayed then -setShouldDisplay:NO should be called on the message before returning.

Software documentation for the XMPPConversationDelegate protocol

XMPPConversationDelegate

Declared in:
XMPPConversation.h
Conforms to:
XMPPPresenceDisplay
The XMPPConversationDelegate formal protocol should be implemented by any user interface representing a conversation. Events in the associated conversation class will cause messages defined by this interface to be sent.
Method summary

activate: 

- (void) activate: (id)_sender;
Used to tell the UI that an event has occurred that should cause it to become visible (or some analogue of visible). (Deprecated?)

conversation: 

- (void) conversation: (id)aXMPPConversation;
Sets the conversation with which this delegate is associated.

displayMessage: incoming: 

- (void) displayMessage: (XMPPMessage*)_message incoming: (BOOL)_in;
Instructs the delegate to display a new message. The incoming parameter is used to indicate the direction of the message. Messages originating with the local user will have this set to NO, while those from outside will have it set to YES.

newRemoteJID: 

- (BOOL) newRemoteJID: (JID*)jid;
Used to indicate that the active client on the remote end has changed. This happens, for example, when the remote user switches clients. This may indicate a new resource, or an entirely new JID (for example switching from a Jabber client to a legacy client being used over a gateway).