![]() |
![]() |
![]() |
telepathy-glib Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Known Implementations | Properties |
#include <telepathy-glib/handle-repo.h> TpHandleRepoIface; TpHandleRepoIfaceClass; gboolean tp_handle_is_valid (TpHandleRepoIface *self
,TpHandle handle
,GError **error
); gboolean tp_handles_are_valid (TpHandleRepoIface *self
,const GArray *handles
,gboolean allow_zero
,GError **error
); gboolean tp_handles_supported_and_valid (TpHandleRepoIface *repos[NUM_TP_HANDLE_TYPES]
,TpHandleType handle_type
,const GArray *handles
,gboolean allow_zero
,GError **error
); void tp_handle_ref (TpHandleRepoIface *self
,TpHandle handle
); void tp_handles_ref (TpHandleRepoIface *self
,const GArray *handles
); void tp_handle_unref (TpHandleRepoIface *self
,TpHandle handle
); void tp_handles_unref (TpHandleRepoIface *self
,const GArray *handles
); gboolean tp_handle_client_hold (TpHandleRepoIface *self
,const gchar *client
,TpHandle handle
,GError **error
); gboolean tp_handles_client_hold (TpHandleRepoIface *self
,const gchar *client
,const GArray *handles
,GError **error
); gboolean tp_handle_client_release (TpHandleRepoIface *self
,const gchar *client
,TpHandle handle
,GError **error
); gboolean tp_handles_client_release (TpHandleRepoIface *self
,const gchar *client
,const GArray *handles
,GError **error
); const char * tp_handle_inspect (TpHandleRepoIface *self
,TpHandle handle
); void tp_handle_set_qdata (TpHandleRepoIface *repo
,TpHandle handle
,GQuark key_id
,gpointer data
,GDestroyNotify destroy
); gpointer tp_handle_get_qdata (TpHandleRepoIface *repo
,TpHandle handle
,GQuark key_id
); TpHandle tp_handle_ensure (TpHandleRepoIface *self
,const gchar *id
,gpointer context
,GError **error
); TpHandle tp_handle_lookup (TpHandleRepoIface *self
,const gchar *id
,gpointer context
,GError **error
); TpHandleSet; #define TP_TYPE_HANDLE_SET void (*TpHandleSetMemberFunc) (TpHandleSet *set
,TpHandle handle
,gpointer userdata
); TpHandleSet * tp_handle_set_new (TpHandleRepoIface *repo
); TpHandleSet * tp_handle_set_new_from_array (TpHandleRepoIface *repo
,const GArray *array
); TpHandleSet * tp_handle_set_copy (const TpHandleSet *other
); void tp_handle_set_clear (TpHandleSet *set
); void tp_handle_set_destroy (TpHandleSet *set
); TpIntSet * tp_handle_set_peek (TpHandleSet *set
); void tp_handle_set_add (TpHandleSet *set
,TpHandle handle
); gboolean tp_handle_set_remove (TpHandleSet *set
,TpHandle handle
); gboolean tp_handle_set_is_member (const TpHandleSet *set
,TpHandle handle
); void tp_handle_set_foreach (TpHandleSet *set
,TpHandleSetMemberFunc func
,gpointer userdata
); gboolean tp_handle_set_is_empty (const TpHandleSet *set
); int tp_handle_set_size (const TpHandleSet *set
); GArray * tp_handle_set_to_array (const TpHandleSet *set
); TpIntSet * tp_handle_set_update (TpHandleSet *set
,const TpIntSet *add
); TpIntSet * tp_handle_set_difference_update (TpHandleSet *set
,const TpIntSet *remove
);
TpHandleRepoIface is implemented by TpDynamicHandleRepo and TpStaticHandleRepo.
Abstract interface of a repository for handles, supporting operations which include checking for validity, reference counting, lookup by string value and lookup by numeric value. See TpDynamicHandleRepo and TpStaticHandleRepo for concrete implementations.
typedef struct _TpHandleRepoIface TpHandleRepoIface;
Dummy typedef representing any implementation of this interface.
typedef struct _TpHandleRepoIfaceClass TpHandleRepoIfaceClass;
The class of a handle repository interface. The structure layout is only available within telepathy-glib, for the handle repository implementations' benefit.
gboolean tp_handle_is_valid (TpHandleRepoIface *self
,TpHandle handle
,GError **error
);
|
|
|
|
|
|
Returns : |
gboolean tp_handles_are_valid (TpHandleRepoIface *self
,const GArray *handles
,gboolean allow_zero
,GError **error
);
|
|
|
|
|
|
|
|
Returns : |
gboolean tp_handles_supported_and_valid (TpHandleRepoIface *repos[NUM_TP_HANDLE_TYPES]
,TpHandleType handle_type
,const GArray *handles
,gboolean allow_zero
,GError **error
);
|
|
|
|
|
|
|
|
|
|
Returns : |
void tp_handles_ref (TpHandleRepoIface *self
,const GArray *handles
);
|
|
|
void tp_handles_unref (TpHandleRepoIface *self
,const GArray *handles
);
|
|
|
gboolean tp_handle_client_hold (TpHandleRepoIface *self
,const gchar *client
,TpHandle handle
,GError **error
);
|
|
|
|
|
|
|
|
Returns : |
gboolean tp_handles_client_hold (TpHandleRepoIface *self
,const gchar *client
,const GArray *handles
,GError **error
);
|
|
|
|
|
|
|
|
Returns : |
gboolean tp_handle_client_release (TpHandleRepoIface *self
,const gchar *client
,TpHandle handle
,GError **error
);
|
|
|
|
|
|
|
|
Returns : |
gboolean tp_handles_client_release (TpHandleRepoIface *self
,const gchar *client
,const GArray *handles
,GError **error
);
|
|
|
|
|
|
|
|
Returns : |
const char * tp_handle_inspect (TpHandleRepoIface *self
,TpHandle handle
);
|
|
|
|
Returns : |
void tp_handle_set_qdata (TpHandleRepoIface *repo
,TpHandle handle
,GQuark key_id
,gpointer data
,GDestroyNotify destroy
);
|
|
|
|
|
|
|
|
|
gpointer tp_handle_get_qdata (TpHandleRepoIface *repo
,TpHandle handle
,GQuark key_id
);
|
|
|
|
|
|
Returns : |
TpHandle tp_handle_ensure (TpHandleRepoIface *self
,const gchar *id
,gpointer context
,GError **error
);
Return a new reference to the handle for the given string. The handle is normalized, if possible. If no such handle exists it will be created.
|
A handle repository implementation |
|
A string whose handle is required |
|
User data to be passed to the normalization callback |
|
Used to return an error if 0 is returned |
Returns : |
the handle corresponding to the given string, or 0 if it is invalid. |
TpHandle tp_handle_lookup (TpHandleRepoIface *self
,const gchar *id
,gpointer context
,GError **error
);
|
|
|
|
|
|
|
|
Returns : |
typedef struct _TpHandleSet TpHandleSet;
A set of handles. This is similar to a TpIntSet (and implemented using one), but adding a handle to the set also references it.
void (*TpHandleSetMemberFunc) (TpHandleSet *set
,TpHandle handle
,gpointer userdata
);
|
|
|
|
|
TpHandleSet * tp_handle_set_new_from_array (TpHandleRepoIface *repo
,const GArray *array
);
|
|
|
|
Returns : |
TpHandleSet * tp_handle_set_copy (const TpHandleSet *other
);
|
|
Returns : |
gboolean tp_handle_set_remove (TpHandleSet *set
,TpHandle handle
);
|
|
|
|
Returns : |
gboolean tp_handle_set_is_member (const TpHandleSet *set
,TpHandle handle
);
|
|
|
|
Returns : |
void tp_handle_set_foreach (TpHandleSet *set
,TpHandleSetMemberFunc func
,gpointer userdata
);
|
|
|
|
|
TpIntSet * tp_handle_set_update (TpHandleSet *set
,const TpIntSet *add
);
|
|
|
|
Returns : |
TpIntSet * tp_handle_set_difference_update (TpHandleSet *set
,const TpIntSet *remove
);
|
|
|
|
Returns : |
"handle-type"
property"handle-type" guint : Read / Write / Construct Only
The TpHandleType held in this handle repository.
Default value: 0