Interface

PurpleProtocolConversation

unstable since: 3.0

[]

Description [src]

interface Purple.ProtocolConversation : Purple.Protocol

This interface defines the behavior for interacting with conversations at the protocol layer. These methods will primarily be called by the user interface.

Available since: 3.0

[]

Prerequisite

In order to implement ProtocolConversation, your type must inherit fromPurpleProtocol.

[]

Instance methods

purple_protocol_conversation_create_conversation_async

Starts the process of creating a dm or group dm conversation on account.

unstable since: 3.0

purple_protocol_conversation_create_conversation_finish

Finishes a previous call to purple_protocol_conversation_create_conversation_async(). This should be called from the callback of that function to get the result of whether or not the conversation was created successfully.

unstable since: 3.0

purple_protocol_conversation_get_channel_join_details

User interfaces will use this function to get an instance of PurpleChannelJoinDetails that can be presented to a user for them to edit.

unstable since: 3.0

purple_protocol_conversation_get_create_conversation_details

Gets a PurpleCreateConversationDetails from protocol for account.

unstable since: 3.0

purple_protocol_conversation_implements_create_conversation

Checks if protocol implements Purple.ProtocolConversationInterface.get_create_conversation_details, Purple.ProtocolConversationInterface.create_conversation_async, and Purple.ProtocolConversationInterface.create_conversation_finish.

unstable since: 3.0

purple_protocol_conversation_implements_leave_conversation

Checks if protocol implements Purple.ProtocolConversationInterface.leave_conversation_async and Purple.ProtocolConversationInterface.leave_conversation_finish.

unstable since: 3.0

purple_protocol_conversation_implements_refresh

Checks if protocol implements Purple.ProtocolConversationInterface.refresh.

unstable since: 3.0

purple_protocol_conversation_implements_send_message

Checks if a protocol implements all of the send message virtual functions.

unstable since: 3.0

purple_protocol_conversation_implements_send_typing

Checks if protocol implements Purple.ProtocolConversationInterface.send_typing.

unstable since: 3.0

purple_protocol_conversation_implements_set_avatar

Checks if a protocol implements setting avatars.

unstable since: 3.0

purple_protocol_conversation_implements_set_description

Checks if a protocol implements setting the description of conversations.

unstable since: 3.0

purple_protocol_conversation_implements_set_title

Checks if a protocol implements setting conversation titles.

unstable since: 3.0

purple_protocol_conversation_implements_set_topic

Checks if a protocol implements setting topics.

unstable since: 3.0

purple_protocol_conversation_join_channel_async

Attempts to join the channel identified by details using account.

unstable since: 3.0

purple_protocol_conversation_join_channel_finish

Finishes a previous call to purple_protocol_conversation_join_channel_async(). This should be called from the callback of that function to get the result of whether or not the channel was joined successfully.

unstable since: 3.0

purple_protocol_conversation_leave_conversation_async

Attempts to leave conversation.

unstable since: 3.0

purple_protocol_conversation_leave_conversation_finish

Finishes a previous call to purple_protocol_conversation_leave_conversation_async().

unstable since: 3.0

purple_protocol_conversation_refresh

Asks the protocol to refresh a conversation.

unstable since: 3.0

purple_protocol_conversation_send_message_async

Starts the process of sending message to conversation.

unstable since: 3.0

purple_protocol_conversation_send_message_finish

Finishes a previous call to purple_protocol_conversation_send_message_async(). This should be called from the callback of that function to get the result of whether or not the message was sent successfully.

unstable since: 3.0

purple_protocol_conversation_send_typing

Sends the libpurple user’s typing state for the conversation.

unstable since: 3.0

purple_protocol_conversation_set_avatar_async

Sets the avatar for conversation to pixbuf. Pass NULL to clear the current avatar.

unstable since: 3.0

purple_protocol_conversation_set_avatar_finish

Finishes a previous call to purple_protocol_conversation_set_avatar_async(). This should be called from the callback of that function to get the result of whether or not the avatar was set successfully.

unstable since: 3.0

purple_protocol_conversation_set_description_async

Sets the description of a conversation.

unstable since: 3.0

