TpGroupMixinAddMemberFunc ()

gboolean            (*TpGroupMixinAddMemberFunc)        (GObject *obj,
                                                         TpHandle handle,
                                                         const gchar *message,
                                                         GError **error);

Signature of the callback used to add a member to the group. This should perform the necessary operations in the underlying IM protocol to cause the member to be added.

TpGroupMixinRemMemberFunc ()

gboolean            (*TpGroupMixinRemMemberFunc)        (GObject *obj,
                                                         TpHandle handle,
                                                         const gchar *message,
                                                         GError **error);

Signature of the callback used to remove a member from the group. This should perform the necessary operations in the underlying IM protocol to cause the member to be removed.

TpGroupMixinRemMemberWithReasonFunc ()

gboolean            (*TpGroupMixinRemMemberWithReasonFunc)
                                                        (GObject *obj,
                                                         TpHandle handle,
                                                         const gchar *message,
                                                         guint reason,
                                                         GError **error);

Signature of the callback used to remove a member from the group. This should perform the necessary operations in the underlying IM protocol to cause the member to be removed.

Set this with tp_group_mixin_class_set_remove_with_reason_func(), .

TpGroupMixin

typedef struct {
  TpHandleRepoIface *handle_repo;
  TpHandle self_handle;

  TpChannelGroupFlags group_flags;

  TpHandleSet *members;
  TpHandleSet *local_pending;
  TpHandleSet *remote_pending;

  TpGroupMixinPrivate *priv;
} TpGroupMixin;

Structure representing the group mixin as used in a particular class. To be placed in the implementation's instance structure.

All fields should be considered read-only.

TpGroupMixinClass

typedef struct {
  TpGroupMixinAddMemberFunc add_member;
  TpGroupMixinRemMemberFunc remove_member;
  TpGroupMixinClassPrivate *priv;
} TpGroupMixinClass;

Structure representing the group mixin as used in a particular class. To be placed in the implementation's class structure.

Initialize this with tp_group_mixin_class_init().

All fields should be considered read-only.

tp_group_mixin_class_init ()

void                tp_group_mixin_class_init           (GObjectClass *obj_cls,
                                                         glong offset,
                                                         TpGroupMixinAddMemberFunc add_func,
                                                         TpGroupMixinRemMemberFunc rem_func);

Configure the mixin for use with the given class.

tp_group_mixin_class_allow_self_removal ()

void                tp_group_mixin_class_allow_self_removal
                                                        (GObjectClass *obj_cls);

Configure the mixin to allow attempts to remove the SelfHandle from this Group, even if the group flags would otherwise disallow this. The channel's TpGroupMixinRemMemberFunc or TpGroupMixinRemMemberWithReasonFunc will be called as usual for such attempts, and may make them fail with TP_ERROR_PERMISSION_DENIED if required.

This function should be called from the GObject class_init callback, after calling tp_group_mixin_class_init().

(Recent telepathy-spec changes make it valid to try to remove the self-handle at all times, regardless of group flags. However, if this was implemented automatically in TpGroupMixin, this would risk crashing connection manager implementations that assume that TpGroupMixin will enforce the group flags strictly. As a result, connection managers should call this function to indicate to the TpGroupMixin that it may call their removal callback with the self-handle regardless of flag settings.)

Since 0.7.27

tp_group_mixin_class_set_remove_with_reason_func ()

void                tp_group_mixin_class_set_remove_with_reason_func
                                                        (GObjectClass *cls,
                                                         TpGroupMixinRemMemberWithReasonFunc func);

Set a callback to be used to implement RemoveMembers() and RemoveMembersWithReason(). If this function is called during class initialization, the given callback will be used instead of the remove callback passed to tp_group_mixin_class_init() (which must be NULL in this case).

Since 0.5.13

tp_group_mixin_init ()

void                tp_group_mixin_init                 (GObject *obj,
                                                         glong offset,
                                                         TpHandleRepoIface *handle_repo,
                                                         TpHandle self_handle);

Initialize the mixin.

tp_group_mixin_finalize ()

void                tp_group_mixin_finalize             (GObject *obj);

Unreference handles and free resources used by this mixin.

tp_group_mixin_get_self_handle ()

gboolean            tp_group_mixin_get_self_handle      (GObject *obj,
                                                         guint *ret,
                                                         GError **error);

Set the guint pointed to by ret to the local user's handle in this group, or to 0 if the local user is not present in this group.

tp_group_mixin_get_group_flags ()

gboolean            tp_group_mixin_get_group_flags      (GObject *obj,
                                                         guint *ret,
                                                         GError **error);

Set the guint pointed to by ret to this group's flags, to be interpreted according to TpChannelGroupFlags.

tp_group_mixin_add_members ()

gboolean            tp_group_mixin_add_members          (GObject *obj,
                                                         const GArray *contacts,
                                                         const gchar *message,
                                                         GError **error);

