GNOME.org

GoaObject

GoaObject — Specialized GDBusObject types

Synopsis

                    GoaObject;
struct              GoaObjectIface;
GoaManager *        goa_object_get_manager              (GoaObject *object);
GoaAccount *        goa_object_get_account              (GoaObject *object);
GoaOAuthBased *     goa_object_get_oauth_based          (GoaObject *object);
GoaOAuth2Based *    goa_object_get_oauth2_based         (GoaObject *object);
GoaMail *           goa_object_get_mail                 (GoaObject *object);
GoaCalendar *       goa_object_get_calendar             (GoaObject *object);
GoaContacts *       goa_object_get_contacts             (GoaObject *object);
GoaChat *           goa_object_get_chat                 (GoaObject *object);
GoaDocuments *      goa_object_get_documents            (GoaObject *object);
GoaExchange *       goa_object_get_exchange             (GoaObject *object);
GoaManager *        goa_object_peek_manager             (GoaObject *object);
GoaAccount *        goa_object_peek_account             (GoaObject *object);
GoaOAuthBased *     goa_object_peek_oauth_based         (GoaObject *object);
GoaOAuth2Based *    goa_object_peek_oauth2_based        (GoaObject *object);
GoaMail *           goa_object_peek_mail                (GoaObject *object);
GoaCalendar *       goa_object_peek_calendar            (GoaObject *object);
GoaContacts *       goa_object_peek_contacts            (GoaObject *object);
GoaChat *           goa_object_peek_chat                (GoaObject *object);
GoaDocuments *      goa_object_peek_documents           (GoaObject *object);
GoaExchange *       goa_object_peek_exchange            (GoaObject *object);
struct              GoaObjectProxy;
struct              GoaObjectProxyClass;
GoaObjectProxy *    goa_object_proxy_new                (GDBusConnection *connection,
                                                         const gchar *object_path);
struct              GoaObjectSkeleton;
struct              GoaObjectSkeletonClass;
GoaObjectSkeleton * goa_object_skeleton_new             (const gchar *object_path);
void                goa_object_skeleton_set_manager     (GoaObjectSkeleton *object,
                                                         GoaManager *interface_);
void                goa_object_skeleton_set_account     (GoaObjectSkeleton *object,
                                                         GoaAccount *interface_);
void                goa_object_skeleton_set_oauth_based (GoaObjectSkeleton *object,
                                                         GoaOAuthBased *interface_);
void                goa_object_skeleton_set_oauth2_based
                                                        (GoaObjectSkeleton *object,
                                                         GoaOAuth2Based *interface_);
void                goa_object_skeleton_set_mail        (GoaObjectSkeleton *object,
                                                         GoaMail *interface_);
void                goa_object_skeleton_set_calendar    (GoaObjectSkeleton *object,
                                                         GoaCalendar *interface_);
void                goa_object_skeleton_set_contacts    (GoaObjectSkeleton *object,
                                                         GoaContacts *interface_);
void                goa_object_skeleton_set_chat        (GoaObjectSkeleton *object,
                                                         GoaChat *interface_);
void                goa_object_skeleton_set_documents   (GoaObjectSkeleton *object,
                                                         GoaDocuments *interface_);
void                goa_object_skeleton_set_exchange    (GoaObjectSkeleton *object,
                                                         GoaExchange *interface_);

Object Hierarchy

  GInterface
   +----GoaObject

  GObject
   +----GDBusObjectProxy
         +----GoaObjectProxy

  GObject
   +----GDBusObjectSkeleton
         +----GoaObjectSkeleton

Prerequisites

GoaObject requires GDBusObject and GObject.

Implemented Interfaces

GoaObjectProxy implements GDBusObject and GoaObject.

GoaObjectSkeleton implements GDBusObject and GoaObject.

Known Implementations

GoaObject is implemented by GoaObjectProxy and GoaObjectSkeleton.

Properties

  "account"                  GoaAccount*           : Read / Write
  "calendar"                 GoaCalendar*          : Read / Write
  "chat"                     GoaChat*              : Read / Write
  "contacts"                 GoaContacts*          : Read / Write
  "documents"                GoaDocuments*         : Read / Write
  "exchange"                 GoaExchange*          : Read / Write
  "mail"                     GoaMail*              : Read / Write
  "manager"                  GoaManager*           : Read / Write
  "oauth-based"              GoaOAuthBased*        : Read / Write
  "oauth2-based"             GoaOAuth2Based*       : Read / Write
  "password-based"           GoaPasswordBased*     : Read / Write
  "ticketing"                GoaTicketing*         : Read / Write

Description

This section contains the GoaObject, GoaObjectProxy, and GoaObjectSkeleton types which make it easier to work with objects implementing generated types for D-Bus interfaces.

Details

GoaObject

typedef struct _GoaObject GoaObject;

The GoaObject type is a specialized container of interfaces.

struct GoaObjectIface

struct GoaObjectIface {
  GTypeInterface parent_iface;
};

Virtual table for the GoaObject interface.

GTypeInterface parent_iface;

 The parent interface.

goa_object_get_manager ()

GoaManager *        goa_object_get_manager              (GoaObject *object);

Gets the GoaManager instance for the D-Bus interface org.gnome.OnlineAccounts.Manager on object, if any.

object :

 A GoaObject.

Returns :

 A GoaManager that must be freed with g_object_unref() or NULL if object does not implement the interface. [transfer full]

goa_object_get_account ()

GoaAccount *        goa_object_get_account              (GoaObject *object);

Gets the GoaAccount instance for the D-Bus interface org.gnome.OnlineAccounts.Account on object, if any.

object :

 A GoaObject.

Returns :

 A GoaAccount that must be freed with g_object_unref() or NULL if object does not implement the interface. [transfer full]

goa_object_get_oauth_based ()

GoaOAuthBased *     goa_object_get_oauth_based          (GoaObject *object);

Gets the GoaOAuthBased instance for the D-Bus interface org.gnome.OnlineAccounts.OAuthBased on object, if any.

object :

 A GoaObject.

Returns :

 A GoaOAuthBased that must be freed with g_object_unref() or NULL if object does not implement the interface. [transfer full]

goa_object_get_oauth2_based ()

GoaOAuth2Based *    goa_object_get_oauth2_based         (GoaObject *object);

Gets the GoaOAuth2Based instance for the D-Bus interface org.gnome.OnlineAccounts.OAuth2Based on object, if any.

object :

 A GoaObject.

Returns :

 A GoaOAuth2Based that must be freed with g_object_unref() or NULL if object does not implement the interface. [transfer full]

goa_object_get_mail ()

GoaMail *           goa_object_get_mail                 (GoaObject *object);

Gets the GoaMail instance for the D-Bus interface org.gnome.OnlineAccounts.Mail on object, if any.

object :

 A GoaObject.

Returns :

 A GoaMail that must be freed with g_object_unref() or NULL if object does not implement the interface. [transfer full]

goa_object_get_calendar ()

GoaCalendar *       goa_object_get_calendar             (GoaObject *object);

Gets the GoaCalendar instance for the D-Bus interface org.gnome.OnlineAccounts.Calendar on object, if any.

object :

 A GoaObject.

Returns :

 A GoaCalendar that must be freed with g_object_unref() or NULL if object does not implement the interface. [transfer full]

goa_object_get_contacts ()

GoaContacts *       goa_object_get_contacts             (GoaObject *object);

Gets the GoaContacts instance for the D-Bus interface org.gnome.OnlineAccounts.Contacts on object, if any.

object :

 A GoaObject.

Returns :

 A GoaContacts that must be freed with g_object_unref() or NULL if object does not implement the interface. [transfer full]

goa_object_get_chat ()

GoaChat *           goa_object_get_chat                 (GoaObject *object);

Gets the GoaChat instance for the D-Bus interface org.gnome.OnlineAccounts.Chat on object, if any.

object :

 A GoaObject.

Returns :

 A GoaChat that must be freed with g_object_unref() or NULL if object does not implement the interface. [transfer full]

goa_object_get_documents ()

GoaDocuments *      goa_object_get_documents            (GoaObject *object);

Gets the GoaDocuments instance for the D-Bus interface org.gnome.OnlineAccounts.Documents on object, if any.

object :

 A GoaObject.

Returns :

 A GoaDocuments that must be freed with g_object_unref() or NULL if object does not implement the interface. [transfer full]

goa_object_get_exchange ()

GoaExchange *       goa_object_get_exchange             (GoaObject *object);

Gets the GoaExchange instance for the D-Bus interface org.gnome.OnlineAccounts.Exchange on object, if any.

object :

 A GoaObject.

Returns :

 A GoaExchange that must be freed with g_object_unref() or NULL if object does not implement the interface. [transfer full]

Since 3.6.0

goa_object_peek_manager ()

GoaManager *        goa_object_peek_manager             (GoaObject *object);

Like goa_object_get_manager() but doesn't increase the reference count on the returned object.

Warning

It is not safe to use the returned object if you are on another thread than the one where the GDBusObjectManagerClient or GDBusObjectManagerServer for object is running.

object :

 A GoaObject.

Returns :

 A GoaManager or NULL if object does not implement the interface. Do not free the returned object, it is owned by object. [transfer none]

goa_object_peek_account ()

GoaAccount *        goa_object_peek_account             (GoaObject *object);

Like goa_object_get_account() but doesn't increase the reference count on the returned object.

Warning

It is not safe to use the returned object if you are on another thread than the one where the GDBusObjectManagerClient or GDBusObjectManagerServer for object is running.

object :

 A GoaObject.

Returns :

 A GoaAccount or NULL if object does not implement the interface. Do not free the returned object, it is owned by object. [transfer none]

goa_object_peek_oauth_based ()

GoaOAuthBased *     goa_object_peek_oauth_based         (GoaObject *object);

Like goa_object_get_oauth_based() but doesn't increase the reference count on the returned object.

Warning

It is not safe to use the returned object if you are on another thread than the one where the GDBusObjectManagerClient or GDBusObjectManagerServer for object is running.

object :

 A GoaObject.

Returns :

 A GoaOAuthBased or NULL if object does not implement the interface. Do not free the returned object, it is owned by object. [transfer none]

goa_object_peek_oauth2_based ()

GoaOAuth2Based *    goa_object_peek_oauth2_based        (GoaObject *object);

Like goa_object_get_oauth2_based() but doesn't increase the reference count on the returned object.

Warning

It is not safe to use the returned object if you are on another thread than the one where the GDBusObjectManagerClient or GDBusObjectManagerServer for object is running.

object :

 A GoaObject.

Returns :

 A GoaOAuth2Based or NULL if object does not implement the interface. Do not free the returned object, it is owned by object. [transfer none]

goa_object_peek_mail ()

GoaMail *           goa_object_peek_mail                (GoaObject *object);

Like goa_object_get_mail() but doesn't increase the reference count on the returned object.

Warning

It is not safe to use the returned object if you are on another thread than the one where the GDBusObjectManagerClient or GDBusObjectManagerServer for object is running.

object :

 A GoaObject.

Returns :

 A GoaMail or NULL if object does not implement the interface. Do not free the returned object, it is owned by object. [transfer none]

goa_object_peek_calendar ()

GoaCalendar *       goa_object_peek_calendar            (GoaObject *object);

Like goa_object_get_calendar() but doesn't increase the reference count on the returned object.

Warning

It is not safe to use the returned object if you are on another thread than the one where the GDBusObjectManagerClient or GDBusObjectManagerServer for object is running.

object :

 A GoaObject.

Returns :

 A GoaCalendar or NULL if object does not implement the interface. Do not free the returned object, it is owned by object. [transfer none]

goa_object_peek_contacts ()

GoaContacts *       goa_object_peek_contacts            (GoaObject *object);

Like goa_object_get_contacts() but doesn't increase the reference count on the returned object.

Warning

It is not safe to use the returned object if you are on another thread than the one where the GDBusObjectManagerClient or GDBusObjectManagerServer for object is running.

object :

 A GoaObject.

Returns :

 A GoaContacts or NULL if object does not implement the interface. Do not free the returned object, it is owned by object. [transfer none]

goa_object_peek_chat ()

GoaChat *           goa_object_peek_chat                (GoaObject *object);

Like goa_object_get_chat() but doesn't increase the reference count on the returned object.

Warning

It is not safe to use the returned object if you are on another thread than the one where the GDBusObjectManagerClient or GDBusObjectManagerServer for object is running.

object :

 A GoaObject.

Returns :

 A GoaChat or NULL if object does not implement the interface. Do not free the returned object, it is owned by object. [transfer none]

goa_object_peek_documents ()

GoaDocuments *      goa_object_peek_documents           (GoaObject *object);

Like goa_object_get_documents() but doesn't increase the reference count on the returned object.

Warning

It is not safe to use the returned object if you are on another thread than the one where the GDBusObjectManagerClient or GDBusObjectManagerServer for object is running.

object :

 A GoaObject.

Returns :

 A GoaDocuments or NULL if object does not implement the interface. Do not free the returned object, it is owned by object. [transfer none]

goa_object_peek_exchange ()

