GoaContacts

GoaContacts — Generated C code for the org.gnome.OnlineAccounts.Contacts D-Bus interface

Synopsis

                    GoaContacts;
struct              GoaContactsIface;
GDBusInterfaceInfo * goa_contacts_interface_info        (void);
guint               goa_contacts_override_properties    (GObjectClass *klass,
                                                         guint property_id_begin);
const gchar *       goa_contacts_get_uri                (GoaContacts *object);
gchar *             goa_contacts_dup_uri                (GoaContacts *object);
void                goa_contacts_set_uri                (GoaContacts *object,
                                                         const gchar *value);
struct              GoaContactsProxy;
struct              GoaContactsProxyClass;
void                goa_contacts_proxy_new              (GDBusConnection *connection,
                                                         GDBusProxyFlags flags,
                                                         const gchar *name,
                                                         const gchar *object_path,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
GoaContacts *       goa_contacts_proxy_new_finish       (GAsyncResult *res,
                                                         GError **error);
GoaContacts *       goa_contacts_proxy_new_sync         (GDBusConnection *connection,
                                                         GDBusProxyFlags flags,
                                                         const gchar *name,
                                                         const gchar *object_path,
                                                         GCancellable *cancellable,
                                                         GError **error);
void                goa_contacts_proxy_new_for_bus      (GBusType bus_type,
                                                         GDBusProxyFlags flags,
                                                         const gchar *name,
                                                         const gchar *object_path,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
GoaContacts *       goa_contacts_proxy_new_for_bus_finish
                                                        (GAsyncResult *res,
                                                         GError **error);
GoaContacts *       goa_contacts_proxy_new_for_bus_sync (GBusType bus_type,
                                                         GDBusProxyFlags flags,
                                                         const gchar *name,
                                                         const gchar *object_path,
                                                         GCancellable *cancellable,
                                                         GError **error);
struct              GoaContactsSkeleton;
struct              GoaContactsSkeletonClass;
GoaContacts *       goa_contacts_skeleton_new           (void);

Object Hierarchy

  GInterface
   +----GoaContacts
  GObject
   +----GDBusProxy
         +----GoaContactsProxy
  GObject
   +----GDBusInterfaceSkeleton
         +----GoaContactsSkeleton

Prerequisites

GoaContacts requires GObject.

Implemented Interfaces

GoaContactsProxy implements GDBusInterface, GInitable, GAsyncInitable and GoaContacts.

GoaContactsSkeleton implements GDBusInterface and GoaContacts.

Known Implementations

GoaContacts is implemented by GoaContactsProxy and GoaContactsSkeleton.

Properties

  "uri"                      gchar*                : Read / Write

Description

This section contains code for working with the org.gnome.OnlineAccounts.Contacts D-Bus interface in C.

Details

GoaContacts

typedef struct _GoaContacts GoaContacts;

Abstract interface type for the D-Bus interface org.gnome.OnlineAccounts.Contacts.


struct GoaContactsIface

struct GoaContactsIface {
  GTypeInterface parent_iface;

  const gchar * (*get_uri) (GoaContacts *object);
};

Virtual table for the D-Bus interface org.gnome.OnlineAccounts.Contacts.

GTypeInterface parent_iface;

The parent interface.

get_uri ()

Getter for the "uri" property.

goa_contacts_interface_info ()

GDBusInterfaceInfo * goa_contacts_interface_info        (void);

Gets a machine-readable description of the org.gnome.OnlineAccounts.Contacts D-Bus interface.

Returns :

A GDBusInterfaceInfo. Do not free. [transfer none]

goa_contacts_override_properties ()

guint               goa_contacts_override_properties    (GObjectClass *klass,
                                                         guint property_id_begin);

Overrides all GObject properties in the GoaContacts interface for a concrete class. The properties are overridden in the order they are defined.

klass :

The class structure for a GObject-derived class.

property_id_begin :

The property id to assign to the first overridden property.

Returns :

The last property id.

goa_contacts_get_uri ()

const gchar *       goa_contacts_get_uri                (GoaContacts *object);

Gets the value of the "Uri" D-Bus property.

Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.

Warning

The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where object was constructed. Use goa_contacts_dup_uri() if on another thread.

object :

A GoaContacts.

Returns :

The property value or NULL if the property is not set. Do not free the returned value, it belongs to object. [transfer none]

Since 3.8.0


goa_contacts_dup_uri ()

gchar *             goa_contacts_dup_uri                (GoaContacts *object);

Gets a copy of the "Uri" D-Bus property.

Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.

object :

A GoaContacts.

Returns :

The property value or NULL if the property is not set. The returned value should be freed with g_free(). [transfer full]

Since 3.8.0


goa_contacts_set_uri ()

void                goa_contacts_set_uri                (GoaContacts *object,
                                                         const gchar *value);

Sets the "Uri" D-Bus property to value.

Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side.

object :

A GoaContacts.

value :

The value to set.

Since 3.8.0


struct GoaContactsProxy

struct GoaContactsProxy;

The GoaContactsProxy structure contains only private data and should only be accessed using the provided API.


struct GoaContactsProxyClass

struct GoaContactsProxyClass {
  GDBusProxyClass parent_class;
};

Class structure for GoaContactsProxy.

GDBusProxyClass parent_class;

The parent class.

goa_contacts_proxy_new ()

void                goa_contacts_proxy_new              (GDBusConnection *connection,
                                                         GDBusProxyFlags flags,
                                                         const gchar *name,
                                                         const gchar *object_path,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Asynchronously creates a proxy for the D-Bus interface org.gnome.OnlineAccounts.Contacts. See g_dbus_proxy_new() for more details.

When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from. You can then call goa_contacts_proxy_new_finish() to get the result of the operation.

See goa_contacts_proxy_new_sync() for the synchronous, blocking version of this constructor.

connection :

A GDBusConnection.

flags :

Flags from the GDBusProxyFlags enumeration.

name :

A bus name (well-known or unique) or NULL if connection is not a message bus connection. [allow-none]

object_path :

An object path.

cancellable :

A GCancellable or NULL. [allow-none]

callback :

A GAsyncReadyCallback to call when the request is satisfied.

user_data :

User data to pass to callback.

goa_contacts_proxy_new_finish ()

GoaContacts *       goa_contacts_proxy_new_finish       (GAsyncResult *res,
                                                         GError **error);

Finishes an operation started with goa_contacts_proxy_new().

res :

The GAsyncResult obtained from the GAsyncReadyCallback passed to goa_contacts_proxy_new().

error :

Return location for error or NULL

Returns :

The constructed proxy object or NULL if error is set. [transfer full][type GoaContactsProxy]

goa_contacts_proxy_new_sync ()

GoaContacts *       goa_contacts_proxy_new_sync         (GDBusConnection *connection,
                                                         GDBusProxyFlags flags,
                                                         const gchar *name,
                                                         const gchar *object_path,
                                                         GCancellable *cancellable,
                                                         GError **error);

Synchronously creates a proxy for the D-Bus interface org.gnome.OnlineAccounts.Contacts. See g_dbus_proxy_new_sync() for more details.

The calling thread is blocked until a reply is received.

See goa_contacts_proxy_new() for the asynchronous version of this constructor.

connection :

A GDBusConnection.

flags :

Flags from the GDBusProxyFlags enumeration.

name :

A bus name (well-known or unique) or NULL if connection is not a message bus connection. [allow-none]

object_path :

An object path.

cancellable :

A GCancellable or NULL. [allow-none]

error :

Return location for error or NULL

Returns :

The constructed proxy object or NULL if error is set. [transfer full][type GoaContactsProxy]

goa_contacts_proxy_new_for_bus ()

void                goa_contacts_proxy_new_for_bus      (GBusType bus_type,
                                                         GDBusProxyFlags flags,
                                                         const gchar *name,
                                                         const gchar *object_path,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Like goa_contacts_proxy_new() but takes a GBusType instead of a GDBusConnection.

When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from. You can then call goa_contacts_proxy_new_for_bus_finish() to get the result of the operation.

See goa_contacts_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor.

bus_type :

A GBusType.

flags :

Flags from the GDBusProxyFlags enumeration.

name :

A bus name (well-known or unique).

object_path :

An object path.

cancellable :

A GCancellable or NULL. [allow-none]

callback :

A GAsyncReadyCallback to call when the request is satisfied.

user_data :

User data to pass to callback.

goa_contacts_proxy_new_for_bus_finish ()

GoaContacts *       goa_contacts_proxy_new_for_bus_finish
                                                        (GAsyncResult *res,
                                                         GError **error);

Finishes an operation started with goa_contacts_proxy_new_for_bus().

res :

The GAsyncResult obtained from the GAsyncReadyCallback passed to goa_contacts_proxy_new_for_bus().

error :

Return location for error or NULL

Returns :

The constructed proxy object or NULL if error is set. [transfer full][type GoaContactsProxy]

goa_contacts_proxy_new_for_bus_sync ()

GoaContacts *       goa_contacts_proxy_new_for_bus_sync (GBusType bus_type,
                                                         GDBusProxyFlags flags,
                                                         const gchar *name,
                                                         const gchar *object_path,
                                                         GCancellable *cancellable,
                                                         GError **error);

Like goa_contacts_proxy_new_sync() but takes a GBusType instead of a GDBusConnection.

The calling thread is blocked until a reply is received.

See goa_contacts_proxy_new_for_bus() for the asynchronous version of this constructor.

bus_type :

A GBusType.

flags :

Flags from the GDBusProxyFlags enumeration.

name :

A bus name (well-known or unique).

object_path :

An object path.

cancellable :

A GCancellable or NULL. [allow-none]

error :

Return location for error or NULL

Returns :

The constructed proxy object or NULL if error is set. [transfer full][type GoaContactsProxy]

struct GoaContactsSkeleton

struct GoaContactsSkeleton;

The GoaContactsSkeleton structure contains only private data and should only be accessed using the provided API.


struct GoaContactsSkeletonClass

struct GoaContactsSkeletonClass {
  GDBusInterfaceSkeletonClass parent_class;
};

Class structure for GoaContactsSkeleton.

GDBusInterfaceSkeletonClass parent_class;

The parent class.

goa_contacts_skeleton_new ()

GoaContacts *       goa_contacts_skeleton_new           (void);

Creates a skeleton object for the D-Bus interface org.gnome.OnlineAccounts.Contacts.

Returns :

The skeleton object. [transfer full][type GoaContactsSkeleton]

Property Details

The "uri" property

  "uri"                      gchar*                : Read / Write

Represents the D-Bus property "Uri".

Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

Default value: NULL

Since 3.8.0