Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: GTlsPassword

[14:7] extends: object

An abstract interface representing a password used in TLS. Often used in user interaction such as unlocking a key storage token.

Members

  • handleObj
  • lib
  • retainedCallbacks
  • signalHandlerNames
  • signalSetterHandlers

Methods

  • GTlsPassword (flags = null, description = null)

    Create a new #GTlsPassword object.

    • @p flags is the password flags.
    • @p description is description of what the password is for.
  • toNativeHandle (Source)

    Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

    • @p Source is the raw handle, raw buffer, wrapper, or null.
    • @r A raw pointer carrier or null when no pointer is present.
  • getLib ()

    Returns the opened native library for this generated wrapper.

    • @r The opened native library.
  • handle ()

    Returns the wrapped NativeHandle.

    • @r The wrapped NativeHandle.
  • isNull ()

    Returns true when the wrapped handle is null.

    • @r A bool.
  • describe ()

    Returns a small string for debugging generated wrappers.

    • @r A string.
  • asObject ()

    Wraps this handle as GObject.

    • @r A GObject object.
  • getProperty (string Name)

    Reads one generated property by name.

  • setProperty (string Name, Value)

    Writes one generated property by name.

  • setDescription (string Value)

    Description of what the password is for.

    • @p Value is the new property value.
    • @r None.
  • setFlags (string Value)

    Flags about the password.

    • @p Value is the new property value.
    • @r None.
  • setWarning (string Value)

    Warning about the password.

    • @p Value is the new property value.
    • @r None.
  • get_description ()

    Get a description string about what the password will be used for.

    • @r The description of the password..
  • get_flags ()

    Get flags about the password.

    • @r The flags about the password..
  • get_value ()

    Get the password value. If @length is not %NULL then it will be filled in with the length of the password value. (Note that the password value is not nul-terminated, so you can only pass %NULL for @length in contexts where you know the password will have a certain fixed length.)

    • @p length is location to place the length of the password..
    • @r The password value (owned by the password object)..
  • get_warning ()

    Get a user readable translated warning. Usually this warning is a representation of the password flags returned from g_tls_password_get_flags().

    • @r The warning..
  • set_description (string description)

    Set a description string about what the password will be used for.

    • @p description is The description of the password.
    • @r None.
  • set_flags (string flags)

    Set flags about the password.

    • @p flags is The flags about the password.
    • @r None.
  • set_value (list value)

    Set the value for this password. The @value will be copied by the password object. Specify the @length, for a non-nul-terminated password. Pass -1 as @length if using a nul-terminated password, and @length will be calculated automatically. (Note that the terminating nul is not considered part of the password in this case.)

    • @p value is the new password value.
    • @p length is the length of the password, or -1.
    • @r None.
  • set_value_full (list value, object destroy)

    Provide the value for this password. The @value will be owned by the password object, and later freed using the @destroy function callback. Specify the @length, for a non-nul-terminated password. Pass -1 as

    • @length if using a nul-terminated password, and @length will be calculated automatically. (Note that the terminating nul is not considered part of the password in this case.)
    • @p value is the value for the password.
    • @p length is the length of the password, or -1.
    • @p destroy is a function to use to free the password..
    • @r None.
  • set_warning (string warning)

    Set a user readable translated warning. Usually this warning is a representation of the password flags returned from g_tls_password_get_flags().

    • @p warning is The user readable warning.
    • @r None.

class: GTlsPasswordMeta

[286:14] static extends: object

Generated metadata helpers for TlsPassword class surfaces.

Methods

  • properties ()

    Returns property metadata for TlsPassword.

    • @r A list.