Class
PurpleConversation
Description [src]
class Purple.Conversation : GObject.Object {
parent_instance: GObject
}
A core representation of a conversation between two or more people.
The conversation can be an IM or a chat.
Note: When a conversation is destroyed with the last g_object_unref(), the specified conversation is removed from the parent window. If this conversation is the only one contained in the parent window, that window is also destroyed.
Instance methods
purple_conversation_add_member
Looks for an existing PurpleConversationMember
for info
in
conversation
and returns it if found. If not, a new
PurpleConversationMember
is created.
since: 3.0.0
purple_conversation_find_member
Finds the PurpleConversationMember
for info
if they are a member
of conversation
.
since: 3.0.0
purple_conversation_get_age_restricted
Gets whether or not conversation
is age restricted.
since: 3.0.0
purple_conversation_get_favorite
Gets whether or not conversation
is a favorite conversation.
since: 3.0.0
purple_conversation_has_member
Checks if info
is in conversation
. If info
is found, position
is set to
the position of info
in PurpleConversation:members
if it is not
NULL
.
since: 3.0.0
purple_conversation_present
Present a conversation to the user. This allows core code to initiate a conversation by displaying the IM dialog.
purple_conversation_remove_member
Attempts to remove member
from the collection of members in conversation
.
If found, member
is removed and the
PurpleConversation::member-removed
signal is emitted with
announce
and message
as parameters.
since: 3.0.0
purple_conversation_send
Sends a message to this conversation. This function calls
purple_conversation_send_with_flags()
with no additional flags.
purple_conversation_set_age_restricted
Sets whether or not conversation
is age restricted to the value of
age_restricted
.
since: 3.0.0
purple_conversation_set_created_on
Sets the creation time of conversation
to created_on
.
since: 3.0.0
purple_conversation_set_description
Sets the description of conversation
to description
.
since: 3.0.0
purple_conversation_set_favorite
Sets whether or not conversation
is a favorite to favorite
.
since: 3.0.0
purple_conversation_set_online
Sets whether or not the conversation is online, or able to send and receive messages.
since: 3.0.0
purple_conversation_set_topic_author
Sets the author of the topic for conversation
to author
.
since: 3.0.0
purple_conversation_set_topic_updated
Sets the time that the topic was lasted updated for conversation
.
since: 3.0.0
purple_conversation_set_user_nickname
Sets the user’s nickname in conversation
to nickname
.
since: 3.0.0
Properties
Purple.Conversation:created-on
The GDateTime
when this conversation was created. This can
be NULL
if the value is not known or supported.
since: 3.0.0
Purple.Conversation:description
Sets the description of the conversation. This field is typically used
to give more information about a conversation than that which would fit
in PurpleConversation:topic
.
since: 3.0.0
Purple.Conversation:favorite
Whether or not the conversation has been marked as favorite by the user.
since: 3.0.0
Purple.Conversation:id
An opaque identifier for this conversation. Generally speaking this is protocol dependent and should only be used as a unique identifier.
since: 3.0.0
Purple.Conversation:messages
A [iface.Gio.ListModel] of all the messages in this conversation.
since: 3.0.0
Purple.Conversation:online
Whether or not the conversation is able to send and receive messages.
since: 3.0.0
Purple.Conversation:type
A type hint for the conversation. This may be useful for protocols, but libpurple treats all conversations the same.
since: 3.0.0
Signals
Purple.Conversation::member-added
Emitted when a new member is added to this conversation.
since: 3.0.0
Purple.Conversation::member-removed
Emitted when member is removed from this conversation.
since: 3.0.0
Signals inherited from GObject (1)
GObject::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.
Class structure
struct PurpleConversationClass {
void (* write_message) (
PurpleConversation* conv,
PurpleMessage* msg
);
}
Base class for all PurpleConversation
‘s.
Class members
write_message: void (* write_message) ( PurpleConversation* conv, PurpleMessage* msg )
- No description available.