Package papyon :: Module conversation :: Class ConversationInterface

Class ConversationInterface

object --+
         |
        ConversationInterface

Known Subclasses:

AbstractConversation

Interface implemented by all the Conversation objects, a Conversation object allows the user to communicate with one or more peers

Instance Methods

send_text_message(self, message)
Send a message to all persons in this conversation.

source code

send_nudge(self)
Sends a nudge to the contacts on this conversation.

source code

send_typing_notification(self)
Sends an user typing notification to the contacts on this conversation.

source code

invite_user(self, contact)
Request a contact to join in the conversation.

source code

leave(self)
Leave the conversation.

source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties
Inherited from `object`: `__class__`

Method Details

send_text_message(self, message)

source code

Send a message to all persons in this conversation.

Parameters:

message (Contact) - the message to send to the users on this conversation

invite_user(self, contact)

source code

Request a contact to join in the conversation.

Parameters:

contact (Contact) - the contact to invite.