StropheCappuccino API 1.0.0
TNStropheContact Class Reference

#import <TNStropheContact.h>

List of all members.

Public Member Functions

(void) - askSubscription [implementation]
(CPImage) - avatar [implementation]
(TNStropheConnection- connection [implementation]
(id) - delegate [implementation]
(CPString) - description [implementation]
(void) - encodeWithCoder: [implementation]
(void) - freeMessagesQueue [implementation]
(void) - getMessages [implementation]
(void) - getVCard [implementation]
(CPArray) - groups [implementation]
(void) - imageDidLoad: [implementation]
(id) - initWithCoder: [implementation]
(id) - initWithConnection:JID:group: [implementation]
(TNStropheJID- JID [implementation]
(CPArray) - messagesQueue [implementation]
(CPString) - name [implementation]
(CPString) - nickname [implementation]
(CPString) - nodeName [implementation]
(CPNumber) - numberOfEvents [implementation]
(TNStropheStanza- popMessagesQueue [implementation]
(CPArray) - resources [implementation]
(void) - sendComposePaused [implementation]
(void) - sendComposing [implementation]
(void) - sendMessage: [implementation]
(void) - sendMessage:withType: [implementation]
(void) - sendStanza: [implementation]
(id) - sendStanza:andRegisterSelector:ofObject: [implementation]
(id) - sendStanza:andRegisterSelector:ofObject:handlerDelegate: [implementation]
(id) - sendStanza:andRegisterSelector:ofObject:userInfo: [implementation]
(id) - sendStanza:andRegisterSelector:ofObject:withSpecificID: [implementation]
(id) - sendStanza:andRegisterSelector:ofObject:withSpecificID:userInfo:handlerDelegate: [implementation]
(void) - sendStanza:withUserInfo: [implementation]
(void) - sendStatus: [implementation]
(void) - setAvatar: [implementation]
(void) - setConnection: [implementation]
(void) - setDelegate: [implementation]
(void) - setGroups: [implementation]
(void) - setJID: [implementation]
(void) - setMessagesQueue: [implementation]
(void) - setNickname: [implementation]
(void) - setNodeName: [implementation]
(void) - setNumberOfEvents: [implementation]
(void) - setResources: [implementation]
(void) - setStatusIcon: [implementation]
(void) - setSubscription: [implementation]
(void) - setType: [implementation]
(void) - setVCard: [implementation]
(void) - setXMPPShow: [implementation]
(void) - setXMPPStatus: [implementation]
(CPImage) - statusIcon [implementation]
(void) - subscribe [implementation]
(CPString) - subscription [implementation]
(CPString) - type [implementation]
(void) - unsubscribe [implementation]
(TNStropheVCard- vCard [implementation]
(CPString) - XMPPShow [implementation]
(CPString) - XMPPStatus [implementation]

Static Public Member Functions

(TNStropheContact+ contactWithConnection:JID:group: [implementation]
(void) + initialize [implementation]

Detailed Description

this is an implementation of a XMPP Contact

Definition at line 2 of file TNStropheContact.h.


Member Function Documentation

- (void) askSubscription [implementation]

ask subscribtion to the contact

Definition at line 355 of file TNStropheContact.j.

- (CPImage) avatar [implementation]

Synthesized accessor method.

Definition at line 759 of file TNStropheContact.j.

- (TNStropheConnection) connection [implementation]

Synthesized accessor method.

Definition at line 911 of file TNStropheContact.j.

+ (TNStropheContact) contactWithConnection: (TNStropheConnection aConnection
JID: (TNStropheJID aJID
group: (TNStropheGroup aGroup 
[implementation]

create a contact using a given connection, JID and group

Parameters:
aConnectionTNStropheConnection to use
aJIDthe JID of the contact
aGroupthe group of the contact
Returns:
an allocated and initialized TNStropheContact

Definition at line 94 of file TNStropheContact.j.

- (id) delegate [implementation]

Synthesized accessor method.

Definition at line 903 of file TNStropheContact.j.

- (CPString) description [implementation]

Definition at line 372 of file TNStropheContact.j.

- (void) encodeWithCoder: (CPCoder)  aCoder [implementation]

Definition at line 684 of file TNStropheContact.j.

- (void) freeMessagesQueue [implementation]

purge all message in queue. Will post TNStropheContactMessageTreatedNotification

Definition at line 637 of file TNStropheContact.j.

- (void) getMessages [implementation]

register the contact to listen incoming messages you should never have to use this message if you use TNStropheRoster

Definition at line 536 of file TNStropheContact.j.

- (void) getVCard [implementation]

probe the contact's vCard you should never have to use this message if you are using TNStropheRoster

Definition at line 380 of file TNStropheContact.j.

- (CPArray) groups [implementation]

Synthesized accessor method.

Definition at line 711 of file TNStropheContact.j.

- (void) imageDidLoad: (CPImage)  anImage [implementation]

this method is called when the avatar image is ready.

Parameters:
anImagethe image that sent the message

Definition at line 654 of file TNStropheContact.j.

+ (void) initialize [implementation]

Initialize the class, by creating the images

Definition at line 105 of file TNStropheContact.j.

- (id) initWithCoder: (CPCoder)  aCoder [implementation]

Definition at line 664 of file TNStropheContact.j.

- (id) initWithConnection: (TNStropheConnection aConnection
JID: (TNStropheJID aJID
group: (TNStropheGroup aGroup 
[implementation]

init a TNStropheContact with a given connection

Parameters:
aConnectionTNStropheConnection to use
Returns:
an initialized TNStropheContact

Definition at line 123 of file TNStropheContact.j.

- (TNStropheJID) JID [implementation]

Synthesized accessor method.

Definition at line 927 of file TNStropheContact.j.

- (CPArray) messagesQueue [implementation]

Synthesized accessor method.

Definition at line 727 of file TNStropheContact.j.

- (CPString) name [implementation]

Definition at line 176 of file TNStropheContact.j.

- (CPString) nickname [implementation]

Synthesized accessor method.

Definition at line 807 of file TNStropheContact.j.

- (CPString) nodeName [implementation]

Synthesized accessor method.

Definition at line 823 of file TNStropheContact.j.

- (CPNumber) numberOfEvents [implementation]

Synthesized accessor method.

Definition at line 791 of file TNStropheContact.j.

- (TNStropheStanza) popMessagesQueue [implementation]

return the last TNStropheStanza message in the message queue and remove it form the queue. Will post TNStropheContactMessageTreatedNotification.

Returns:
TNStropheStanza the last message in queue

Definition at line 617 of file TNStropheContact.j.

- (CPArray) resources [implementation]

Synthesized accessor method.

Definition at line 743 of file TNStropheContact.j.

- (void) sendComposePaused [implementation]

this allows to send "paused" information to a user.

Definition at line 328 of file TNStropheContact.j.

- (void) sendComposing [implementation]

this allows to send "composing" information to a user. This will never send "paused". you have to handle a timer if you want to automatically send pause after a while.

Definition at line 317 of file TNStropheContact.j.

- (void) sendMessage: (CPString)  aMessage [implementation]

send a message to the contact (of type chat)

Parameters:
aMessageCPString containing the message

Definition at line 585 of file TNStropheContact.j.

- (void) sendMessage: (CPString)  aMessage
withType: (CPString)  aType 
[implementation]

send a message to the contact

Parameters:
aMessageCPString containing the message
aTypeCPString containing type

Definition at line 594 of file TNStropheContact.j.

- (void) sendStanza: (TNStropheStanza aStanza [implementation]

Definition at line 432 of file TNStropheContact.j.

- (id) sendStanza: (TNStropheStanza aStanza
andRegisterSelector: (SEL)  aSelector
ofObject: (id)  anObject 
[implementation]

send a TNStropheStanza to the contact. From, ant To value are rewritten.

Parameters:
aStanzathe TNStropheStanza to send to the contact
aSelectorthe selector to perform on response
anObjectthe object receiving the selector
Returns:
the associated registration id for the selector

Definition at line 489 of file TNStropheContact.j.

- (id) sendStanza: (TNStropheStanza aStanza
andRegisterSelector: (SEL)  aSelector
ofObject: (id)  anObject
handlerDelegate: (id)  aDelegate 
[implementation]

send a TNStropheStanza to the contact. From, ant To value are rewritten.

Parameters:
aStanzathe TNStropheStanza to send to the contact
aSelectorthe selector to perform on response
anObjectthe object receiving the selector
someUserInforandom information to give to the selector
aDelegatethe handler id delegate
Returns:
the associated registration id for the selector

Definition at line 528 of file TNStropheContact.j.

- (id) sendStanza: (TNStropheStanza aStanza
andRegisterSelector: (SEL)  aSelector
ofObject: (id)  anObject
userInfo: (id)  someUserInfo 
[implementation]

send a TNStropheStanza to the contact. From, ant To value are rewritten.

Parameters:
aStanzathe TNStropheStanza to send to the contact
aSelectorthe selector to perform on response
anObjectthe object receiving the selector
someUserInforandom information to give to the selector
Returns:
the associated registration id for the selector

Definition at line 515 of file TNStropheContact.j.

- (id) sendStanza: (TNStropheStanza aStanza
andRegisterSelector: (SEL)  aSelector
ofObject: (id)  anObject
withSpecificID: (int)  anId 
[implementation]

send a TNStropheStanza to the contact. From, ant To value are rewritten.

Parameters:
aStanzathe TNStropheStanza to send to the contact
aSelectorthe selector to perform on response
anObjectthe object receiving the selector
anIdthe specific stanza ID to use
Returns:
the associated registration id for the selector

Definition at line 503 of file TNStropheContact.j.

- (id) sendStanza: (TNStropheStanza aStanza
andRegisterSelector: (SEL)  aSelector
ofObject: (id)  anObject
withSpecificID: (id)  anId
userInfo: (id)  someUserInfo
handlerDelegate: (id)  aDelegate 
[implementation]

send a TNStropheStanza to the contact. From, ant To value are rewritten. This message uses a given stanza id in order to use it if you need. You should mostly use the You should never have to use the method sendStanza:andRegisterSelector:ofObject: in most of the case

Parameters:
aStanzathe TNStropheStanza to send to the contact
aSelectorthe selector to perform on response
anObjectthe object receiving the selector
anIdthe specific stanza ID to use
someUserInforandom information to give to the selector
aDelegatethe handler id delegate
Returns:
the associated registration id for the selector

Definition at line 458 of file TNStropheContact.j.

- (void) sendStanza: (TNStropheStanza aStanza
withUserInfo: (CPDictionary)  userInfo 
[implementation]

Definition at line 437 of file TNStropheContact.j.

- (void) sendStatus: (CPString)  aStatus [implementation]

Definition at line 297 of file TNStropheContact.j.

- (void) setAvatar: (CPImage)  aValue [implementation]

Synthesized accessor method.

Definition at line 767 of file TNStropheContact.j.

- (void) setConnection: (TNStropheConnection aValue [implementation]

Synthesized accessor method.

Definition at line 919 of file TNStropheContact.j.

- (void) setDelegate: (id)  aDelegate [implementation]

Set the delegate You should not use this yourself if you are The contact is managed by a TNStropheRoster In that case, the delegate methods will be forwarded to the roster's delegate

Delegate methods

  • (CPImage)avatarForContact:(TNStropheContact)aContact Allows to return an image for teh contact if none is set in the vCard

Definition at line 164 of file TNStropheContact.j.

- (void) setGroups: (CPArray)  aValue [implementation]

Synthesized accessor method.

Definition at line 719 of file TNStropheContact.j.

- (void) setJID: (TNStropheJID aValue [implementation]

Synthesized accessor method.

Definition at line 935 of file TNStropheContact.j.

- (void) setMessagesQueue: (CPArray)  aValue [implementation]

Synthesized accessor method.

Definition at line 735 of file TNStropheContact.j.

- (void) setNickname: (CPString)  aValue [implementation]

Synthesized accessor method.

Definition at line 815 of file TNStropheContact.j.

- (void) setNodeName: (CPString)  aValue [implementation]

Synthesized accessor method.

Definition at line 831 of file TNStropheContact.j.

- (void) setNumberOfEvents: (CPNumber)  aValue [implementation]

Synthesized accessor method.

Definition at line 799 of file TNStropheContact.j.

- (void) setResources: (CPArray)  aValue [implementation]

Synthesized accessor method.

Definition at line 751 of file TNStropheContact.j.

- (void) setStatusIcon: (CPImage)  aValue [implementation]

Synthesized accessor method.

Definition at line 783 of file TNStropheContact.j.

- (void) setSubscription: (CPString)  aValue [implementation]

Synthesized accessor method.

Definition at line 360 of file TNStropheContact.j.

- (void) setType: (CPString)  aValue [implementation]

Synthesized accessor method.

Definition at line 863 of file TNStropheContact.j.

- (void) setVCard: (TNStropheVCard aValue [implementation]

Synthesized accessor method.

Definition at line 951 of file TNStropheContact.j.

- (void) setXMPPShow: (CPString)  aValue [implementation]

Synthesized accessor method.

Definition at line 879 of file TNStropheContact.j.

- (void) setXMPPStatus: (CPString)  aValue [implementation]

Synthesized accessor method.

Definition at line 895 of file TNStropheContact.j.

- (CPImage) statusIcon [implementation]

Synthesized accessor method.

Definition at line 775 of file TNStropheContact.j.

- (void) subscribe [implementation]

subscribe to the contact

Definition at line 341 of file TNStropheContact.j.

- (CPString) subscription [implementation]

Synthesized accessor method.

Definition at line 839 of file TNStropheContact.j.

- (CPString) type [implementation]

Synthesized accessor method.

Definition at line 855 of file TNStropheContact.j.

- (void) unsubscribe [implementation]

unsubscribe from the contact

Definition at line 348 of file TNStropheContact.j.

- (TNStropheVCard) vCard [implementation]

Synthesized accessor method.

Definition at line 943 of file TNStropheContact.j.

- (CPString) XMPPShow [implementation]

Synthesized accessor method.

Definition at line 871 of file TNStropheContact.j.

- (CPString) XMPPStatus [implementation]

Synthesized accessor method.

Definition at line 887 of file TNStropheContact.j.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables