Service-side Channel Logger interface

Service-side Channel Logger interface — GInterface to implement logger API

Functions

Signals

void favourite-contacts-changed Has Details

Types and Values

Object Hierarchy

    GInterface
    ╰── TpSvcLogger

Includes

#include <telepathy-glib/telepathy-glib-dbus.h>

Description

This interface (auto-generated from the Telepathy spec) makes it easier to export objects implementing the Telepathy Logger interface.

Functions

tp_svc_logger_add_favourite_contact_impl ()

void
(*tp_svc_logger_add_favourite_contact_impl)
                               (TpSvcLogger *self,
                                const gchar *in_Account,
                                const gchar *in_Identifier,
                                GDBusMethodInvocation *invocation);

The signature of an implementation of the D-Bus method AddFavouriteContact on interface im.telepathy.v1.Logger1.

Parameters

self

The object implementing this interface

 

in_Account

const gchar * (FIXME, generate documentation)

 

in_Identifier

const gchar * (FIXME, generate documentation)

 

invocation

Used to return values or throw an error

 

tp_svc_logger_clear_account_impl ()

void
(*tp_svc_logger_clear_account_impl) (TpSvcLogger *self,
                                     const gchar *in_Account,
                                     GDBusMethodInvocation *invocation);

The signature of an implementation of the D-Bus method ClearAccount on interface im.telepathy.v1.Logger1.

Parameters

self

The object implementing this interface

 

in_Account

const gchar * (FIXME, generate documentation)

 

invocation

Used to return values or throw an error

 

tp_svc_logger_clear_entity_impl ()

void
(*tp_svc_logger_clear_entity_impl) (TpSvcLogger *self,
                                    const gchar *in_Account,
                                    const gchar *in_Identifier,
                                    gint in_Type,
                                    GDBusMethodInvocation *invocation);

The signature of an implementation of the D-Bus method ClearEntity on interface im.telepathy.v1.Logger1.

Parameters

self

The object implementing this interface

 

in_Account

const gchar * (FIXME, generate documentation)

 

in_Identifier

const gchar * (FIXME, generate documentation)

 

in_Type

gint (FIXME, generate documentation)

 

invocation

Used to return values or throw an error

 

tp_svc_logger_clear_impl ()

void
(*tp_svc_logger_clear_impl) (TpSvcLogger *self,
                             GDBusMethodInvocation *invocation);

The signature of an implementation of the D-Bus method Clear on interface im.telepathy.v1.Logger1.

Parameters

self

The object implementing this interface

 

invocation

Used to return values or throw an error

 

tp_svc_logger_emit_favourite_contacts_changed ()

void
tp_svc_logger_emit_favourite_contacts_changed
                               (gpointer instance,
                                const gchar *arg_Account,
                                const gchar **arg_Added,
                                const gchar **arg_Removed);

Type-safe wrapper around g_signal_emit to emit the FavouriteContactsChanged signal on interface im.telepathy.v1.Logger1.

Parameters

instance

The object implementing this interface

 

arg_Account

const gchar * (FIXME, generate documentation)

 

arg_Added

const gchar ** (FIXME, generate documentation)

 

arg_Removed

const gchar ** (FIXME, generate documentation)

 

tp_svc_logger_get_favourite_contacts_impl ()

void
(*tp_svc_logger_get_favourite_contacts_impl)
                               (TpSvcLogger *self,
                                GDBusMethodInvocation *invocation);

The signature of an implementation of the D-Bus method GetFavouriteContacts on interface im.telepathy.v1.Logger1.

Parameters

self

The object implementing this interface

 

invocation

Used to return values or throw an error

 

tp_svc_logger_implement_add_favourite_contact ()

void
tp_svc_logger_implement_add_favourite_contact
                               (TpSvcLoggerClass *klass,
                                tp_svc_logger_add_favourite_contact_impl impl);

Register an implementation for the AddFavouriteContact method in the vtable of an implementation of this interface. To be called from the interface init function.

Parameters

klass

A class whose instances implement this interface

 

impl

A callback used to implement the AddFavouriteContact D-Bus method

 

tp_svc_logger_implement_clear ()

void
tp_svc_logger_implement_clear (TpSvcLoggerClass *klass,
                               tp_svc_logger_clear_impl impl);

Register an implementation for the Clear method in the vtable of an implementation of this interface. To be called from the interface init function.

Parameters

klass

A class whose instances implement this interface

 

impl

A callback used to implement the Clear D-Bus method

 

tp_svc_logger_implement_clear_account ()

void
tp_svc_logger_implement_clear_account (TpSvcLoggerClass *klass,
                                       tp_svc_logger_clear_account_impl impl);

Register an implementation for the ClearAccount method in the vtable of an implementation of this interface. To be called from the interface init function.

Parameters

klass

A class whose instances implement this interface

 

impl

A callback used to implement the ClearAccount D-Bus method

 

tp_svc_logger_implement_clear_entity ()

void
tp_svc_logger_implement_clear_entity (TpSvcLoggerClass *klass,
                                      tp_svc_logger_clear_entity_impl impl);

Register an implementation for the ClearEntity method in the vtable of an implementation of this interface. To be called from the interface init function.