GoaExchange *       goa_object_peek_exchange            (GoaObject *object);

Like goa_object_get_exchange() but doesn't increase the reference count on the returned object.

Warning

It is not safe to use the returned object if you are on another thread than the one where the GDBusObjectManagerClient or GDBusObjectManagerServer for object is running.

object :

 A GoaObject.

Returns :

 A GoaExchange or NULL if object does not implement the interface. Do not free the returned object, it is owned by object. [transfer none]

Since 3.6.0

struct GoaObjectProxy

struct GoaObjectProxy;

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

struct GoaObjectProxyClass

struct GoaObjectProxyClass {
  GDBusObjectProxyClass parent_class;
};

Class structure for GoaObjectProxy.

GDBusObjectProxyClass parent_class;

 The parent class.

goa_object_proxy_new ()

GoaObjectProxy *    goa_object_proxy_new                (GDBusConnection *connection,
                                                         const gchar *object_path);

Creates a new proxy object.

connection :

 A GDBusConnection.

object_path :

 An object path.

Returns :

 The proxy object. [transfer full]

struct GoaObjectSkeleton

struct GoaObjectSkeleton;

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

struct GoaObjectSkeletonClass

struct GoaObjectSkeletonClass {
  GDBusObjectSkeletonClass parent_class;
};

Class structure for GoaObjectSkeleton.

GDBusObjectSkeletonClass parent_class;

 The parent class.

goa_object_skeleton_new ()

GoaObjectSkeleton * goa_object_skeleton_new             (const gchar *object_path);

Creates a new skeleton object.

object_path :

 An object path.

Returns :

 The skeleton object. [transfer full]

goa_object_skeleton_set_manager ()

void                goa_object_skeleton_set_manager     (GoaObjectSkeleton *object,
                                                         GoaManager *interface_);

Sets the GoaManager instance for the D-Bus interface org.gnome.OnlineAccounts.Manager on object.

object :

 A GoaObjectSkeleton.

interface_ :

 A GoaManager or NULL to clear the interface. [allow-none]

goa_object_skeleton_set_account ()

void                goa_object_skeleton_set_account     (GoaObjectSkeleton *object,
                                                         GoaAccount *interface_);

Sets the GoaAccount instance for the D-Bus interface org.gnome.OnlineAccounts.Account on object.

object :

 A GoaObjectSkeleton.

interface_ :

 A GoaAccount or NULL to clear the interface. [allow-none]

goa_object_skeleton_set_oauth_based ()

void                goa_object_skeleton_set_oauth_based (GoaObjectSkeleton *object,
                                                         GoaOAuthBased *interface_);

Sets the GoaOAuthBased instance for the D-Bus interface org.gnome.OnlineAccounts.OAuthBased on object.

object :

 A GoaObjectSkeleton.

interface_ :

 A GoaOAuthBased or NULL to clear the interface. [allow-none]

goa_object_skeleton_set_oauth2_based ()

void                goa_object_skeleton_set_oauth2_based
                                                        (GoaObjectSkeleton *object,
                                                         GoaOAuth2Based *interface_);

Sets the GoaOAuth2Based instance for the D-Bus interface org.gnome.OnlineAccounts.OAuth2Based on object.

object :

 A GoaObjectSkeleton.

interface_ :

 A GoaOAuth2Based or NULL to clear the interface. [allow-none]

goa_object_skeleton_set_mail ()

void                goa_object_skeleton_set_mail        (GoaObjectSkeleton *object,
                                                         GoaMail *interface_);

Sets the GoaMail instance for the D-Bus interface org.gnome.OnlineAccounts.Mail on object.

object :

 A GoaObjectSkeleton.

interface_ :

 A GoaMail or NULL to clear the interface. [allow-none]

goa_object_skeleton_set_calendar ()

void                goa_object_skeleton_set_calendar    (GoaObjectSkeleton *object,
                                                         GoaCalendar *interface_);

Sets the GoaCalendar instance for the D-Bus interface org.gnome.OnlineAccounts.Calendar on object.

object :

 A GoaObjectSkeleton.

interface_ :

 A GoaCalendar or NULL to clear the interface. [allow-none]

goa_object_skeleton_set_contacts ()

void                goa_object_skeleton_set_contacts    (GoaObjectSkeleton *object,
                                                         GoaContacts *interface_);

Sets the GoaContacts instance for the D-Bus interface org.gnome.OnlineAccounts.Contacts on object.