Request that the given contacts be added to the group as if in response to user action. If the group's flags prohibit this, raise PermissionDenied. If any of the handles is invalid, raise InvalidHandle. Otherwise attempt to add the contacts by calling the callbacks provided by the channel implementation.

tp_group_mixin_remove_members ()

gboolean            tp_group_mixin_remove_members       (GObject *obj,
                                                         const GArray *contacts,
                                                         const gchar *message,
                                                         GError **error);

Request that the given contacts be removed from the group as if in response to user action. If the group's flags prohibit this, raise PermissionDenied. If any of the handles is invalid, raise InvalidHandle. If any of the handles is absent from the group, raise NotAvailable. Otherwise attempt to remove the contacts by calling the callbacks provided by the channel implementation.

tp_group_mixin_remove_members_with_reason ()

gboolean            tp_group_mixin_remove_members_with_reason
                                                        (GObject *obj,
                                                         const GArray *contacts,
                                                         const gchar *message,
                                                         guint reason,
                                                         GError **error);

Request that the given contacts be removed from the group as if in response to user action. If the group's flags prohibit this, raise PermissionDenied. If any of the handles is invalid, raise InvalidHandle. If any of the handles is absent from the group, raise NotAvailable. Otherwise attempt to remove the contacts by calling the callbacks provided by the channel implementation.

tp_group_mixin_get_members ()

gboolean            tp_group_mixin_get_members          (GObject *obj,
                                                         GArray **ret,
                                                         GError **error);

Get the group's current members

tp_group_mixin_get_local_pending_members ()

gboolean            tp_group_mixin_get_local_pending_members
                                                        (GObject *obj,
                                                         GArray **ret,
                                                         GError **error);

Get the group's local-pending members.

tp_group_mixin_get_local_pending_members_with_info ()

gboolean            tp_group_mixin_get_local_pending_members_with_info
                                                        (GObject *obj,
                                                         GPtrArray **ret,
                                                         GError **error);

Get the group's local-pending members and information about their requests to join the channel.

tp_group_mixin_get_remote_pending_members ()

gboolean            tp_group_mixin_get_remote_pending_members
                                                        (GObject *obj,
                                                         GArray **ret,
                                                         GError **error);

Get the group's remote-pending members.

tp_group_mixin_get_all_members ()

gboolean            tp_group_mixin_get_all_members      (GObject *obj,
                                                         GArray **members,
                                                         GArray **local_pending,
                                                         GArray **remote_pending,
                                                         GError **error);

Get the group's current and pending members.

tp_group_mixin_get_handle_owners ()

gboolean            tp_group_mixin_get_handle_owners    (GObject *obj,
                                                         const GArray *handles,
                                                         GArray **ret,
                                                         GError **error);

If the mixin has the flag TP_CHANNEL_GROUP_FLAG_CHANNEL_SPECIFIC_HANDLES, return the global owners of the given local handles, or 0 where unavailable.

tp_group_mixin_change_flags ()

void                tp_group_mixin_change_flags         (GObject *obj,
                                                         TpChannelGroupFlags add,
                                                         TpChannelGroupFlags del);

Request a change to be made to the flags. If any flags were actually set or cleared, emits the GroupFlagsChanged signal with the changes.

It is an error to set any of the same bits in both add and del.

Changed in 0.7.7: the signal is not emitted if adding add and removing del had no effect on the existing group flags.

tp_group_mixin_change_members ()

gboolean            tp_group_mixin_change_members       (GObject *obj,
                                                         const gchar *message,
                                                         TpIntSet *add,
                                                         TpIntSet *del,
                                                         TpIntSet *add_local_pending,
                                                         TpIntSet *add_remote_pending,
                                                         TpHandle actor,
                                                         TpChannelGroupChangeReason reason);

Change the sets of members as given by the arguments, and emit the MembersChanged and MembersChangedDetailed signals if the changes were not a no-op.

This function must be called in response to events on the underlying IM protocol, and must not be called in direct response to user input; it does not respect the permissions flags, but changes the group directly.

If any two of add, del, add_local_pending and add_remote_pending have a non-empty intersection, the result is undefined. Don't do that.

Each of the TpIntSet arguments may be NULL, which is treated as equivalent to an empty set.

tp_group_mixin_change_members_detailed ()

gboolean            tp_group_mixin_change_members_detailed
                                                        (GObject *obj,
                                                         TpIntSet *add,
                                                         TpIntSet *del,
                                                         TpIntSet *add_local_pending,
                                                         TpIntSet *add_remote_pending,
                                                         const GHashTable *details);

Change the sets of members as given by the arguments, and emit the MembersChanged and MembersChangedDetailed signals if the changes were not a no-op.

This function must be called in response to events on the underlying IM protocol, and must not be called in direct response to user input; it does not respect the permissions flags, but changes the group directly.

If any two of add, del, add_local_pending and add_remote_pending have a non-empty intersection, the result is undefined. Don't do that.