purple_protocol_conversation_set_description_finish

Finishes a previous call to purple_protocol_conversation_set_description_async(). This should be called from the callback of that function to get the result of whether or not the description was set successfully.

unstable since: 3.0

purple_protocol_conversation_set_title_async

Sets the title of a conversation.

unstable since: 3.0

purple_protocol_conversation_set_title_finish

Finishes a previous call to purple_protocol_conversation_set_title_async(). This should be called from the callback of that function to get the result of whether or not the title was set successfully.

unstable since: 3.0

purple_protocol_conversation_set_topic_async

Starts the process of setting the topic of conversation to topic.

unstable since: 3.0

purple_protocol_conversation_set_topic_finish

Finishes a previous call to purple_protocol_conversation_set_topic_async(). This should be called from the callback of that function to get the result of whether or not the message was sent successfully.

unstable since: 3.0

Interface structure

[]

Virtual methods

Purple.ProtocolConversation.create_conversation_async

Starts the process of creating a dm or group dm conversation on account.

unstable since: 3.0

Purple.ProtocolConversation.create_conversation_finish

Finishes a previous call to purple_protocol_conversation_create_conversation_async(). This should be called from the callback of that function to get the result of whether or not the conversation was created successfully.

unstable since: 3.0

Purple.ProtocolConversation.get_channel_join_details

User interfaces will use this function to get an instance of PurpleChannelJoinDetails that can be presented to a user for them to edit.

unstable since: 3.0

Purple.ProtocolConversation.get_create_conversation_details

Gets a PurpleCreateConversationDetails from protocol for account.

unstable since: 3.0

Purple.ProtocolConversation.join_channel_async

Attempts to join the channel identified by details using account.

unstable since: 3.0

Purple.ProtocolConversation.join_channel_finish

Finishes a previous call to purple_protocol_conversation_join_channel_async(). This should be called from the callback of that function to get the result of whether or not the channel was joined successfully.

unstable since: 3.0

Purple.ProtocolConversation.leave_conversation_async

Attempts to leave conversation.

unstable since: 3.0

Purple.ProtocolConversation.leave_conversation_finish

Finishes a previous call to purple_protocol_conversation_leave_conversation_async().

unstable since: 3.0

Purple.ProtocolConversation.refresh

Asks the protocol to refresh a conversation.

unstable since: 3.0

Purple.ProtocolConversation.send_message_async

Starts the process of sending message to conversation.

unstable since: 3.0

Purple.ProtocolConversation.send_message_finish

Finishes a previous call to purple_protocol_conversation_send_message_async(). This should be called from the callback of that function to get the result of whether or not the message was sent successfully.

unstable since: 3.0

Purple.ProtocolConversation.send_typing

Sends the libpurple user’s typing state for the conversation.

unstable since: 3.0

Purple.ProtocolConversation.set_avatar_async

Sets the avatar for conversation to pixbuf. Pass NULL to clear the current avatar.

unstable since: 3.0

Purple.ProtocolConversation.set_avatar_finish

Finishes a previous call to purple_protocol_conversation_set_avatar_async(). This should be called from the callback of that function to get the result of whether or not the avatar was set successfully.

unstable since: 3.0

Purple.ProtocolConversation.set_description_async

Sets the description of a conversation.

unstable since: 3.0

Purple.ProtocolConversation.set_description_finish

Finishes a previous call to purple_protocol_conversation_set_description_async(). This should be called from the callback of that function to get the result of whether or not the description was set successfully.

unstable since: 3.0

Purple.ProtocolConversation.set_title_async

Sets the title of a conversation.

unstable since: 3.0

Purple.ProtocolConversation.set_title_finish

Finishes a previous call to purple_protocol_conversation_set_title_async(). This should be called from the callback of that function to get the result of whether or not the title was set successfully.

unstable since: 3.0

Purple.ProtocolConversation.set_topic_async

Starts the process of setting the topic of conversation to topic.

unstable since: 3.0

Purple.ProtocolConversation.set_topic_finish

Finishes a previous call to purple_protocol_conversation_set_topic_async(). This should be called from the callback of that function to get the result of whether or not the message was sent successfully.

unstable since: 3.0