Gjsify LogoGjsify Logo

Contains only private data that should be read and manipulated using the functions below.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Properties

cache: BookCache

The #EBookCache being used for this meta backend.

cache_dir: string
connectable: SocketConnectable
g_type_instance: TypeInstance
main_context: MainContext
online: boolean
proxy_resolver: Gio.ProxyResolver
registry: SourceRegistry
user_prompter: UserPrompter
writable: boolean
name: string

Methods

  • Creates a binding between source_property on source and target_property on target.

    Whenever the source_property is changed the target_property is updated using the same value. For instance:

      g_object_bind_property (action, "active", widget, "sensitive", 0);
    

    Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.

    If flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well.

    The binding will automatically be removed when either the source or the target instances are finalized. To remove the binding without affecting the source and the target you can just call g_object_unref() on the returned #GBinding instance.

    Removing the binding by calling g_object_unref() on it must only be done if the binding, source and target are only used from a single thread and it is clear that both source and target outlive the binding. Especially it is not safe to rely on this if the binding, source or target can be finalized from different threads. Keep another reference to the binding and use g_binding_unbind() instead to be on the safe side.

    A #GObject can have multiple bindings.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns Binding

  • Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transform_to: TClosure<any, any>

      a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default

    • transform_from: TClosure<any, any>

      a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default

    Returns Binding

  • configure_direct(config: string): void
  • This method is called on backend in direct read access mode. The config argument is the same configuration string which the same backend reported in the #EDataBookDirect returned by e_book_backend_get_direct_book().

    The configuration string is optional and is used to ensure that direct access backends are properly configured to interface with the same data as the running server side backend.

    Parameters

    • config: string

      The configuration string for the given backend

    Returns void

  • This is called always before any operation which requires a connection to the remote side. It can fail with an #E_CLIENT_ERROR_REPOSITORY_OFFLINE error to indicate that the remote side cannot be currently reached. Other errors are propagated to the caller/client side. This method is not called when the backend is offline.

    The descendant should also call e_book_backend_set_writable() after successful connect to the remote side. This value is stored for later use, when being opened offline.

    The credentials parameter consists of the previously used credentials. It's always %NULL with the first connection attempt. To get the credentials, just set the out_auth_result to %E_SOURCE_AUTHENTICATION_REQUIRED for the first time and the function will be called again once the credentials are available. See the documentation of #ESourceAuthenticationResult for other available results.

    The out parameters are passed to e_backend_schedule_credentials_required() and are ignored when the descendant returns %TRUE, aka they are used only if the connection fails. The out_certificate_pem and out_certificate_errors should be used together and they can be left untouched if the failure reason was not related to certificate. Use out_auth_result %E_SOURCE_AUTHENTICATION_UNKNOWN to indicate other error than credentials error, otherwise the error is used according to out_auth_result value.

    It is mandatory to implement this virtual method by the descendant.

    Parameters

    • credentials: NamedParameters

      an #ENamedParameters with previously used credentials, or %NULL

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns [boolean, SourceAuthenticationResult, string, TlsCertificateFlags]

  • contains_email(...args: any[]): any
  • Checks whether contains an email_address. When the email_address contains multiple addresses, then returns %TRUE when at least one address exists in the address book.

    If an error occurs, the function will set error and return %FALSE.

    Parameters

    • Rest ...args: any[]

    Returns any

  • contains_email_sync(email_address: string, cancellable: Gio.Cancellable): boolean
  • Checks whether contains an email_address. When the email_address contains multiple addresses, then returns %TRUE when at least one address exists in the address book.

    If an error occurs, the function will set error and return %FALSE.

    Parameters

    • email_address: string

      an email address

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • create_contacts(...args: any[]): any
  • Creates one or more new contacts from vcards, and deposits an #EContact instance for each newly-created contact in out_contacts.

    The returned #EContact instances are referenced for thread-safety and must be unreferenced with g_object_unref() when finished with them.

    If an error occurs, the function will set error and return %FALSE.

    Parameters

    • Rest ...args: any[]

    Returns any

  • Finishes the operation started with e_book_backend_create_contacts().

    An #EContact instance for each newly-created contact is deposited in out_contacts. The returned #EContact instances are referenced for thread-safety and must be unreferenced with g_object_unref() when finished with them.

    If an error occurred, the function will set error and return %FALSE.

    Parameters

    Returns boolean

  • create_contacts_sync(vcards: string, opflags: number, out_contacts: GLib.Queue, cancellable: Gio.Cancellable): boolean
  • Creates one or more new contacts from vcards, and deposits an #EContact instance for each newly-created contact in out_contacts.

    The returned #EContact instances are referenced for thread-safety and must be unreferenced with g_object_unref() when finished with them.

    If an error occurs, the function will set error and return %FALSE.

    Parameters

    • vcards: string

      a %NULL-terminated array of vCard strings

    • opflags: number

      bit-or of #EBookOperationFlags

    • out_contacts: GLib.Queue

      a #GQueue in which to deposit results

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • Creates a new #EDataBookCursor for the given backend if the backend has cursor support. If the backend does not support cursors then an %E_CLIENT_ERROR_NOT_SUPPORTED error will be set in error.

    Backends can also refuse to create cursors for some values of sort_fields and report more specific errors.

    The returned cursor belongs to backend and should be destroyed with e_book_backend_delete_cursor() when no longer needed.

    Parameters

    • sort_fields: ContactField

      the #EContactFields to sort by

    • sort_types: BookCursorSortType

      the #EBookCursorSortTypes for the sorted fields

    • n_fields: number

      the number of fields in the sort_fields and sort_types

    Returns DataBookCursor

  • Asynchronously calls the e_backend_credentials_required_sync() on the backend, to inform clients that credentials are required.

    When the operation is finished, callback will be called. You can then call e_backend_credentials_required_finish() to get the result of the operation.

    Parameters

    • reason: SourceCredentialsReason

      an #ESourceCredentialsReason, why the credentials are required

    • certificate_pem: string

      PEM-encoded secure connection certificate, or an empty string

    • certificate_errors: TlsCertificateFlags

      a bit-or of #GTlsCertificateFlags for secure connection certificate

    • op_error: GLib.Error

      a #GError with a description of the previous credentials error, or %NULL

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • credentials_required_finish(result: AsyncResult): boolean
  • Synchronously lets the clients know that the backned requires credentials to be properly opened. It's a proxy function for e_source_invoke_credentials_required_sync(), where can be found more information about actual parameters meaning.

    The provided credentials are received through #EBackendClass.authenticate_sync() method asynchronously.

    If an error occurs, the function sets error and returns %FALSE.

    Parameters

    • reason: SourceCredentialsReason

      an #ESourceCredentialsReason, why the credentials are required

    • certificate_pem: string

      PEM-encoded secure connection certificate, or an empty string

    • certificate_errors: TlsCertificateFlags

      a bit-or of #GTlsCertificateFlags for secure connection certificate

    • op_error: GLib.Error

      a #GError with a description of the previous credentials error, or %NULL

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • disconnect(id: number): void
  • This is called when the backend goes into offline mode or when the disconnect is required. The implementation should not report any error when it is called and the meta_backend is not connected.

    It is mandatory to implement this virtual method by the descendant.

    Parameters

    Returns boolean

  • dup_cache_dir(): string
  • dup_locale(): string
  • dup_sync_tag(): string
  • Returns the last known synchronization tag, the same as used to call e_book_meta_backend_get_changes_sync().

    Free the returned string with g_free(), when no longer needed.

    Returns string

  • emit(sigName: "refresh-completed", ...args: any[]): void
  • emit(sigName: "source-changed", ...args: any[]): void
  • emit(sigName: "notify::cache", ...args: any[]): void
  • emit(sigName: "notify::cache-dir", ...args: any[]): void
  • emit(sigName: "notify::proxy-resolver", ...args: any[]): void
  • emit(sigName: "notify::registry", ...args: any[]): void
  • emit(sigName: "notify::writable", ...args: any[]): void
  • emit(sigName: "notify::connectable", ...args: any[]): void
  • emit(sigName: "notify::main-context", ...args: any[]): void
  • emit(sigName: "notify::online", ...args: any[]): void
  • emit(sigName: "notify::source", ...args: any[]): void
  • emit(sigName: "notify::user-prompter", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • Empties the local cache by removing all known contacts from it and notifies about such removal any opened views.

    Parameters

    Returns boolean

  • ensure_source_status_connected(): void
  • force_floating(): void
  • This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().

    Returns void

  • foreach_view(): boolean
  • foreach_view_notify_progress(only_completed_views: boolean, percent: number, message: string): void
  • Notifies each view of the backend about progress. When only_completed_views is %TRUE, notifies only completed views.

    Parameters

    • only_completed_views: boolean

      whether notify in completed views only

    • percent: number

      percent complete

    • message: string

      message describing the operation in progress, or %NULL

    Returns void

  • freeze_notify(): void
  • Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

    This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

    Returns void

  • get_backend_property(prop_name: string): string
  • get_cache_dir(): string
  • get_capabilities(): string
  • Gathers the changes since the last check which had been done on the remote side.

    The last_sync_tag can be used as a tag of the last check. This can be %NULL, when there was no previous call or when the descendant doesn't store any such tags. The out_new_sync_tag can be populated with a value to be stored and used the next time.

    The out_repeat can be set to %TRUE when the descendant didn't finish read of all the changes. In that case the meta_backend calls this function again with the out_new_sync_tag as the last_sync_tag, but also notifies about the found changes immediately. The is_repeat is set to %TRUE as well in this case, otherwise it's %FALSE.

    The descendant can populate also EBookMetaBackendInfo::object of the out_created_objects and out_modified_objects, if known, in which case this will be used instead of loading it with e_book_meta_backend_load_contact_sync().

    It is optional to implement this virtual method by the descendant. The default implementation calls e_book_meta_backend_list_existing_sync() and then compares the list with the current content of the local cache and populates the respective lists appropriately.

    Each output #GSList should be freed with g_slist_free_full (objects, e_book_meta_backend_info_free); when no longer needed.

    Parameters

    • last_sync_tag: string

      optional sync tag from the last check

    • is_repeat: boolean

      set to %TRUE when this is the repeated call

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns [boolean, string, boolean, BookMetaBackendInfo[], BookMetaBackendInfo[], BookMetaBackendInfo[]]

  • get_connected_writable(): boolean
  • get_contact(...args: any[]): any
  • Obtains an #EContact for uid.

    The returned #EContact is referenced for thread-safety and must be unreferenced with g_object_unref() when finished with it.

    If an error occurs, the function will set error and return %NULL.

    Parameters

    • Rest ...args: any[]

    Returns any

  • get_contact_list(...args: any[]): any
  • Obtains a set of #EContact instances which satisfy the criteria specified in query, and deposits them in out_contacts.

    The returned #EContact instances are referenced for thread-safety and must be unreferenced with g_object_unref() when finished with them.

    If an error occurs, the function will set error and return %FALSE. Note that an empty result set does not necessarily imply an error.

    Parameters

    • Rest ...args: any[]

    Returns any

  • Finishes the operation started with e_book_backend_get_contact_list().

    The matching #EContact instances are deposited in out_contacts. The returned #EContact instances are referenced for thread-safety and must be unreferenced with g_object_unref() when finished with them.

    If an error occurred, the function will set error and return %FALSE. Note that an empty result set does not necessarily imply an error.

    Parameters

    Returns boolean

  • Obtains a set of #EContact instances which satisfy the criteria specified in query, and deposits them in out_contacts.

    The returned #EContact instances are referenced for thread-safety and must be unreferenced with g_object_unref() when finished with them.

    If an error occurs, the function will set error and return %FALSE. Note that an empty result set does not necessarily imply an error.

    Parameters

    • query: string

      a search query in S-expression format

    • out_contacts: GLib.Queue

      a #GQueue in which to deposit results

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • get_contact_list_uids(...args: any[]): any
  • Obtains a set of ID strings for contacts which satisfy the criteria specified in query, and deposits them in out_uids.

    The returned ID strings must be freed with g_free() with finished with them.

    If an error occurs, the function will set error and return %FALSE. Note that an empty result set does not necessarily imply an error.

    Parameters

    • Rest ...args: any[]

    Returns any

  • Finishes the operation started with e_book_backend_get_contact_list_uids_finish().

    ID strings for the matching contacts are deposited in out_uids, and must be freed with g_free() when finished with them.

    If an error occurs, the function will set error and return %FALSE. Note that an empty result set does not necessarily imply an error.

    Parameters

    Returns boolean

  • Obtains a set of ID strings for contacts which satisfy the criteria specified in query, and deposits them in out_uids.

    The returned ID strings must be freed with g_free() with finished with them.

    If an error occurs, the function will set error and return %FALSE. Note that an empty result set does not necessarily imply an error.

    Parameters

    • query: string

      a search query in S-expression format

    • out_uids: GLib.Queue

      a #GQueue in which to deposit results

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • get_data(key?: string): object
  • get_destination_address(): [boolean, string, number]
  • Provides destination server host name and port to which the backend connects. This is used to determine required connection point for e_backend_is_destination_reachable(). The host is a newly allocated string, which will be freed with g_free(). When backend sets both host and port, then it should return %TRUE, indicating it's a remote backend. Default implementation returns %FALSE, which is treated like the backend is local, no checking for server reachability is possible.

    Returns [boolean, string, number]

  • get_ever_connected(): boolean
  • get_online(): boolean
  • Returns the online state of backend: %TRUE if backend is online, %FALSE if offline.

    If the #EBackend:connectable property is non-%NULL, the backend will automatically determine whether the network service should be reachable, and hence whether the backend is #EBackend:online. But subclasses may override the online state if, for example, a connection attempt fails.

    Returns boolean

  • get_property(property_name?: string, value?: any): void
  • Gets a property of an object.

    The value can be:

    • an empty #GValue initialized by %G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a #GValue initialized with the expected type of the property
    • a #GValue initialized with a type to which the expected type of the property can be transformed

    In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().

    Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.

    Parameters

    • Optional property_name: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • get_qdata(quark: number): object
  • It is optional to implement this virtual method by the descendants. It is used to receive SSL error details when any online operation returns E_CLIENT_ERROR, E_CLIENT_ERROR_TLS_NOT_AVAILABLE error.

    Returns [boolean, string, TlsCertificateFlags]

  • get_user_prompter(): object
  • get_writable(): boolean
  • getv(names: string[], values: any[]): void
  • Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • Changes all URL photos and logos which point to a local file in contact to inline type, aka adds the file content into the contact. This is called automatically before e_book_meta_backend_save_contact_sync().

    The reverse operation is e_book_meta_backend_store_inline_photos_sync().

    Parameters

    Returns boolean

  • Checks whether the backend<!-- -->'s destination server, as returned by e_backend_get_destination_address(), is reachable. If the e_backend_get_destination_address() returns %FALSE, this function returns %TRUE, meaning the destination is always reachable. This uses #GNetworkMonitor's g_network_monitor_can_reach() for reachability tests.

    Parameters

    Returns boolean

  • is_floating(): boolean
  • is_opened(): boolean
  • Checks if backend's storage has been opened (and authenticated, if necessary) and the backend itself is ready for accessing. This property is changed automatically after the backend is successfully opened.

    Returns boolean

  • is_readonly(): boolean
  • Used to get list of all existing objects on the remote side. The descendant can optionally provide out_new_sync_tag, which will be stored on success, if not %NULL. The descendant can populate also EBookMetaBackendInfo::object of the out_existing_objects, if known, in which case this will be used instead of loading it with e_book_meta_backend_load_contact_sync().

    It is mandatory to implement this virtual method by the descendant, unless it implements its own #EBookMetaBackendClass.get_changes_sync().

    The out_existing_objects #GSList should be freed with g_slist_free_full (objects, e_book_meta_backend_info_free); when no longer needed.

    Parameters

    Returns [boolean, string, BookMetaBackendInfo[]]

  • Returns a list of #EDataBookView instances added with e_book_backend_add_view().

    The views returned in the list are referenced for thread-safety. They must each be unreferenced with g_object_unref() when finished with them. Free the returned list itself with g_list_free().

    An easy way to free the list properly in one step is as follows:

    |[ g_list_free_full (list, g_object_unref);

    
    

    Returns DataBookView[]

  • Loads a contact from the remote side.

    It is mandatory to implement this virtual method by the descendant.

    The returned out_contact should be freed with g_object_unref(), when no longer needed.

    The returned out_extra should be freed with g_free(), when no longer needed.

    Parameters

    • uid: string

      a contact UID

    • extra: string

      optional extra data stored with the contact, or %NULL

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns [boolean, EBookContacts.Contact, string]

  • modify_contacts(...args: any[]): any
  • modify_contacts_sync(vcards: string, opflags: number, cancellable: Gio.Cancellable): boolean
  • Modifies one or more contacts according to vcards.

    If an error occurs, the function will set error and return %FALSE.

    Parameters

    • vcards: string

      a %NULL-terminated array of vCard strings

    • opflags: number

      bit-or of #EBookOperationFlags

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • notify(property_name: string): void
  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    • property_name: string

      the name of a property installed on the class of object.

    Returns void

  • Emits a "notify" signal for the property specified by pspec on object.

    This function omits the property name lookup, hence it is faster than g_object_notify().

    One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:

      enum
    {
    PROP_0,
    PROP_FOO,
    PROP_LAST
    };

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
    0, 100,
    50,
    G_PARAM_READWRITE);
    g_object_class_install_property (gobject_class,
    PROP_FOO,
    properties[PROP_FOO]);
    }

    and then notify a change on the "foo" property with:

      g_object_notify_by_pspec (self, properties[PROP_FOO]);
    

    Parameters

    • pspec: ParamSpec

      the #GParamSpec of a property installed on the class of object.

    Returns void

  • notify_complete(): void
  • notify_error(message: string): void
  • notify_property_changed(prop_name: string, prop_value: string): void
  • notify_remove(id: string): void
  • Notifies all of backend's book views that the contact with UID id has been removed.

    e_data_book_respond_remove_contacts() calls this function for you. You only need to call this from your backend if contacts are removed by another (non-PAS-using) client.

    Parameters

    • id: string

      a contact id

    Returns void

  • Notifies all of backend's book views about the new or modified contacts contact.

    e_data_book_respond_create_contacts() and e_data_book_respond_modify_contacts() call this function for you. You only need to call this from your backend if contacts are created or modified by another (non-PAS-using) client.

    Parameters

    Returns void

  • open(...args: any[]): any
  • "Opens" the backend. Opening a backend is something of an outdated concept, but the operation is hanging around for a little while longer. This usually involves some custom initialization logic, and testing of remote authentication if applicable.

    If an error occurs, the function will set error and return %FALSE.

    Parameters

    • Rest ...args: any[]

    Returns any

  • "Opens" the backend. Opening a backend is something of an outdated concept, but the operation is hanging around for a little while longer. This usually involves some custom initialization logic, and testing of remote authentication if applicable.

    If an error occurs, the function will set error and return %FALSE.

    Parameters

    Returns boolean

  • Obtains the #GSimpleAsyncResult for opid and sets result_queue as a place to deposit results prior to completing the #GSimpleAsyncResult.

    This is a temporary function to serve #EDataBook's "respond" functions until they can be removed. Nothing else should be calling this function.

    Parameters

    • opid: number

      an operation ID given to #EDataBook

    • result_queue: GLib.Queue

      return location for a #GQueue, or %NULL

    Returns SimpleAsyncResult

  • prepare_shutdown(): void
  • Processes given changes by updating local cache content accordingly. The meta_backend processes the changes like being online and particularly requires to be online to load created and modified objects when needed.

    Parameters

    • created_objects: BookMetaBackendInfo[]

      a #GSList of #EBookMetaBackendInfo object infos which had been created

    • modified_objects: BookMetaBackendInfo[]

      a #GSList of #EBookMetaBackendInfo object infos which had been modified

    • removed_objects: BookMetaBackendInfo[]

      a #GSList of #EBookMetaBackendInfo object infos which had been removed

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • Increases the reference count of object.

    Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type of object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit.

    Returns GObject.Object

  • Returns the socket endpoint for the network service to which backend is a client, or %NULL if backend does not use network sockets.

    The initial value of the #EBackend:connectable property is derived from the #ESourceAuthentication extension of the backend's #EBackend:source property, if the extension is present.

    The returned #GSocketConnectable is referenced for thread-safety and must be unreferenced with g_object_unref() when finished with it.

    Returns SocketConnectable

  • Returns the #EDataBook for backend. The #EDataBook is essentially the glue between incoming D-Bus requests and backend's native API.

    An #EDataBook should be set only once after backend is first created. If an #EDataBook has not yet been set, the function returns %NULL.

    The returned #EDataBook is referenced for thread-safety and must be unreferenced with g_object_unref() when finished with it.

    Returns DataBook

  • Returns the #GProxyResolver for backend (if applicable), as indicated by the #ESourceAuthentication:proxy-uid of backend's #EBackend:source or one of its ancestors.

    The returned #GProxyResolver is referenced for thread-safety and must be unreferenced with g_object_unref() when finished with it.

    Returns Gio.ProxyResolver

  • Increase the reference count of object, and possibly remove the [floating][floating-ref] reference, if object has a floating reference.

    In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.

    Since GLib 2.56, the type of object will be propagated to the return type under the same conditions as for g_object_ref().

    Returns GObject.Object

  • refresh(...args: any[]): any
  • Initiates a refresh for backend, if the backend supports refreshing. The actual refresh operation completes on its own time. This function merely initiates the operation.

    If an error occurs while initiating the refresh, the function will set error and return %FALSE. If the backend does not support refreshing, the function will set an %E_CLIENT_ERROR_NOT_SUPPORTED error and return %FALSE.

    Parameters

    • Rest ...args: any[]

    Returns any

  • Finishes the refresh initiation started with e_book_backend_refresh().

    If an error occurred while initiating the refresh, the function will set error and return %FALSE. If the backend does not support refreshing, the function will set an %E_CLIENT_ERROR_NOT_SUPPORTED error and return %FALSE.

    Parameters

    Returns boolean

  • remove_contact_sync(conflict_resolution: ConflictResolution, uid: string, extra: string, object: string, opflags: number, cancellable: Gio.Cancellable): boolean
  • Removes a contact from the remote side. The object is not %NULL when it's removing locally deleted object in offline mode. Being it %NULL, the descendant can obtain the object from the #EBookCache.

    It is mandatory to implement this virtual method by the writable descendant.

    Parameters

    • conflict_resolution: ConflictResolution

      an #EConflictResolution to use

    • uid: string

      a contact UID

    • extra: string

      extra data being saved with the contact in the local cache, or %NULL

    • object: string

      corresponding vCard object, as stored in the local cache, or %NULL

    • opflags: number

      bit-or of #EBookOperationFlags

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • remove_contacts(...args: any[]): any
  • remove_contacts_sync(uids: string, opflags: number, cancellable: Gio.Cancellable): boolean
  • Removes one or more contacts according to uids.

    If an error occurs, the function will set error and return %FALSE.

    Parameters

    • uids: string

      a %NULL-terminated array of contact ID strings

    • opflags: number

      bit-or of #EBookOperationFlags

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • requires_reconnect(): boolean
  • Determines, whether current source content requires reconnect of the backend.

    It is optional to implement this virtual method by the descendant. The default implementation compares %E_SOURCE_EXTENSION_AUTHENTICATION and %E_SOURCE_EXTENSION_WEBDAV_BACKEND, if existing in the source, with the values after the last successful connect and returns %TRUE when they changed. It always return %TRUE when there was no successful connect done yet.

    Returns boolean

  • run_dispose(): void
  • Saves one contact into the remote side. When the overwrite_existing is %TRUE, then the descendant can overwrite an object with the same UID on the remote side (usually used for modify). The conflict_resolution defines what to do when the remote side had made any changes to the object since the last update.

    The contact has already converted locally stored photos and logos into inline variants, thus it's not needed to call e_book_meta_backend_inline_local_photos_sync() by the descendant.

    The out_new_uid can be populated with a UID of the saved contact as the server assigned it to it. This UID, if set, is loaded from the remote side afterwards, also to see whether any changes had been made to the contact by the remote side.

    The out_new_extra can be populated with a new extra data to save with the contact. Left it %NULL, to keep the same value as the extra.

    The descendant can use an #E_CLIENT_ERROR_OUT_OF_SYNC error to indicate that the save failed due to made changes on the remote side, and let the meta_backend resolve this conflict based on the conflict_resolution on its own. The #E_CLIENT_ERROR_OUT_OF_SYNC error should not be used when the descendant is able to resolve the conflicts itself.

    It is mandatory to implement this virtual method by the writable descendant.

    Parameters

    • overwrite_existing: boolean

      %TRUE when can overwrite existing contacts, %FALSE otherwise

    • conflict_resolution: ConflictResolution

      one of #EConflictResolution, what to do on conflicts

    • contact: EBookContacts.Contact

      an #EContact to save

    • extra: string

      extra data saved with the contacts in an #EBookCache

    • opflags: number

      bit-or of EBookOperationFlags

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns [boolean, string, string]

  • Schedules a new authenticate session, cancelling any previously run. This is usually done automatically, when an 'authenticate' signal is received for the associated #ESource. With %NULL credentials an attempt without it is run.

    Parameters

    • credentials: NamedParameters

      a credentials to use to authenticate, or %NULL

    Returns void

  • Asynchronously invokes e_backend_credentials_required(), but installs its own callback which only prints a runtime warning on the console when the call fails. The who_calls is a prefix of the console message. This is useful when the caller just wants to start the operation without having actual place where to show the operation result.

    Parameters

    • reason: SourceCredentialsReason

      an #ESourceCredentialsReason, why the credentials are required

    • certificate_pem: string

      PEM-encoded secure connection certificate, or an empty string

    • certificate_errors: TlsCertificateFlags

      a bit-or of #GTlsCertificateFlags for secure connection certificate

    • op_error: GLib.Error

      a #GError with a description of the previous credentials error, or %NULL

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • who_calls: string

      an identification who calls this

    Returns void

  • Schedules user function func to be run in a dedicated thread as a blocking operation.

    The function adds its own reference to use_cancellable, if not %NULL.

    The error returned from func is propagated to client using e_book_backend_notify_error() function. If it's not desired, then left the error unchanged and notify about errors manually.

    Parameters

    Returns void

  • schedule_refresh(): void
  • Schedules refresh of the content of the meta_backend. If there's any already scheduled, then the function does nothing.

    Use e_book_meta_backend_refresh_sync() to refresh the meta_backend immediately.

    Returns void

  • Searches meta_backend with given expression expr and returns found contacts as a #GSList of #EContact out_contacts. Free the returned out_contacts with g_slist_free_full (contacts, g_object_unref); when no longer needed. When the expr is %NULL, all objects are returned. To get UID-s instead, call e_book_meta_backend_search_uids_sync().

    It is optional to implement this virtual method by the descendant. The default implementation searches meta_backend's cache. It's also not required to be online for searching, thus meta_backend doesn't ensure it.

    Parameters

    • expr: string

      a search expression, or %NULL

    • meta_contact: boolean

      %TRUE, when return #EContact filled with UID and REV only, %FALSE to return full contacts

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns [boolean, EBookContacts.Contact[]]

  • search_uids_sync(expr: string, cancellable: Gio.Cancellable): [boolean, string[]]
  • Searches meta_backend with given expression expr and returns found contact UID-s as a #GSList out_contacts. Free the returned out_uids with g_slist_free_full (uids, g_free); when no longer needed. When the expr is %NULL, all UID-s are returned. To get #EContact(s) instead, call e_book_meta_backend_search_sync().

    It is optional to implement this virtual method by the descendant. The default implementation searches meta_backend's cache. It's also not required to be online for searching, thus meta_backend doesn't ensure it.

    Parameters

    • expr: string

      a search expression, or %NULL

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns [boolean, string[]]

  • Sets the cache as the cache to be used by the meta_backend. By default, a cache.db in EBookBackend::cache-dir is created in the constructed method. This function can be used to override the default.

    Note the meta_backend adds its own reference to the cache.

    Parameters

    Returns void

  • set_cache_dir(cache_dir: string): void
  • Sets the cache directory path for use by backend.

    Note that #EBookBackend is initialized with a default cache directory path which should suffice for most cases. Backends should not override the default path without good reason.

    Parameters

    • cache_dir: string

      a local cache directory path

    Returns void

  • Sets the socket endpoint for the network service to which backend is a client. This can be %NULL if backend does not use network sockets.

    The initial value of the #EBackend:connectable property is derived from the #ESourceAuthentication extension of the backend's #EBackend:source property, if the extension is present.

    Parameters

    Returns void

  • set_connected_writable(value: boolean): void
  • Sets whether the meta_backend connected to a writable destination. This value has meaning only if e_book_meta_backend_get_ever_connected() is %TRUE.

    This is used by the meta_backend itself, during the opening phase, to set the backend writable or not also in the offline mode.

    Parameters

    • value: boolean

      value to set

    Returns void

  • set_data(key: string, data?: object): void
  • Each object carries around a table of associations from strings to pointers. This function lets you set an association.

    If the object already had an association with that name, the old association will be destroyed.

    Internally, the key is converted to a #GQuark using g_quark_from_string(). This means a copy of key is kept permanently (even after object has been finalized) — so it is recommended to only use a small, bounded set of values for key in your program, to avoid the #GQuark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optional data: object

      data to associate with that key

    Returns void

  • set_data_book(data_book: DataBook): void
  • set_ever_connected(value: boolean): void
  • Sets whether the meta_backend ever made a successful connection to its destination.

    This is used by the meta_backend itself, during the opening phase, when it had not been connected yet, then it does so immediately, to eventually report settings error easily.

    Parameters

    • value: boolean

      value to set

    Returns void

  • Notify the addressbook backend that the current locale has changed, this is important for backends which support ordered result lists which are locale sensitive.

    Parameters

    • locale: string

      the new locale for the addressbook

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • set_online(online: boolean): void
  • Sets the online state of backend: %TRUE if backend is online, FALSE if offline.

    If the #EBackend:connectable property is non-%NULL, the backend will automatically determine whether the network service should be reachable, and hence whether the backend is #EBackend:online. But subclasses may override the online state if, for example, a connection attempt fails.

    Parameters

    • online: boolean

      the online state

    Returns void

  • set_property(property_name: string, value?: any): void
  • set_writable(writable: boolean): void
  • Splits objects into created/modified/removed lists according to current local cache content. Only the out_removed_objects can be %NULL, others cannot. The function modifies objects by moving its 'data' to corresponding out lists and sets the objects 'data' to %NULL.

    Each output #GSList should be freed with g_slist_free_full (objects, e_book_meta_backend_info_free); when no longer needed.

    The caller is still responsible to free objects as well.

    Parameters

    Returns [boolean, BookMetaBackendInfo[], BookMetaBackendInfo[], BookMetaBackendInfo[], BookMetaBackendInfo[]]

  • steal_data(key?: string): object
  • steal_qdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata() and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

    void
    object_add_to_user_list (GObject *object,
    const gchar *new_string)
    {
    // the quark, naming the object data
    GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
    // retrieve the old string list
    GList *list = g_object_steal_qdata (object, quark_string_list);

    // prepend new string
    list = g_list_prepend (list, g_strdup (new_string));
    // this changed 'list', so we need to set it again
    g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
    }
    static void
    free_string_list (gpointer data)
    {
    GList *node, *list = data;

    for (node = list; node; node = node->next)
    g_free (node->data);
    g_list_free (list);
    }

    Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • Changes all inline photos and logos to URL type in contact, which will point to a local file instead, beside the cache file. This is called automatically after e_book_meta_backend_load_contact_sync().

    The reverse operation is e_book_meta_backend_inline_local_photos_sync().

    Parameters

    Returns boolean

  • sync(): void
  • thaw_notify(): void
  • Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

    Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.

    It is an error to call this function when the freeze count is zero.

    Returns void

  • Initiates a user trust prompt with given parameters.

    When the operation is finished, callback will be called. You can then call e_backend_trust_prompt_finish() to get the result of the operation.

    Parameters

    • parameters: NamedParameters

      an #ENamedParameters with values for the trust prompt

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • unref(): void
  • Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

    If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.

    Returns void

  • vfunc_closed(sender: string): void
  • This is called always before any operation which requires a connection to the remote side. It can fail with an #E_CLIENT_ERROR_REPOSITORY_OFFLINE error to indicate that the remote side cannot be currently reached. Other errors are propagated to the caller/client side. This method is not called when the backend is offline.

    The descendant should also call e_book_backend_set_writable() after successful connect to the remote side. This value is stored for later use, when being opened offline.

    The credentials parameter consists of the previously used credentials. It's always %NULL with the first connection attempt. To get the credentials, just set the out_auth_result to %E_SOURCE_AUTHENTICATION_REQUIRED for the first time and the function will be called again once the credentials are available. See the documentation of #ESourceAuthenticationResult for other available results.

    The out parameters are passed to e_backend_schedule_credentials_required() and are ignored when the descendant returns %TRUE, aka they are used only if the connection fails. The out_certificate_pem and out_certificate_errors should be used together and they can be left untouched if the failure reason was not related to certificate. Use out_auth_result %E_SOURCE_AUTHENTICATION_UNKNOWN to indicate other error than credentials error, otherwise the error is used according to out_auth_result value.

    It is mandatory to implement this virtual method by the descendant.

    virtual

    Parameters

    • credentials: NamedParameters

      an #ENamedParameters with previously used credentials, or %NULL

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns [boolean, SourceAuthenticationResult, string, TlsCertificateFlags]

  • vfunc_constructed(): void
  • vfunc_contains_email_sync(email_address: string, cancellable: Gio.Cancellable): boolean
  • This is called when the backend goes into offline mode or when the disconnect is required. The implementation should not report any error when it is called and the meta_backend is not connected.

    It is mandatory to implement this virtual method by the descendant.

    virtual

    Parameters

    Returns boolean

  • vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: ParamSpec): void
  • vfunc_dispose(): void
  • vfunc_finalize(): void
  • Gathers the changes since the last check which had been done on the remote side.

    The last_sync_tag can be used as a tag of the last check. This can be %NULL, when there was no previous call or when the descendant doesn't store any such tags. The out_new_sync_tag can be populated with a value to be stored and used the next time.

    The out_repeat can be set to %TRUE when the descendant didn't finish read of all the changes. In that case the meta_backend calls this function again with the out_new_sync_tag as the last_sync_tag, but also notifies about the found changes immediately. The is_repeat is set to %TRUE as well in this case, otherwise it's %FALSE.

    The descendant can populate also EBookMetaBackendInfo::object of the out_created_objects and out_modified_objects, if known, in which case this will be used instead of loading it with e_book_meta_backend_load_contact_sync().

    It is optional to implement this virtual method by the descendant. The default implementation calls e_book_meta_backend_list_existing_sync() and then compares the list with the current content of the local cache and populates the respective lists appropriately.

    Each output #GSList should be freed with g_slist_free_full (objects, e_book_meta_backend_info_free); when no longer needed.

    virtual

    Parameters

    • last_sync_tag: string

      optional sync tag from the last check

    • is_repeat: boolean

      set to %TRUE when this is the repeated call

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns [boolean, string, boolean, BookMetaBackendInfo[], BookMetaBackendInfo[], BookMetaBackendInfo[]]

  • vfunc_get_destination_address(): [boolean, string, number]
  • Provides destination server host name and port to which the backend connects. This is used to determine required connection point for e_backend_is_destination_reachable(). The host is a newly allocated string, which will be freed with g_free(). When backend sets both host and port, then it should return %TRUE, indicating it's a remote backend. Default implementation returns %FALSE, which is treated like the backend is local, no checking for server reachability is possible.

    virtual

    Returns [boolean, string, number]

  • vfunc_get_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • It is optional to implement this virtual method by the descendants. It is used to receive SSL error details when any online operation returns E_CLIENT_ERROR, E_CLIENT_ERROR_TLS_NOT_AVAILABLE error.

    virtual

    Returns [boolean, string, TlsCertificateFlags]

  • vfunc_impl_configure_direct(config: string): void
  • vfunc_impl_contains_email(book: DataBook, opid: number, cancellable: Gio.Cancellable, email_address: string): void
  • vfunc_impl_create_contacts(book: DataBook, opid: number, cancellable: Gio.Cancellable, vcards: string, opflags: number): void
  • vfunc_impl_dup_locale(): string
  • vfunc_impl_get_backend_property(prop_name: string): string
  • vfunc_impl_get_contact_list_uids(book: DataBook, opid: number, cancellable: Gio.Cancellable, query: string): void
  • vfunc_impl_modify_contacts(book: DataBook, opid: number, cancellable: Gio.Cancellable, vcards: string, opflags: number): void
  • vfunc_impl_remove_contacts(book: DataBook, opid: number, cancellable: Gio.Cancellable, uids: string, opflags: number): void
  • vfunc_impl_set_locale(locale: string, cancellable: Gio.Cancellable): boolean
  • Used to get list of all existing objects on the remote side. The descendant can optionally provide out_new_sync_tag, which will be stored on success, if not %NULL. The descendant can populate also EBookMetaBackendInfo::object of the out_existing_objects, if known, in which case this will be used instead of loading it with e_book_meta_backend_load_contact_sync().

    It is mandatory to implement this virtual method by the descendant, unless it implements its own #EBookMetaBackendClass.get_changes_sync().

    The out_existing_objects #GSList should be freed with g_slist_free_full (objects, e_book_meta_backend_info_free); when no longer needed.

    virtual

    Parameters

    Returns [boolean, string, BookMetaBackendInfo[]]

  • Loads a contact from the remote side.

    It is mandatory to implement this virtual method by the descendant.

    The returned out_contact should be freed with g_object_unref(), when no longer needed.

    The returned out_extra should be freed with g_free(), when no longer needed.

    virtual

    Parameters

    • uid: string

      a contact UID

    • extra: string

      optional extra data stored with the contact, or %NULL

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns [boolean, EBookContacts.Contact, string]

  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    virtual

    Parameters

    Returns void

  • vfunc_prepare_shutdown(): void
  • vfunc_remove_contact_sync(conflict_resolution: ConflictResolution, uid: string, extra: string, object: string, opflags: number, cancellable: Gio.Cancellable): boolean
  • Removes a contact from the remote side. The object is not %NULL when it's removing locally deleted object in offline mode. Being it %NULL, the descendant can obtain the object from the #EBookCache.

    It is mandatory to implement this virtual method by the writable descendant.

    virtual

    Parameters

    • conflict_resolution: ConflictResolution

      an #EConflictResolution to use

    • uid: string

      a contact UID

    • extra: string

      extra data being saved with the contact in the local cache, or %NULL

    • object: string

      corresponding vCard object, as stored in the local cache, or %NULL

    • opflags: number

      bit-or of #EBookOperationFlags

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • vfunc_requires_reconnect(): boolean
  • Determines, whether current source content requires reconnect of the backend.

    It is optional to implement this virtual method by the descendant. The default implementation compares %E_SOURCE_EXTENSION_AUTHENTICATION and %E_SOURCE_EXTENSION_WEBDAV_BACKEND, if existing in the source, with the values after the last successful connect and returns %TRUE when they changed. It always return %TRUE when there was no successful connect done yet.

    virtual

    Returns boolean

  • Saves one contact into the remote side. When the overwrite_existing is %TRUE, then the descendant can overwrite an object with the same UID on the remote side (usually used for modify). The conflict_resolution defines what to do when the remote side had made any changes to the object since the last update.

    The contact has already converted locally stored photos and logos into inline variants, thus it's not needed to call e_book_meta_backend_inline_local_photos_sync() by the descendant.

    The out_new_uid can be populated with a UID of the saved contact as the server assigned it to it. This UID, if set, is loaded from the remote side afterwards, also to see whether any changes had been made to the contact by the remote side.

    The out_new_extra can be populated with a new extra data to save with the contact. Left it %NULL, to keep the same value as the extra.

    The descendant can use an #E_CLIENT_ERROR_OUT_OF_SYNC error to indicate that the save failed due to made changes on the remote side, and let the meta_backend resolve this conflict based on the conflict_resolution on its own. The #E_CLIENT_ERROR_OUT_OF_SYNC error should not be used when the descendant is able to resolve the conflicts itself.

    It is mandatory to implement this virtual method by the writable descendant.

    virtual

    Parameters

    • overwrite_existing: boolean

      %TRUE when can overwrite existing contacts, %FALSE otherwise

    • conflict_resolution: ConflictResolution

      one of #EConflictResolution, what to do on conflicts

    • contact: EBookContacts.Contact

      an #EContact to save

    • extra: string

      extra data saved with the contacts in an #EBookCache

    • opflags: number

      bit-or of EBookOperationFlags

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns [boolean, string, string]

  • Searches meta_backend with given expression expr and returns found contacts as a #GSList of #EContact out_contacts. Free the returned out_contacts with g_slist_free_full (contacts, g_object_unref); when no longer needed. When the expr is %NULL, all objects are returned. To get UID-s instead, call e_book_meta_backend_search_uids_sync().

    It is optional to implement this virtual method by the descendant. The default implementation searches meta_backend's cache. It's also not required to be online for searching, thus meta_backend doesn't ensure it.

    virtual

    Parameters

    • expr: string

      a search expression, or %NULL

    • meta_contact: boolean

      %TRUE, when return #EContact filled with UID and REV only, %FALSE to return full contacts

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns [boolean, EBookContacts.Contact[]]

  • vfunc_search_uids_sync(expr: string, cancellable: Gio.Cancellable): [boolean, string[]]
  • Searches meta_backend with given expression expr and returns found contact UID-s as a #GSList out_contacts. Free the returned out_uids with g_slist_free_full (uids, g_free); when no longer needed. When the expr is %NULL, all UID-s are returned. To get #EContact(s) instead, call e_book_meta_backend_search_sync().

    It is optional to implement this virtual method by the descendant. The default implementation searches meta_backend's cache. It's also not required to be online for searching, thus meta_backend doesn't ensure it.

    virtual

    Parameters

    • expr: string

      a search expression, or %NULL

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns [boolean, string[]]

  • vfunc_set_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • vfunc_shutdown(): void
  • vfunc_source_changed(): void
  • watch_closure(closure: TClosure<any, any>): void
  • This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

    Parameters

    • closure: TClosure<any, any>

      #GClosure to watch

    Returns void

  • compat_control(what: number, data: object): number
  • Find the #GParamSpec with the given name for an interface. Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • g_iface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    • property_name: string

      name of a property to look up.

    Returns ParamSpec

  • Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

    This function is meant to be called from the interface's default vtable initialization function (the class_init member of #GTypeInfo.) It must not be called after after class_init has been called for any object types implementing this interface.

    If pspec is a floating reference, it will be consumed.

    Parameters

    • g_iface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface.

    • pspec: ParamSpec

      the #GParamSpec for the new property

    Returns void

  • Lists the properties of an interface.Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • g_iface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    Returns ParamSpec[]

  • Creates a new instance of a #GObject subtype and sets its properties.

    Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.

    Parameters

    • object_type: GType<unknown>

      the type id of the #GObject subtype to instantiate

    • parameters: GObject.Parameter[]

      an array of #GParameter

    Returns GObject.Object

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method