Each of the TpIntSet arguments may be NULL, which is treated as equivalent to an empty set.

details may contain, among other entries, the well-known keys (and corresponding type, wrapped in a GValue) defined by the Group.MembersChangedDetailed signal's specification; these include "actor" (a handle as G_TYPE_UINT), "change-reason" (an element of TpChannelGroupChangeReason as G_TYPE_UINT), "message" (G_TYPE_STRING), "error" (G_TYPE_STRING), "debug-message" (G_TYPE_STRING).

If all of the information in details could be passed to tp_group_mixin_change_members() then calling this function instead provides no benefit. Calling this function without setting TP_CHANNEL_GROUP_FLAG_MEMBERS_CHANGED_DETAILED with tp_group_mixin_change_members() first is not very useful, as clients will not know to listen for MembersChangedDetailed and thus will miss the details.

tp_group_mixin_add_handle_owner ()

void                tp_group_mixin_add_handle_owner     (GObject *obj,
                                                         TpHandle local_handle,
                                                         TpHandle owner_handle);

Note that the given local handle is an alias within this group for the given globally-valid handle. It will be returned from subsequent GetHandleOwner queries where appropriate.

Changed in 0.7.10: The owner_handle may be 0. To comply with telepathy-spec 0.17.6, before adding any channel-specific handle to the members, local-pending members or remote-pending members, you must call either this function or tp_group_mixin_add_handle_owners().

tp_group_mixin_iface_init ()

void                tp_group_mixin_iface_init           (gpointer g_iface,
                                                         gpointer iface_data);

Fill in the vtable entries needed to implement the group interface using this mixin. This function should usually be called via G_IMPLEMENT_INTERFACE.

tp_group_mixin_add_handle_owners ()

void                tp_group_mixin_add_handle_owners    (GObject *obj,
                                                         GHashTable *local_to_owner_handle);

Note that the given local handles are aliases within this group for the given globally-valid handles.

To comply with telepathy-spec 0.17.6, before adding any channel-specific handle to the members, local-pending members or remote-pending members, you must call either this function or tp_group_mixin_add_handle_owner().

since 0.7.10

tp_group_mixin_get_dbus_property ()

void                tp_group_mixin_get_dbus_property    (GObject *object,
                                                         GQuark interface,
                                                         GQuark name,
                                                         GValue *value,
                                                         gpointer unused);

An implementation of TpDBusPropertiesMixinGetter which assumes that the object has the group mixin. It can only be used for the Group interface.

Since 0.7.10

tp_group_mixin_init_dbus_properties ()

void                tp_group_mixin_init_dbus_properties (GObjectClass *cls);

Set up TpDBusPropertiesMixinClass to use this mixin's implementation of the Group interface's properties.

This uses tp_group_mixin_get_dbus_property() as the property getter and sets up a list of the supported properties for it. Having called this, you should add TP_CHANNEL_GROUP_FLAG_PROPERTIES to any channels of this class with tp_group_mixin_change_flags() to indicate that the DBus properties are available.

Since 0.7.10

tp_group_mixin_change_self_handle ()

void                tp_group_mixin_change_self_handle   (GObject *obj,
                                                         TpHandle new_self_handle);

Change the self-handle for this group to the given value.

tp_external_group_mixin_iface_init ()

void                tp_external_group_mixin_iface_init  (gpointer g_iface,
                                                         gpointer iface_data);

Fill in the vtable entries needed to implement the group interface using the group mixin of another object. This function should usually be called via G_IMPLEMENT_INTERFACE.

Since 0.5.13

tp_external_group_mixin_init ()

void                tp_external_group_mixin_init        (GObject *obj,
                                                         GObject *obj_with_mixin);

Fill in the qdata needed to implement the group interface using the group mixin of another object. This function should usually be called in the instance constructor.

Since 0.5.13

tp_external_group_mixin_finalize ()

void                tp_external_group_mixin_finalize    (GObject *obj);

Remove the external group mixin. This function should usually be called in the dispose or finalize function.

Since 0.5.13

tp_external_group_mixin_init_dbus_properties ()

void                tp_external_group_mixin_init_dbus_properties
                                                        (GObjectClass *cls);

Set up TpDBusPropertiesMixinClass to use this mixin's implementation of the Group interface's properties.

This uses tp_group_mixin_get_dbus_property() as the property getter and sets up a list of the supported properties for it. Having called this, you should add TP_CHANNEL_GROUP_FLAG_PROPERTIES to channels containing the mixin used by this class with tp_group_mixin_change_flags() to indicate that the DBus properties are available.

Since 0.7.10

tp_external_group_mixin_get_dbus_property ()

void                tp_external_group_mixin_get_dbus_property
                                                        (GObject *object,
                                                         GQuark interface,
                                                         GQuark name,
                                                         GValue *value,
                                                         gpointer unused);

An implementation of TpDBusPropertiesMixinGetter which assumes that the object has the external group mixin. It can only be used for the Group interface.

Since 0.7.10