This is the interface between InstanceMessenger events and the windows
that make up the interface.
Methods
|
|
|
|
__init__
|
__init__ (
self,
im,
Conversation,
ContactList,
GroupSession,
ErrorWindow,
)
|
|
_log
|
_log (
self,
gateway,
user,
text,
)
used to log conversations/chats to a file
gateway := the gateway the message is from (class Gateway
user := the user who sent the message, ends in .chat for groups (string)
text := the message they sent (string)
|
|
addContact
|
addContact (
self,
gateway,
user,
)
add a contact to the gateways contact list.
gateway := the gateway to add the contact to (class Gateway)
user := the contact to add to the list (string)
|
|
changeStatus
|
changeStatus ( self, status )
|
|
conversationWith
|
conversationWith (
self,
gateway,
target,
)
internal function to make sure that a Conversation window is showing.
gateway := the gateway the conversation is over (class Gateway)
target := the user the conversation is with (string)
|
|
directMessage
|
directMessage (
self,
gateway,
user,
message,
)
send a direct message to a user.
gateway := the gateway to send the message over
user := the user to send the message to (string)
message := the message to send (string)
|
|
endConversation
|
endConversation (
self,
gateway,
target,
)
internal function to remove the Conversation window.
gateway := the gateway the conversation was over (class Gateway)
target := the user the conversation was with (string)
|
|
event_attach
|
event_attach ( self, gateway )
called when a gateway is connected to attach it to the GUI.
gateway := the gateway to attach (class Gateway)
|
|
event_detach
|
event_detach ( self, gateway )
called when a gateway wants to detach from the GUI.
gateway := the gateway to detach (class Gateway)
|
|
event_error
|
event_error (
self,
gateway,
message,
)
called when an error occurs.
gateway := the gateway that failed to connect (class Gateway)
message := the reason the connection failed (string)
|
|
event_joinedGroup
|
event_joinedGroup (
self,
gateway,
group,
)
|
|
event_leftGroup
|
event_leftGroup (
self,
gateway,
group,
)
|
|
event_memberJoined
|
event_memberJoined (
self,
gateway,
member,
group,
)
called when someone joins a group we're in.
gateway := the gateway the group is on (class Gateway)
member := the member who joined the group (string)
group := the group the member joined (string)
|
|
event_memberLeft
|
event_memberLeft (
self,
gateway,
member,
group,
)
called when someone leaves a group we're in.
gateway := the gateway the group is on (class Gateway)
member := the member who left the group (string)
group := the group the member left (string)
|
|
event_nameChanged
|
event_nameChanged (
self,
gateway,
contact,
name,
)
called when the nickname of a contact we're observing (on contact list,
in chat room, direct message) changes their name. we get one of these
as well if we change our nickname.
gateway := the gateway the contact is on (class Gateway)
contact := the old name of the contact (string)
name := the new name of the contact (string)
|
|
event_receiveContactList
|
event_receiveContactList (
self,
gateway,
contacts,
)
called when we receive the contact list from a gateway
gateway := the gateway the list is from (class Gateway)
contacts := a list of the contacts (list)
|
|
event_receiveDirectMessage
|
event_receiveDirectMessage (
self,
gateway,
user,
message,
)
called when we receive a direct message.
gateway := the gateway the message is from (class Gateway)
sender := the user who sent it (string)
message := the message (string)
|
|
event_receiveGroupEmote
|
event_receiveGroupEmote (
self,
gateway,
member,
group,
emote,
)
|
|
event_receiveGroupMembers
|
event_receiveGroupMembers (
self,
gateway,
members,
group,
)
called when we receive the list of group members.
gateway := the gateway the group is on (class Gateway)
members := the list of members in the group (list)
group := the name of the group (string)
|
|
event_receiveGroupMessage
|
event_receiveGroupMessage (
self,
gateway,
member,
group,
message,
)
called when someone sends a message to a group we're in.
gateway := the gateway the group is on (class Gateway)
member := the user who sent the message (string)
group := the group the message was sent to (string)
message := the message (string)
|
|
event_statusChanged
|
event_statusChanged (
self,
gateway,
contact,
status,
)
called when a contact on our contact list changes status.
gateway := the gateway the contact is on (class Gateway)
contact := the contact whos status changed (string)
status := the new status of the contact (string)
|
|
getGroupMembers
|
getGroupMembers (
self,
gateway,
group,
)
get the members for a group we're in.
gateway := the gateway the group is on (class Gateway)
group := the name of the group (string)
|
|
groupMessage
|
groupMessage (
self,
gateway,
group,
message,
)
send a message to a group.
gateway := the gateway the group is on (class Gateway)
group := the group to send the message to (string)
message := the message to send (string)
|
|
joinGroup
|
joinGroup (
self,
gateway,
group,
)
join a group.
gateway := the gateway the group is on (class Gateway)
group := the name of the group (string)
|
|
leaveGroup
|
leaveGroup (
self,
gateway,
group,
)
leave a group
gateway := the gateway the group is on (class Gateway)
group := the name of the group (string)
|
|
removeContact
|
removeContact (
self,
gateway,
user,
)
remove a contact from the gateways contact list.
gateway := the gateway to remove the contact from (class Gateway)
user := the contact to remove from the list (string)
|