Gjsify LogoGjsify Logo

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

Hierarchy

Index

Constructors

Properties

connectable: SocketConnectable
gTypeInstance: TypeInstance
mainContext: MainContext
online: boolean
proxyResolver: Gio.ProxyResolver
userPrompter: UserPrompter
name: string

Methods

  • Authenticates all enabled children sources with the given crendetials. This is usually called when the collection source successfully used the credentials to connect to the (possibly) remote data store, to open the childern too. Already connected child sources are skipped.

    Parameters

    Returns void

  • 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

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: 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

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transformTo: TClosure<any, any>

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

    • transformFrom: TClosure<any, any>

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

    Returns Binding

  • Claims all previously used sources that have not yet been claimed by e_collection_backend_new_child() and returns them in a #GList. Note that previously used sources can only be claimed once, so subsequent calls to this function for backend will return %NULL.

    The backend is then expected to compare the returned list with a current list of resources from a remote server, create new #ESource instances as needed with e_collection_backend_new_child(), discard unneeded #ESource instances with e_source_remove(), and export the remaining instances with e_source_registry_server_add_source().

    The sources 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 #GList 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 EDataServer.Source[]

  • connect(sigName: "notify::proxy-resolver", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::server", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::connectable", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::main-context", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::online", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::source", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::user-prompter", callback: ((...args: any[]) => void)): number
  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • Asynchronously creates a server-side resource described by source. For example, if source describes a new calendar, an equivalent calendar is created on the server.

    It is the implementor's responsibility to examine source and determine what the equivalent server-side resource would be. If this cannot be determined without ambiguity, the function must return an error.

    After the server-side resource is successfully created, the implementor must also add an #ESource to backend's #ECollectionBackend:server. This can either be done immediately or in response to some "resource created" notification from the server. The added #ESource can be source itself or a different #ESource instance that describes the new resource.

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

    Parameters

    Returns void

  • Creates a server-side resource described by source. For example, if source describes a new calendar, an equivalent calendar is created on the server.

    It is the implementor's responsibility to examine source and determine what the equivalent server-side resource would be. If this cannot be determined without ambiguity, the function must return an error.

    After the server-side resource is successfully created, the implementor must also add an #ESource to backend's #ECollectionBackend:server. This can either be done immediately or in response to some "resource created" notification from the server. The added #ESource can be source itself or a different #ESource instance that describes the new resource.

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

    Parameters

    Returns boolean

  • 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

    • certificatePem: string

      PEM-encoded secure connection certificate, or an empty string

    • certificateErrors: TlsCertificateFlags

      a bit-or of #GTlsCertificateFlags for secure connection certificate

    • opError: 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

  • credentialsRequiredFinish(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

    • certificatePem: string

      PEM-encoded secure connection certificate, or an empty string

    • certificateErrors: TlsCertificateFlags

      a bit-or of #GTlsCertificateFlags for secure connection certificate

    • opError: GLib.Error

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

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • Asynchronously deletes a server-side resource described by source. The source must be a child of backend's collection #EBackend:source.

    After the server-side resource is successfully deleted, the implementor must also remove source from the backend's #ECollectionBackend:server. This can either be done immediately or in response to some "resource deleted" notification from the server.

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

    Parameters

    Returns void

  • Deletes a server-side resource described by source. The source must be a child of backend's collection #EBackend:source.

    After the server-side resource is successfully deleted, the implementor must also remove source from the backend's #ECollectionBackend:server. This can either be done immediately or in response to some "resource deleted" notification from the server.

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

    Parameters

    Returns boolean

  • This function is usually called in EBackend::authenticate_sync() implementation of the descendant, causing discovery of CalDAV and CardDAV sources on given URLs. If either of calendar_url and contacts_url is %NULL, that that part is skipped. The calendar_url covers all calendars, memo lists and task lists.

    The function also takes care of e_collection_backend_authenticate_children() on success.

    Parameters

    • calendarUrl: string

      a URL to search calendars at, or %NULL

    • contactsUrl: string

      a URL to search contacts at, or %NULL

    • credentials: NamedParameters

      credentials to use when running the discovery

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns [SourceAuthenticationResult, string, TlsCertificateFlags]

  • Extracts the resource ID for child_source, which is supposed to be a stable and unique server-assigned identifier for the remote resource described by child_source. If child_source is not actually a child of the collection #EBackend:source owned by backend, the function returns %NULL.

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

    Parameters

    Returns string

  • emit(sigName: "notify::proxy-resolver", ...args: any[]): void
  • emit(sigName: "notify::server", ...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
  • ensureSourceStatusConnected(): void
  • Makes sure that the associated ESource::connection-status is connected. This is useful in cases when the backend can connect to the destination without invoking #EBackendClass.authenticate_sync(), possibly through e_backend_schedule_authenticate().

    Returns void

  • forceFloating(): 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

  • freezeNotify(): 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

  • freezePopulate(): boolean
  • Freezes populate of the backend's content. This is used to avoid calling populate multiple times in parallel. Every call to this function should be followed by the call of e_collection_backend_thaw_populate() to reverse the effect of this function, regardless of the return value of this function.

    Returns boolean

  • getCacheDir(): string
  • Returns the private cache directory path for backend, which is named after the #ESource:uid of backend's collection #EBackend:source.

    The cache directory is meant to store key files for backend-created data sources. See also: e_server_side_source_set_write_directory()

    Returns string

  • getData(key?: string): object
  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • Optional key: string

      name of the key for that association

    Returns object

  • getDestinationAddress(): [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]

  • getOnline(): 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

  • getPopulateFrozen(): boolean
  • getProperty(propertyName?: 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 propertyName: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • getQdata(quark: number): object
  • Verifies that the source is expected here and returns its resource ID, which is used in call to e_collection_backend_new_child(). It returns %NULL, when the source is not part of the backend and should be removed instead. The default implementation allows all sources, which has %ESourceResource extension defined.

    Parameters

    Returns string

  • getUserPrompter(): object
  • 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

  • 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

  • isFloating(): boolean
  • Returns a list of calendar sources belonging to the data source collection managed by backend.

    The sources 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 #GList 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 EDataServer.Source[]

  • Returns a list of address book sources belonging to the data source collection managed by backend.

    The sources 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 #GList 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 EDataServer.Source[]

  • Returns a list of mail sources belonging to the data source collection managed by backend.

    The sources 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 #GList 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 EDataServer.Source[]

  • Creates a new #EServerSideSource as a child of the collection #EBackend:source owned by backend. If possible, the #EServerSideSource is drawn from a cache of previously used sources indexed by resource_id so that locally cached data from previous sessions can be reused.

    The returned data source should be passed to e_source_registry_server_add_source() to export it over D-Bus.

    Parameters

    • resourceId: string

      a stable and unique resource ID

    Returns EDataServer.Source

  • notify(propertyName: 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

    • propertyName: 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

  • off(sigName: "notify::proxy-resolver", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::server", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::connectable", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::main-context", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::online", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::source", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::user-prompter", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: string, callback: ((...args: any[]) => void)): EventEmitter
  • Parameters

    • sigName: "notify::proxy-resolver"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::server"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::connectable"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::main-context"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::online"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::source"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::user-prompter"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • on(sigName: "notify::proxy-resolver", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::server", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::connectable", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::main-context", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::online", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::source", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::user-prompter", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    • sigName: "notify::proxy-resolver"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::server"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::connectable"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::main-context"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::online"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::source"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::user-prompter"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • once(sigName: "notify::proxy-resolver", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::server", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::connectable", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::main-context", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::online", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::source", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::user-prompter", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    • sigName: "notify::proxy-resolver"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::server"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::connectable"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::main-context"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::online"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::source"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::user-prompter"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • prepareShutdown(): void
  • Let's the backend know that it'll be shut down shortly, no client connects to it anymore. The backend can free any resources which reference it, for example the opened views.

    Returns void

  • 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 #GMainContext on which event sources for backend are to be attached.

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

    Returns MainContext

  • 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

  • runDispose(): void
  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

  • 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

    • certificatePem: string

      PEM-encoded secure connection certificate, or an empty string

    • certificateErrors: TlsCertificateFlags

      a bit-or of #GTlsCertificateFlags for secure connection certificate

    • opError: GLib.Error

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

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • whoCalls: string

      an identification who calls this

    Returns void

  • schedulePopulate(): 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

  • setData(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

  • setOnline(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

  • setProperty(propertyName: string, value?: any): void
  • stealData(key?: string): object
  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • Optional key: string

      name of the key

    Returns object

  • stealQdata(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

  • thawNotify(): 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

  • thawPopulate(): 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

  • watchClosure(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

  • compatControl(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

    • gIface: TypeInterface

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

    • propertyName: 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

    • gIface: 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

    • gIface: 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

    • objectType: 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