Gjsify LogoGjsify Logo

#PolkitAuthority is used for checking whether a given subject is authorized to perform a given action. Typically privileged system daemons or suid helpers will use this when handling requests from untrusted clients.

User sessions can register an authentication agent with the authority. This is used for requests from untrusted clients where system policy requires that the user needs to acknowledge (through proving he is the user or the administrator) a given action. See #PolkitAgentListener and #PolkitAgentSession for details.

Hierarchy

Index

Constructors

Properties

backendFeatures: AuthorityFeatures

The features of the currently used Authority backend.

backendName: string

The name of the currently used Authority backend.

backendVersion: string
gTypeInstance: TypeInstance
owner: string

The unique name of the owner of the org.freedesktop.PolicyKit1 D-Bus service or %NULL if there is no owner. Connect to the #GObject::notify signal to track changes to this property.

$gtype: GType<Authority>
name: string

Methods

  • Asynchronously provide response that identity successfully authenticated for the authentication request identified by cookie.

    This function is only used by the privileged bits of an authentication agent. It will fail if the caller is not sufficiently privileged (typically uid 0).

    When the operation is finished, callback will be invoked in the

    thread-default main loop of the thread you are calling this method from. You can then call polkit_authority_authentication_agent_response_finish() to get the result of the operation.

    Parameters

    • cookie: string

      The cookie passed to the authentication agent from the authority.

    • identity: Polkit.Identity

      The identity that was authenticated.

    • cancellable: Gio.Cancellable

      A #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      A #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • authenticationAgentResponseFinish(res: AsyncResult): boolean
  • Finishes providing response from an authentication agent.

    Parameters

    • res: AsyncResult

      A #GAsyncResult obtained from the callback.

    Returns boolean

  • Provide response that identity successfully authenticated for the authentication request identified by cookie. See polkit_authority_authentication_agent_response() for limitations on who is allowed is to call this method.

    The calling thread is blocked until a reply is received. See polkit_authority_authentication_agent_response() for the asynchronous version.

    Parameters

    • cookie: string

      The cookie passed to the authentication agent from the authority.

    • identity: Polkit.Identity

      The identity that was authenticated.

    • cancellable: Gio.Cancellable

      A #GCancellable or %NULL.

    Returns boolean

  • 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

  • Asynchronously checks if subject is authorized to perform the action represented by action_id.

    Note that %POLKIT_CHECK_AUTHORIZATION_FLAGS_ALLOW_USER_INTERACTION SHOULD be passed ONLY if the event that triggered the authorization check is stemming from an user action, e.g. the user pressing a button or attaching a device.

    When the operation is finished, callback will be invoked in the

    thread-default main loop of the thread you are calling this method from. You can then call polkit_authority_check_authorization_finish() to get the result of the operation.

    Known keys in details include polkit.message and polkit.gettext_domain that can be used to override the message shown to the user. See the documentation for the D-Bus method for more details.

    If details is non-empty then the request will fail with #POLKIT_ERROR_FAILED unless the process doing the check itsef is sufficiently authorized (e.g. running as uid 0).

    Parameters

    Returns void

  • Checks if subject is authorized to perform the action represented by action_id.

    Note that %POLKIT_CHECK_AUTHORIZATION_FLAGS_ALLOW_USER_INTERACTION SHOULD be passed ONLY if the event that triggered the authorization check is stemming from an user action, e.g. the user pressing a button or attaching a device.

    Note the calling thread is blocked until a reply is received. You should therefore NEVER do this from a GUI thread or a daemon service thread when using the %POLKIT_CHECK_AUTHORIZATION_FLAGS_ALLOW_USER_INTERACTION flag. This is because it may potentially take minutes (or even hours) for the operation to complete because it involves waiting for the user to authenticate.

    Known keys in details include polkit.message and polkit.gettext_domain that can be used to override the message shown to the user. See the documentation for the D-Bus method for more details.

    Parameters

    Returns AuthorizationResult

  • connect(sigName: "changed", callback: Authority_ChangedSignalCallback): number
  • connect(sigName: "notify::backend-features", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::backend-name", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::backend-version", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::owner", callback: ((...args: any[]) => void)): number
  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • Parameters

    Returns number

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • emit(sigName: "changed", ...args: any[]): void
  • emit(sigName: "notify::backend-features", ...args: any[]): void
  • emit(sigName: "notify::backend-name", ...args: any[]): void
  • emit(sigName: "notify::backend-version", ...args: any[]): void
  • emit(sigName: "notify::owner", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • Parameters

    • sigName: "changed"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::backend-features"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::backend-name"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::backend-version"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::owner"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: string
    • Rest ...args: any[]

    Returns void

  • Asynchronously retrieves all registered actions.

    When the operation is finished, callback will be invoked in the

    thread-default main loop of the thread you are calling this method from. You can then call polkit_authority_enumerate_actions_finish() to get the result of the operation.

    Parameters

    Returns void

  • Synchronously retrieves all registered actions - the calling thread is blocked until a reply is received. See polkit_authority_enumerate_actions() for the asynchronous version.

    Parameters

    Returns ActionDescription[]

  • Asynchronously gets all temporary authorizations for subject.

    When the operation is finished, callback will be invoked in the

    thread-default main loop of the thread you are calling this method from. You can then call polkit_authority_enumerate_temporary_authorizations_finish() to get the result of the operation.

    Parameters

    Returns void

  • Synchronousky gets all temporary authorizations for subject.

    The calling thread is blocked until a reply is received. See polkit_authority_enumerate_temporary_authorizations() for the asynchronous version.

    Parameters

    Returns TemporaryAuthorization[]

  • 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

  • getBackendName(): string
  • getBackendVersion(): 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

  • getOwner(): string
  • The unique name on the system message bus of the owner of the name org.freedesktop.PolicyKit1 or %NULL if no-one currently owns the name. You may connect to the #GObject::notify signal to track changes to the #PolkitAuthority:owner property.

    Returns string

  • 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
  • This function gets back user data pointers stored via g_object_set_qdata().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns 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

  • Initializes the object implementing the interface.

    This method is intended for language bindings. If writing in C, g_initable_new() should typically be used instead.

    The object must be initialized before any real use after initial construction, either with this function or g_async_initable_init_async().

    Implementations may also support cancellation. If cancellable is not %NULL, then initialization can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If cancellable is not %NULL and the object doesn't support cancellable initialization the error %G_IO_ERROR_NOT_SUPPORTED will be returned.

    If the object is not initialized, or initialization returns with an error, then all operations on the object except g_object_ref() and g_object_unref() are considered to be invalid, and have undefined behaviour. See the [introduction][ginitable] for more details.

    Callers should not assume that a class which implements #GInitable can be initialized multiple times, unless the class explicitly documents itself as supporting this. Generally, a class’ implementation of init() can assume (and assert) that it will only be called once. Previously, this documentation recommended all #GInitable implementations should be idempotent; that recommendation was relaxed in GLib 2.54.

    If a class explicitly supports being initialized multiple times, it is recommended that the method is idempotent: multiple calls with the same arguments should return the same results. Only the first call initializes the object; further calls return the result of the first call.

    One reason why a class might need to support idempotent initialization is if it is designed to be used via the singleton pattern, with a #GObjectClass.constructor that sometimes returns an existing instance. In this pattern, a caller would expect to be able to call g_initable_init() on the result of g_object_new(), regardless of whether it is in fact a new instance.

    Parameters

    • Optional cancellable: Gio.Cancellable

      optional #GCancellable object, %NULL to ignore.

    Returns boolean

  • Starts asynchronous initialization of the object implementing the interface. This must be done before any real use of the object after initial construction. If the object also implements #GInitable you can optionally call g_initable_init() instead.

    This method is intended for language bindings. If writing in C, g_async_initable_new_async() should typically be used instead.

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

    Implementations may also support cancellation. If cancellable is not %NULL, then initialization can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If cancellable is not %NULL, and the object doesn't support cancellable initialization, the error %G_IO_ERROR_NOT_SUPPORTED will be returned.

    As with #GInitable, if the object is not initialized, or initialization returns with an error, then all operations on the object except g_object_ref() and g_object_unref() are considered to be invalid, and have undefined behaviour. They will often fail with g_critical() or g_warning(), but this must not be relied on.

    Callers should not assume that a class which implements #GAsyncInitable can be initialized multiple times; for more information, see g_initable_init(). If a class explicitly supports being initialized multiple times, implementation requires yielding all subsequent calls to init_async() on the results of the first call.

    For classes that also support the #GInitable interface, the default implementation of this method will run the g_initable_init() function in a thread, so if you want to support asynchronous initialization via threads, just implement the #GAsyncInitable interface without overriding any interface methods.

    Parameters

    • ioPriority: number

      the [I/O priority][io-priority] of the operation

    • Optional cancellable: Gio.Cancellable

      optional #GCancellable object, %NULL to ignore.

    • Optional callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • isFloating(): boolean
  • 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: "changed", callback: Authority_ChangedSignalCallback): EventEmitter
  • off(sigName: "notify::backend-features", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::backend-name", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::backend-version", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::owner", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: string, callback: ((...args: any[]) => void)): EventEmitter
  • Parameters

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::owner"
    • 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: "changed", callback: Authority_ChangedSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "notify::backend-features", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::backend-name", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::backend-version", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::owner", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::owner"
    • 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: "changed", callback: Authority_ChangedSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "notify::backend-features", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::backend-name", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::backend-version", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::owner", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::owner"
    • 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

  • 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

  • Asynchronously registers an authentication agent.

    Note that this should be called by the same effective UID which will be the real UID using the #PolkitAgentSession API or otherwise calling polkit_authority_authentication_agent_response().

    When the operation is finished, callback will be invoked in the

    thread-default main loop of the thread you are calling this method from. You can then call polkit_authority_register_authentication_agent_finish() to get the result of the operation.

    Parameters

    • subject: Polkit.Subject

      The subject the authentication agent is for, typically a #PolkitUnixSession object.

    • locale: string

      The locale of the authentication agent.

    • objectPath: string

      The object path for the authentication agent.

    • cancellable: Gio.Cancellable

      A #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      A #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • registerAuthenticationAgentFinish(res: AsyncResult): boolean
  • Finishes registering an authentication agent.

    Parameters

    • res: AsyncResult

      A #GAsyncResult obtained from the callback.

    Returns boolean

  • Registers an authentication agent.

    Note that this should be called by the same effective UID which will be the real UID using the #PolkitAgentSession API or otherwise calling polkit_authority_authentication_agent_response().

    The calling thread is blocked until a reply is received. See polkit_authority_register_authentication_agent() for the asynchronous version.

    Parameters

    • subject: Polkit.Subject

      The subject the authentication agent is for, typically a #PolkitUnixSession object.

    • locale: string

      The locale of the authentication agent.

    • objectPath: string

      The object path for the authentication agent.

    • cancellable: Gio.Cancellable

      A #GCancellable or %NULL.

    Returns boolean

  • Asynchronously registers an authentication agent.

    Note that this should be called by the same effective UID which will be the real UID using the #PolkitAgentSession API or otherwise calling polkit_authority_authentication_agent_response().

    When the operation is finished, callback will be invoked in the

    thread-default main loop of the thread you are calling this method from. You can then call polkit_authority_register_authentication_agent_with_options_finish() to get the result of the operation.

    Parameters

    • subject: Polkit.Subject

      The subject the authentication agent is for, typically a #PolkitUnixSession object.

    • locale: string

      The locale of the authentication agent.

    • objectPath: string

      The object path for the authentication agent.

    • options: GLib.Variant

      A #GVariant with options or %NULL.

    • cancellable: Gio.Cancellable

      A #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      A #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • registerAuthenticationAgentWithOptionsFinish(res: AsyncResult): boolean
  • Finishes registering an authentication agent.

    Parameters

    • res: AsyncResult

      A #GAsyncResult obtained from the callback.

    Returns boolean

  • Registers an authentication agent.

    Note that this should be called by the same effective UID which will be the real UID using the #PolkitAgentSession API or otherwise calling polkit_authority_authentication_agent_response().

    The calling thread is blocked until a reply is received. See polkit_authority_register_authentication_agent_with_options() for the asynchronous version.

    Parameters

    • subject: Polkit.Subject

      The subject the authentication agent is for, typically a #PolkitUnixSession object.

    • locale: string

      The locale of the authentication agent.

    • objectPath: string

      The object path for the authentication agent.

    • options: GLib.Variant

      A #GVariant with options or %NULL.

    • cancellable: Gio.Cancellable

      A #GCancellable or %NULL.

    Returns boolean

  • Asynchronously revoke a temporary authorization.

    When the operation is finished, callback will be invoked in the

    thread-default main loop of the thread you are calling this method from. You can then call polkit_authority_revoke_temporary_authorization_by_id_finish() to get the result of the operation.

    Parameters

    • id: string

      The opaque identifier for the temporary authorization.

    • cancellable: Gio.Cancellable

      A #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      A #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • revokeTemporaryAuthorizationByIdFinish(res: AsyncResult): boolean
  • Finishes revoking a temporary authorization by id.

    Parameters

    • res: AsyncResult

      A #GAsyncResult obtained from the callback.

    Returns boolean

  • revokeTemporaryAuthorizationByIdSync(id: string, cancellable: Gio.Cancellable): boolean
  • Synchronously revokes a temporary authorization.

    The calling thread is blocked until a reply is received. See polkit_authority_revoke_temporary_authorization_by_id() for the asynchronous version.

    Parameters

    • id: string

      The opaque identifier for the temporary authorization.

    • cancellable: Gio.Cancellable

      A #GCancellable or %NULL.

    Returns boolean

  • Asynchronously revokes all temporary authorizations for subject.

    When the operation is finished, callback will be invoked in the

    thread-default main loop of the thread you are calling this method from. You can then call polkit_authority_revoke_temporary_authorizations_finish() to get the result of the operation.

    Parameters

    • subject: Polkit.Subject

      The subject to revoke authorizations from, typically a #PolkitUnixSession.

    • cancellable: Gio.Cancellable

      A #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      A #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • revokeTemporaryAuthorizationsFinish(res: AsyncResult): boolean
  • Finishes revoking temporary authorizations.

    Parameters

    • res: AsyncResult

      A #GAsyncResult obtained from the callback.

    Returns boolean

  • Synchronously revokes all temporary authorization from subject.

    The calling thread is blocked until a reply is received. See polkit_authority_revoke_temporary_authorizations() for the asynchronous version.

    Parameters

    • subject: Polkit.Subject

      The subject to revoke authorizations from, typically a #PolkitUnixSession.

    • cancellable: Gio.Cancellable

      A #GCancellable or %NULL.

    Returns boolean

  • 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

  • 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

  • setProperty(propertyName: string, value?: any): void
  • Sets a property on an object.

    Parameters

    • propertyName: string

      the name of the property to set

    • Optional value: any

      the value

    Returns 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

  • 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

  • Asynchronously unregisters an authentication agent.

    When the operation is finished, callback will be invoked in the

    thread-default main loop of the thread you are calling this method from. You can then call polkit_authority_unregister_authentication_agent_finish() to get the result of the operation.

    Parameters

    • subject: Polkit.Subject

      The subject the authentication agent is for, typically a #PolkitUnixSession object.

    • objectPath: string

      The object path for the authentication agent.

    • cancellable: Gio.Cancellable

      A #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      A #GAsyncReadyCallback to call when the request is satisfied.

    Returns void

  • unregisterAuthenticationAgentFinish(res: AsyncResult): boolean
  • Finishes unregistering an authentication agent.

    Parameters

    • res: AsyncResult

      A #GAsyncResult obtained from the callback.

    Returns boolean

  • Unregisters an authentication agent. The calling thread is blocked until a reply is received. See polkit_authority_unregister_authentication_agent() for the asynchronous version.

    Parameters

    • subject: Polkit.Subject

      The subject the authentication agent is for, typically a #PolkitUnixSession object.

    • objectPath: string

      The object path for the authentication agent.

    • cancellable: Gio.Cancellable

      A #GCancellable or %NULL.

    Returns boolean

  • 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
  • Asynchronously gets a reference to the authority.

    This is an asynchronous failable function. When the result is ready, callback will be invoked in the thread-default main loop of the thread you are calling this method from and you can use polkit_authority_get_finish() to get the result. See polkit_authority_get_sync() for the synchronous version.

    Parameters

    Returns void

  • Finishes an operation started with polkit_authority_get_async().

    Parameters

    • res: AsyncResult

      A #GAsyncResult obtained from the #GAsyncReadyCallback passed to polkit_authority_get_async().

    Returns Authority

  • Synchronously gets a reference to the authority.

    This is a synchronous failable function - the calling thread is blocked until a reply is received. See polkit_authority_get_async() for the asynchronous version.

    Parameters

    Returns Authority

  • 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