object :

 A GoaObjectSkeleton.

interface_ :

 A GoaContacts or NULL to clear the interface. [allow-none]

goa_object_skeleton_set_chat ()

void                goa_object_skeleton_set_chat        (GoaObjectSkeleton *object,
                                                         GoaChat *interface_);

Sets the GoaChat instance for the D-Bus interface org.gnome.OnlineAccounts.Chat on object.

object :

 A GoaObjectSkeleton.

interface_ :

 A GoaChat or NULL to clear the interface. [allow-none]

goa_object_skeleton_set_documents ()

void                goa_object_skeleton_set_documents   (GoaObjectSkeleton *object,
                                                         GoaDocuments *interface_);

Sets the GoaDocuments instance for the D-Bus interface org.gnome.OnlineAccounts.Documents on object.

object :

 A GoaObjectSkeleton.

interface_ :

 A GoaDocuments or NULL to clear the interface. [allow-none]

goa_object_skeleton_set_exchange ()

void                goa_object_skeleton_set_exchange    (GoaObjectSkeleton *object,
                                                         GoaExchange *interface_);

Sets the GoaExchange instance for the D-Bus interface org.gnome.OnlineAccounts.Exchange on object.

object :

 A GoaObjectSkeleton.

interface_ :

 A GoaExchange or NULL to clear the interface. [allow-none]

Since 3.6.0

Property Details

The "account" property

  "account"                  GoaAccount*           : Read / Write

The GoaAccount instance corresponding to the D-Bus interface org.gnome.OnlineAccounts.Account, if any.

Connect to the "notify" signal to get informed of property changes.

The "calendar" property

  "calendar"                 GoaCalendar*          : Read / Write

The GoaCalendar instance corresponding to the D-Bus interface org.gnome.OnlineAccounts.Calendar, if any.

Connect to the "notify" signal to get informed of property changes.

The "chat" property

  "chat"                     GoaChat*              : Read / Write

The GoaChat instance corresponding to the D-Bus interface org.gnome.OnlineAccounts.Chat, if any.

Connect to the "notify" signal to get informed of property changes.

The "contacts" property

  "contacts"                 GoaContacts*          : Read / Write

The GoaContacts instance corresponding to the D-Bus interface org.gnome.OnlineAccounts.Contacts, if any.

Connect to the "notify" signal to get informed of property changes.

The "documents" property

  "documents"                GoaDocuments*         : Read / Write

The GoaDocuments instance corresponding to the D-Bus interface org.gnome.OnlineAccounts.Documents, if any.

Connect to the "notify" signal to get informed of property changes.

The "exchange" property

  "exchange"                 GoaExchange*          : Read / Write

The GoaExchange instance corresponding to the D-Bus interface org.gnome.OnlineAccounts.Exchange, if any.

Connect to the "notify" signal to get informed of property changes.

Since 3.6.0

The "mail" property

  "mail"                     GoaMail*              : Read / Write

The GoaMail instance corresponding to the D-Bus interface org.gnome.OnlineAccounts.Mail, if any.

Connect to the "notify" signal to get informed of property changes.

The "manager" property

  "manager"                  GoaManager*           : Read / Write

The GoaManager instance corresponding to the D-Bus interface org.gnome.OnlineAccounts.Manager, if any.

Connect to the "notify" signal to get informed of property changes.

The "oauth-based" property

  "oauth-based"              GoaOAuthBased*        : Read / Write

The GoaOAuthBased instance corresponding to the D-Bus interface org.gnome.OnlineAccounts.OAuthBased, if any.

Connect to the "notify" signal to get informed of property changes.

The "oauth2-based" property

  "oauth2-based"             GoaOAuth2Based*       : Read / Write

The GoaOAuth2Based instance corresponding to the D-Bus interface org.gnome.OnlineAccounts.OAuth2Based, if any.

Connect to the "notify" signal to get informed of property changes.

The "password-based" property

  "password-based"           GoaPasswordBased*     : Read / Write

The GoaPasswordBased instance corresponding to the D-Bus interface org.gnome.OnlineAccounts.PasswordBased, if any.

Connect to the "notify" signal to get informed of property changes.

Since 3.6.0

The "ticketing" property

  "ticketing"                GoaTicketing*         : Read / Write

The GoaTicketing instance corresponding to the D-Bus interface org.gnome.OnlineAccounts.Ticketing, if any.

Connect to the "notify" signal to get informed of property changes.

Generated by GTK-Doc V1.18