Gjsify LogoGjsify Logo

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

Hierarchy

Index

Constructors

Properties

auto_prompt: boolean

Whether the #ECredentialsPrompter can response to credential requests automatically.

g_type_instance: TypeInstance
parent: GObject.Object

The #ESourceCredentialsProvider object, which the prompter uses.

registry: SourceRegistry

The #ESourceRegistry object, to whose credential requests the prompter listens.

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

  • Completes an ongoing credentials prompt on idle, by finishing the async_result. This function is meant to be used by an #ECredentialsPrompterImpl implementation. To actually finish the credentials prompt previously started with e_credentials_prompter_prompt(), the e_credentials_prompter_prompt_finish() should be called from the provided callback.

    Using %NULL credentials will result in a G_IO_ERROR_CANCELLED error, if no other error is provided.

    Parameters

    Returns void

  • disconnect(id: number): void
  • emit(sigName: "get-dialog-parent", ...args: any[]): void
  • emit(sigName: "get-dialog-parent-full", auth_source: EDataServer.Source, ...args: any[]): void
  • emit(sigName: "notify::auto-prompt", ...args: any[]): void
  • emit(sigName: "notify::provider", ...args: any[]): void
  • emit(sigName: "notify::registry", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): 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

  • 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_auto_prompt(): boolean
  • Returns, whether can respond to credential prompts automatically. Default value is %TRUE.

    This property does not influence direct calls of e_credentials_prompter_prompt().

    Returns boolean

  • Returns whether the auto-prompt is disabled for the given source. All sources can be auto-prompted by default. This is a complementary value for the ECredentialsPrompter::auto-prompt property.

    This value does not influence direct calls of e_credentials_prompter_prompt().

    Parameters

    Returns boolean

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

  • Returns a #GtkWindow, which should be used as a dialog parent. This is determined by an ECredentialsPrompter::get-dialog-parent signal emission. If there is no callback registered or the current callbacks don't have any suitable window, then there's chosen the last active window from the default GApplication, if any available.

    Returns Gtk.Window

  • Returns a #GtkWindow, which should be used as a dialog parent for the auth_source.

    This is determined by an ECredentialsPrompter::get-dialog-parent-full signal emission and an ECredentialsPrompter::get-dialog-parent when the first doesn't return anything. If there is no callback registered or the current callbacks don't have any suitable window, then there's chosen the last active window from the default GApplication, if any available.

    Parameters

    Returns Gtk.Window

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

  • is_floating(): boolean
  • Returns a list of #EExtension objects bound to extensible whose types are ancestors of extension_type. For a complete list of extension objects bound to extensible, pass %E_TYPE_EXTENSION.

    The list itself should be freed with g_list_free(). The extension objects are owned by extensible and should not be unreferenced.

    Parameters

    • extension_type: GType<unknown>

      the type of extensions to list

    Returns EDataServer.Extension[]

  • load_extensions(): void
  • Creates an instance of all instantiable subtypes of #EExtension which target the class of extensible. The lifetimes of these newly created #EExtension objects are bound to extensible such that they are finalized when extensible is finalized.

    Returns void

  • Runs a credentials prompt loop for source, as long as the func doesn't indicate that the provided credentials can be used to successfully authenticate against source<!-- -->'s server, or that the func returns %FALSE. The loop is also teminated when a used cancels the credentials prompt or the cancellable is cancelled, though not sooner than the credentials prompt dialog is closed.

    Note: The function doesn't return until the loop is terminated, either successfully or unsuccessfully. The function can be called from any thread, though a dedicated thread is preferred.

    Parameters

    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

  • process_awaiting_credentials(): void
  • Process all enabled sources with connection state #E_SOURCE_CONNECTION_STATUS_AWAITING_CREDENTIALS, like if they just asked for its credentials for the first time.

    Returns void

  • Continues a credential prompt for source. Returns, whether anything will be done. The %FALSE either means that the source<!-- -->'s connection status is not the %E_SOURCE_CONNECTION_STATUS_AWAITING_CREDENTIALS or it is disabled.

    Parameters

    Returns boolean

  • Asks the prompter to prompt for credentials, which are returned to the caller through callback, when available.The flags are ignored, when the callback is %NULL; the credentials are passed to the source with e_source_invoke_authenticate() directly, in this case. Call e_credentials_prompter_prompt_finish() in callback to get to the provided credentials.

    Parameters

    Returns void

  • Finishes a credentials prompt previously started with e_credentials_prompter_prompt(). The out_source will have set a referenced #ESource, for which the prompt was started. Unref it, when no longer needed. Similarly the out_credentials will have set a newly allocated #ENamedParameters structure with provided credentials, which should be freed with e_named_credentials_free() when no longer needed. Both output arguments will be set to %NULL on error and %FALSE will be returned.

    Parameters

    Returns [boolean, EDataServer.Source, NamedParameters]

  • 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

  • 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

  • Registers a prompter implementation for a given authentication method. If there is registered a prompter for the same authentication_method, then the function does nothing, otherwise it adds its own reference on the prompter_impl, and uses it for that authentication method. One prompter_impl can be registered for multiple authentication methods.

    A special value %NULL can be used for the authentication_method, which means a default credentials prompter, that is to be used when there is no prompter registered for the exact authentication method.

    Parameters

    • authentication_method: string

      an authentication method to registr prompter_impl for; or %NULL

    • prompter_impl: CredentialsPrompterImpl

      an #ECredentialsPrompterImpl

    Returns boolean

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

  • set_auto_prompt(auto_prompt: boolean): void
  • Sets whether can respond to credential prompts automatically. That means that whenever any ESource will ask for credentials, it'll try to provide them.

    Use e_credentials_prompter_set_auto_prompt_disabled_for() to influence auto-prompt per an #ESource.

    This property does not influence direct calls of e_credentials_prompter_prompt().

    Parameters

    • auto_prompt: boolean

      new value of the auto-prompt property

    Returns void

  • Sets whether the auto-prompt should be disabled for the given source. All sources can be auto-prompted by default. This is a complementary value for the ECredentialsPrompter::auto-prompt property.

    This value does not influence direct calls of e_credentials_prompter_prompt().

    Parameters

    • source: EDataServer.Source

      an #ESource

    • is_disabled: boolean

      whether the auto-prompt should be disabled for this source

    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_property(property_name: string, value?: any): void
  • steal_data(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

  • 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

  • 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

  • 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

  • Unregisters previously registered prompter_impl for the given autnetication_method with e_credentials_prompter_register_impl(). Function does nothing, if no such authentication method is registered or if it has set a different prompter implementation.

    Parameters

    • authentication_method: string

      an authentication method to registr prompter_impl for; or %NULL

    • prompter_impl: CredentialsPrompterImpl

      an #ECredentialsPrompterImpl

    Returns void

  • vfunc_constructed(): void
  • vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: ParamSpec): void
  • vfunc_dispose(): void
  • vfunc_finalize(): void
  • Returns a #GtkWindow, which should be used as a dialog parent. This is determined by an ECredentialsPrompter::get-dialog-parent signal emission. If there is no callback registered or the current callbacks don't have any suitable window, then there's chosen the last active window from the default GApplication, if any available.

    virtual

    Returns Gtk.Window

  • vfunc_get_property(property_id: number, value?: any, pspec?: ParamSpec): 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.

    virtual

    Parameters

    Returns void

  • vfunc_set_property(property_id: number, value?: any, pspec?: ParamSpec): 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