Authors
- Generated by builder
-
- 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
+ (id)
conversationForPerson: (
XMPPPerson*)corespondent;
Create a new conversation with the specified person
associated with the default account.
+ (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.
+ (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.
+ (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.
- (
NSString*)
name;
Returns the name of the remote user.
- (
XMPPObjectStore*)
objectStoreForObjectWithUUID: (ETUUID*)uuid
andApplication: (
NSString*)registeredName;
Description forthcoming.
- (
JID*)
remoteJID;
Returns the currently active JID of the remote
party. This may change for a variety of reasons.
- (
XMPPPerson*)
remotePerson;
Returns the remote user.
- (void)
sendText: (id)_message;
Send a string as a message to the remote party.
- (void)
setJID: (
JID*)jid;
Overrides the automatic JID selection, and forces
messages to be sent to that JID.
Instance Variables for XMPPConversation Class
@protected XMPPConnection* connection;
Description forthcoming.
@protected id delegate;
Description forthcoming.
@protected NSString* name;
Description forthcoming.
@protected JID* remoteJID;
Description forthcoming.
@protected XMPPPerson* remotePerson;
Description forthcoming.
- 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
- (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.
- 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
- (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?)
- (void)
conversation: (id)aXMPPConversation;
Sets the conversation with which this delegate is
associated.
- (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.
- (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).