Method

PurpleConversationremove_member

since: 3.0

Declaration [src]

gboolean
purple_conversation_remove_member (
  PurpleConversation* conversation,
  PurpleContactInfo* info,
  gboolean announce,
  const char* message
)

Description [src]

Attempts to remove info from the collection of members in conversation. If found, info is removed and the PurpleConversation::member-removed signal is emitted with announce and message as parameters.

This method is intended to be called by a protocol plugin to directly manage the membership state of the conversation.

Available since: 3.0

Parameters

info

Type: PurpleContactInfo

The PurpleContactInfo of the person leaving.

The data is owned by the caller of the function.
announce

Type: gboolean

Whether or not this removal should be announced.

message

Type: const char*

An optional message for the announcement.

The argument can be NULL.
The data is owned by the caller of the function.
The value is a NUL terminated UTF-8 string.

Return value

Type: gboolean

TRUE if member was found and removed from conversation, otherwise FALSE.