Parameters

klass

A class whose instances implement this interface

 

impl

A callback used to implement the ClearEntity D-Bus method

 

tp_svc_logger_implement_get_favourite_contacts ()

void
tp_svc_logger_implement_get_favourite_contacts
                               (TpSvcLoggerClass *klass,
                                tp_svc_logger_get_favourite_contacts_impl impl);

Register an implementation for the GetFavouriteContacts method in the vtable of an implementation of this interface. To be called from the interface init function.

Parameters

klass

A class whose instances implement this interface

 

impl

A callback used to implement the GetFavouriteContacts D-Bus method

 

tp_svc_logger_implement_remove_favourite_contact ()

void
tp_svc_logger_implement_remove_favourite_contact
                               (TpSvcLoggerClass *klass,
                                tp_svc_logger_remove_favourite_contact_impl impl);

Register an implementation for the RemoveFavouriteContact method in the vtable of an implementation of this interface. To be called from the interface init function.

Parameters

klass

A class whose instances implement this interface

 

impl

A callback used to implement the RemoveFavouriteContact D-Bus method

 

tp_svc_logger_remove_favourite_contact_impl ()

void
(*tp_svc_logger_remove_favourite_contact_impl)
                               (TpSvcLogger *self,
                                const gchar *in_Account,
                                const gchar *in_Identifier,
                                GDBusMethodInvocation *invocation);

The signature of an implementation of the D-Bus method RemoveFavouriteContact on interface im.telepathy.v1.Logger1.

Parameters

self

The object implementing this interface

 

in_Account

const gchar * (FIXME, generate documentation)

 

in_Identifier

const gchar * (FIXME, generate documentation)

 

invocation

Used to return values or throw an error

 

tp_svc_logger_return_from_add_favourite_contact ()

void
tp_svc_logger_return_from_add_favourite_contact
                               (GDBusMethodInvocation *invocation);

Return successfully by calling g_dbus_method_invocation_return_value().

Parameters

invocation

The D-Bus method invocation context

 

tp_svc_logger_return_from_clear ()

void
tp_svc_logger_return_from_clear (GDBusMethodInvocation *invocation);

Return successfully by calling g_dbus_method_invocation_return_value().

Parameters

invocation

The D-Bus method invocation context

 

tp_svc_logger_return_from_clear_account ()

void
tp_svc_logger_return_from_clear_account
                               (GDBusMethodInvocation *invocation);

Return successfully by calling g_dbus_method_invocation_return_value().

Parameters

invocation

The D-Bus method invocation context

 

tp_svc_logger_return_from_clear_entity ()

void
tp_svc_logger_return_from_clear_entity
                               (GDBusMethodInvocation *invocation);

Return successfully by calling g_dbus_method_invocation_return_value().

Parameters

invocation

The D-Bus method invocation context

 

tp_svc_logger_return_from_get_favourite_contacts ()

void
tp_svc_logger_return_from_get_favourite_contacts
                               (GDBusMethodInvocation *invocation,
                                const GPtrArray *out_Favourite_Contacts);

Return successfully by calling g_dbus_method_invocation_return_value().

Parameters

invocation

The D-Bus method invocation context

 

out_Favourite_Contacts

const GPtrArray * (FIXME, generate documentation)

 

tp_svc_logger_return_from_remove_favourite_contact ()

void
tp_svc_logger_return_from_remove_favourite_contact
                               (GDBusMethodInvocation *invocation);

Return successfully by calling g_dbus_method_invocation_return_value().

Parameters

invocation

The D-Bus method invocation context

 

Types and Values

TpSvcLogger

typedef struct _TpSvcLogger TpSvcLogger;

Dummy typedef representing any implementation of this interface.


TpSvcLoggerClass

typedef struct _TpSvcLoggerClass TpSvcLoggerClass;

The class of TpSvcLogger.

In a full implementation of this interface (i.e. all methods implemented), the interface initialization function used in G_IMPLEMENT_INTERFACE() would typically look like this:

static void
implement_logger (gpointer klass,
    gpointer unused G_GNUC_UNUSED)
{
#define IMPLEMENT(x) tp_svc_logger_implement_##x (\
  klass, my_object_##x)
  IMPLEMENT (get_favourite_contacts);
  IMPLEMENT (add_favourite_contact);
  IMPLEMENT (remove_favourite_contact);
  IMPLEMENT (clear);
  IMPLEMENT (clear_account);
  IMPLEMENT (clear_entity);
#undef IMPLEMENT
}

Signal Details

The “favourite-contacts-changed” signal

void
user_function (TpSvcLogger     *self,
               DBusGObjectPath *arg_Account,
               GStrv            arg_Added,
               GStrv            arg_Removed,
               gpointer         user_data)

The FavouriteContactsChanged D-Bus signal is emitted whenever this GObject signal is.

Parameters

self

an object

 

arg_Account

const gchar * (FIXME, generate documentation)

 

arg_Added

const gchar ** (FIXME, generate documentation)

 

arg_Removed

const gchar ** (FIXME, generate documentation)

 

user_data

user data set when the signal handler was connected.

 

Flags: Has Details