Gjsify LogoGjsify Logo

The #MMModemCdma structure contains private data and should only be accessed using the provided API.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Properties

activation_state: number

Represents the D-Bus property "ActivationState".

Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

cdma1x_registration_state: number

Represents the D-Bus property "Cdma1xRegistrationState".

Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

esn: string

Represents the D-Bus property "Esn".

Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

evdo_registration_state: number

Represents the D-Bus property "EvdoRegistrationState".

Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

g_bus_type: Gio.BusType

If this property is not %G_BUS_TYPE_NONE, then #GDBusProxy:g-connection must be %NULL and will be set to the #GDBusConnection obtained by calling g_bus_get() with the value of this property.

g_connection: DBusConnection

The #GDBusConnection the proxy is for.

g_default_timeout: number

The timeout to use if -1 (specifying default timeout) is passed as timeout_msec in the g_dbus_proxy_call() and g_dbus_proxy_call_sync() functions.

This allows applications to set a proxy-wide timeout for all remote method invocations on the proxy. If this property is -1, the default timeout (typically 25 seconds) is used. If set to %G_MAXINT, then no timeout is used.

Flags from the #GDBusProxyFlags enumeration.

g_interface_info: DBusInterfaceInfo

Ensure that interactions with this proxy conform to the given interface. This is mainly to ensure that malformed data received from the other peer is ignored. The given #GDBusInterfaceInfo is said to be the "expected interface".

The checks performed are:

  • When completing a method call, if the type signature of the reply message isn't what's expected, the reply is discarded and the #GError is set to %G_IO_ERROR_INVALID_ARGUMENT.

  • Received signals that have a type signature mismatch are dropped and a warning is logged via g_warning().

  • Properties received via the initial GetAll() call or via the ::PropertiesChanged signal (on the org.freedesktop.DBus.Properties interface) or set using g_dbus_proxy_set_cached_property() with a type signature mismatch are ignored and a warning is logged via g_warning().

Note that these checks are never done on methods, signals and properties that are not referenced in the given #GDBusInterfaceInfo, since extending a D-Bus interface on the service-side is not considered an ABI break.

g_interface_name: string

The D-Bus interface name the proxy is for.

g_name: string

The well-known or unique name that the proxy is for.

g_name_owner: string

The unique name that owns #GDBusProxy:g-name or %NULL if no-one currently owns that name. You may connect to #GObject::notify signal to track changes to this property.

g_object_path: string

The object path the proxy is for.

g_type_instance: TypeInstance
meid: string

Represents the D-Bus property "Meid".

Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

nid: number

Represents the D-Bus property "Nid".

Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

sid: number

Represents the D-Bus property "Sid".

Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

$gtype: GType<ModemCdma>
name: string

Methods

  • Asynchronously requests to provision the modem for use with a given carrier using the modem's OTA activation functionality, if any.

    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 mm_modem_cdma_activate_finish() to get the result of the operation.

    See mm_modem_cdma_activate_sync() for the synchronous, blocking version of this method.

    Parameters

    • carrier: string

      Name of the carrier.

    • cancellable: Gio.Cancellable

      A #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      A #GAsyncReadyCallback to call when the request is satisfied or %NULL.

    Returns void

  • Finishes an operation started with mm_modem_cdma_activate().

    Parameters

    • res: AsyncResult

      The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_cdma_activate().

    Returns boolean

  • Asynchronously requests to provision the modem with the given properties.

    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 mm_modem_cdma_activate_manual_finish() to get the result of the operation.

    See mm_modem_cdma_activate_manual_sync() for the synchronous, blocking version of this method.

    Parameters

    Returns void

  • Finishes an operation started with mm_modem_cdma_activate_manual().

    Parameters

    • res: AsyncResult

      The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_cdma_activate_manual().

    Returns boolean

  • Synchronously requests to provision the modem with the given properties.

    The calling thread is blocked until a reply is received. See mm_modem_cdma_activate_manual() for the asynchronous version of this method.

    Parameters

    Returns boolean

  • Synchronously requests to provision the modem for use with a given carrier using the modem's OTA activation functionality, if any.

    The calling thread is blocked until a reply is received. See mm_modem_cdma_activate() for the asynchronous version of this method.

    Parameters

    • carrier: string

      Name of the carrier.

    • 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

    • 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

  • Asynchronously invokes the method_name method on proxy.

    If method_name contains any dots, then name is split into interface and method name parts. This allows using proxy for invoking methods on other interfaces.

    If the #GDBusConnection associated with proxy is closed then the operation will fail with %G_IO_ERROR_CLOSED. If cancellable is canceled, the operation will fail with %G_IO_ERROR_CANCELLED. If parameters contains a value not compatible with the D-Bus protocol, the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.

    If the parameters #GVariant is floating, it is consumed. This allows convenient 'inline' use of g_variant_new(), e.g.:

     g_dbus_proxy_call (proxy,
    "TwoStrings",
    g_variant_new ("(ss)",
    "Thing One",
    "Thing Two"),
    G_DBUS_CALL_FLAGS_NONE,
    -1,
    NULL,
    (GAsyncReadyCallback) two_strings_done,
    &data);

    If proxy has an expected interface (see #GDBusProxy:g-interface-info) and method_name is referenced by it, then the return value is checked against the return type.

    This is an asynchronous method. When the operation is finished, callback will be invoked in the [thread-default main context][g-main-context-push-thread-default] of the thread you are calling this method from. You can then call g_dbus_proxy_call_finish() to get the result of the operation. See g_dbus_proxy_call_sync() for the synchronous version of this method.

    If callback is %NULL then the D-Bus method call message will be sent with the %G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set.

    Parameters

    • method_name: string

      Name of method to invoke.

    • parameters: GLib.Variant

      A #GVariant tuple with parameters for the signal or %NULL if not passing parameters.

    • flags: DBusCallFlags

      Flags from the #GDBusCallFlags enumeration.

    • timeout_msec: number

      The timeout in milliseconds (with %G_MAXINT meaning "infinite") or -1 to use the proxy default timeout.

    • cancellable: Gio.Cancellable

      A #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result of the method invocation.

    Returns void

  • Asynchronously invokes the Activate() D-Bus method on proxy. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). You can then call mm_gdbus_modem_cdma_call_activate_finish() to get the result of the operation.

    See mm_gdbus_modem_cdma_call_activate_sync() for the synchronous, blocking version of this method.

    Parameters

    • arg_carrier_code: string

      Argument to pass with the method invocation.

    • cancellable: Gio.Cancellable

      A #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      A #GAsyncReadyCallback to call when the request is satisfied or %NULL.

    Returns void

  • Asynchronously invokes the ActivateManual() D-Bus method on proxy. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). You can then call mm_gdbus_modem_cdma_call_activate_manual_finish() to get the result of the operation.

    See mm_gdbus_modem_cdma_call_activate_manual_sync() for the synchronous, blocking version of this method.

    Parameters

    • arg_properties: GLib.Variant

      Argument to pass with the method invocation.

    • cancellable: Gio.Cancellable

      A #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      A #GAsyncReadyCallback to call when the request is satisfied or %NULL.

    Returns void

  • call_activate_sync(arg_carrier_code: string, cancellable: Gio.Cancellable): boolean
  • Synchronously invokes the Activate() D-Bus method on proxy. The calling thread is blocked until a reply is received.

    See mm_gdbus_modem_cdma_call_activate() for the asynchronous version of this method.

    Parameters

    • arg_carrier_code: string

      Argument to pass with the method invocation.

    • cancellable: Gio.Cancellable

      A #GCancellable or %NULL.

    Returns boolean

  • Synchronously invokes the method_name method on proxy.

    If method_name contains any dots, then name is split into interface and method name parts. This allows using proxy for invoking methods on other interfaces.

    If the #GDBusConnection associated with proxy is disconnected then the operation will fail with %G_IO_ERROR_CLOSED. If cancellable is canceled, the operation will fail with %G_IO_ERROR_CANCELLED. If parameters contains a value not compatible with the D-Bus protocol, the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.

    If the parameters #GVariant is floating, it is consumed. This allows convenient 'inline' use of g_variant_new(), e.g.:

     g_dbus_proxy_call_sync (proxy,
    "TwoStrings",
    g_variant_new ("(ss)",
    "Thing One",
    "Thing Two"),
    G_DBUS_CALL_FLAGS_NONE,
    -1,
    NULL,
    &error);

    The calling thread is blocked until a reply is received. See g_dbus_proxy_call() for the asynchronous version of this method.

    If proxy has an expected interface (see #GDBusProxy:g-interface-info) and method_name is referenced by it, then the return value is checked against the return type.

    Parameters

    • method_name: string

      Name of method to invoke.

    • parameters: GLib.Variant

      A #GVariant tuple with parameters for the signal or %NULL if not passing parameters.

    • flags: DBusCallFlags

      Flags from the #GDBusCallFlags enumeration.

    • timeout_msec: number

      The timeout in milliseconds (with %G_MAXINT meaning "infinite") or -1 to use the proxy default timeout.

    • cancellable: Gio.Cancellable

      A #GCancellable or %NULL.

    Returns GLib.Variant

  • Like g_dbus_proxy_call() but also takes a #GUnixFDList object.

    This method is only available on UNIX.

    Parameters

    • method_name: string

      Name of method to invoke.

    • parameters: GLib.Variant

      A #GVariant tuple with parameters for the signal or %NULL if not passing parameters.

    • flags: DBusCallFlags

      Flags from the #GDBusCallFlags enumeration.

    • timeout_msec: number

      The timeout in milliseconds (with %G_MAXINT meaning "infinite") or -1 to use the proxy default timeout.

    • fd_list: UnixFDList

      A #GUnixFDList or %NULL.

    • cancellable: Gio.Cancellable

      A #GCancellable or %NULL.

    • callback: AsyncReadyCallback

      A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result of the method invocation.

    Returns void

  • Helper function used in service implementations to finish handling invocations of the Activate() D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

    This method will free invocation, you cannot use it afterwards.

    Parameters

    Returns void

  • Helper function used in service implementations to finish handling invocations of the ActivateManual() D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

    This method will free invocation, you cannot use it afterwards.

    Parameters

    Returns void

  • connect(sigName: "notify::g-bus-type", callback: (($obj: ModemCdma, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::g-connection", callback: (($obj: ModemCdma, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::g-default-timeout", callback: (($obj: ModemCdma, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::g-flags", callback: (($obj: ModemCdma, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::g-interface-info", callback: (($obj: ModemCdma, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::g-interface-name", callback: (($obj: ModemCdma, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::g-name", callback: (($obj: ModemCdma, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::g-name-owner", callback: (($obj: ModemCdma, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::g-object-path", callback: (($obj: ModemCdma, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::activation-state", callback: (($obj: ModemCdma, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::cdma1x-registration-state", callback: (($obj: ModemCdma, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::esn", callback: (($obj: ModemCdma, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::evdo-registration-state", callback: (($obj: ModemCdma, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::meid", callback: (($obj: ModemCdma, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::nid", callback: (($obj: ModemCdma, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::sid", callback: (($obj: ModemCdma, pspec: ParamSpec) => void)): number
  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • connect_after(sigName: "notify::g-bus-type", callback: (($obj: ModemCdma, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::g-connection", callback: (($obj: ModemCdma, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::g-default-timeout", callback: (($obj: ModemCdma, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::g-flags", callback: (($obj: ModemCdma, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::g-interface-info", callback: (($obj: ModemCdma, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::g-interface-name", callback: (($obj: ModemCdma, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::g-name", callback: (($obj: ModemCdma, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::g-name-owner", callback: (($obj: ModemCdma, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::g-object-path", callback: (($obj: ModemCdma, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::activation-state", callback: (($obj: ModemCdma, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::cdma1x-registration-state", callback: (($obj: ModemCdma, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::esn", callback: (($obj: ModemCdma, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::evdo-registration-state", callback: (($obj: ModemCdma, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::meid", callback: (($obj: ModemCdma, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::nid", callback: (($obj: ModemCdma, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::sid", callback: (($obj: ModemCdma, pspec: ParamSpec) => void)): number
  • connect_after(sigName: string, callback: ((...args: any[]) => void)): number
  • disconnect(id: number): void
  • dup_esn(): string
  • Gets a copy of the Electronic Serial Number, as reported by this #MMModemCdma.

    The ESN is superceded by MEID, but still used in older devices.

    Returns string

  • dup_meid(): string
  • dup_path(): string
  • emit(sigName: "notify::g-bus-type", ...args: any[]): void
  • emit(sigName: "notify::g-connection", ...args: any[]): void
  • emit(sigName: "notify::g-default-timeout", ...args: any[]): void
  • emit(sigName: "notify::g-flags", ...args: any[]): void
  • emit(sigName: "notify::g-interface-info", ...args: any[]): void
  • emit(sigName: "notify::g-interface-name", ...args: any[]): void
  • emit(sigName: "notify::g-name", ...args: any[]): void
  • emit(sigName: "notify::g-name-owner", ...args: any[]): void
  • emit(sigName: "notify::g-object-path", ...args: any[]): void
  • emit(sigName: "notify::activation-state", ...args: any[]): void
  • emit(sigName: "notify::cdma1x-registration-state", ...args: any[]): void
  • emit(sigName: "notify::esn", ...args: any[]): void
  • emit(sigName: "notify::evdo-registration-state", ...args: any[]): void
  • emit(sigName: "notify::meid", ...args: any[]): void
  • emit(sigName: "notify::nid", ...args: any[]): void
  • emit(sigName: "notify::sid", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • emit_activation_state_changed(arg_activation_state: number, arg_activation_error: number, arg_status_changes: GLib.Variant): 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_cached_property(property_name: string): GLib.Variant
  • Looks up the value for a property from the cache. This call does no blocking IO.

    If proxy has an expected interface (see #GDBusProxy:g-interface-info) and property_name is referenced by it, then value is checked against the type of the property.

    Parameters

    • property_name: string

      Property name.

    Returns GLib.Variant

  • get_cached_property_names(): string[]
  • get_data(key?: string): object
  • get_default_timeout(): number
  • get_esn(): string
  • Gets the Electronic Serial Number, as reported by this #MMModemCdma.

    The ESN is superceded by MEID, but still used in older devices.

    The returned value is only valid until the property changes so it is only safe to use this function on the thread where self was constructed. Use mm_modem_cdma_dup_esn() if on another thread.

    Returns string

  • get_interface_name(): string
  • get_meid(): string
  • Gets the Mobile Equipment Identifier, as reported by this #MMModemCdma.

    The returned value is only valid until the property changes so it is only safe to use this function on the thread where self was constructed. Use mm_modem_cdma_dup_meid() if on another thread.

    Returns string

  • get_name(): string
  • Gets the name that proxy was constructed for.

    When connected to a message bus, this will usually be non-%NULL. However, it may be %NULL for a proxy that communicates using a peer-to-peer pattern.

    Returns string

  • get_name_owner(): string
  • get_nid(): number
  • get_object_path(): string
  • get_path(): string
  • 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
  • get_sid(): number
  • 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

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

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

  • 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

  • run_dispose(): void
  • set_cached_property(property_name: string, value: GLib.Variant): void
  • If value is not %NULL, sets the cached value for the property with name property_name to the value in value.

    If value is %NULL, then the cached value is removed from the property cache.

    If proxy has an expected interface (see #GDBusProxy:g-interface-info) and property_name is referenced by it, then value is checked against the type of the property.

    If the value #GVariant is floating, it is consumed. This allows convenient 'inline' use of g_variant_new(), e.g.

     g_dbus_proxy_set_cached_property (proxy,
    "SomeProperty",
    g_variant_new ("(si)",
    "A String",
    42));

    Normally you will not need to use this method since proxy is tracking changes using the org.freedesktop.DBus.Properties.PropertiesChanged D-Bus signal. However, for performance reasons an object may decide to not use this signal for some properties and instead use a proprietary out-of-band mechanism to transmit changes.

    As a concrete example, consider an object with a property ChatroomParticipants which is an array of strings. Instead of transmitting the same (long) array every time the property changes, it is more efficient to only transmit the delta using e.g. signals ChatroomParticipantJoined(String name) and ChatroomParticipantParted(String name).

    Parameters

    • property_name: string

      Property name.

    • value: GLib.Variant

      Value for the property or %NULL to remove it from the cache.

    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_default_timeout(timeout_msec: number): void
  • Sets the timeout to use if -1 (specifying default timeout) is passed as timeout_msec in the g_dbus_proxy_call() and g_dbus_proxy_call_sync() functions.

    See the #GDBusProxy:g-default-timeout property for more details.

    Parameters

    • timeout_msec: number

      Timeout in milliseconds.

    Returns void

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

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

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

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

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

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • 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

  • vfunc_activation_state_changed(arg_activation_state: number, arg_activation_error: number, arg_status_changes: GLib.Variant): void
  • vfunc_constructed(): void
  • vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: ParamSpec): void
  • vfunc_dispose(): void
  • vfunc_finalize(): void
  • vfunc_g_properties_changed(changed_properties: GLib.Variant, invalidated_properties: string): void
  • vfunc_g_signal(sender_name: string, signal_name: string, parameters: GLib.Variant): void
  • vfunc_get_property(property_id: number, value?: any, pspec?: ParamSpec): 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.

    virtual

    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.

    virtual

    Parameters

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

  • 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

  • new(...args: any[]): any
  • Asynchronously creates a proxy for the D-Bus interface org.freedesktop.ModemManager1.Modem.ModemCdma. See g_dbus_proxy_new() for more details.

    When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). You can then call mm_gdbus_modem_cdma_proxy_new_finish() to get the result of the operation.

    See mm_gdbus_modem_cdma_proxy_new_sync() for the synchronous, blocking version of this constructor.

    Parameters

    • Rest ...args: any[]

    Returns any

  • new_finish(...args: any[]): any
  • new_for_bus(...args: any[]): any
  • Like mm_gdbus_modem_cdma_proxy_new() but takes a #GBusType instead of a #GDBusConnection.

    When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). You can then call mm_gdbus_modem_cdma_proxy_new_for_bus_finish() to get the result of the operation.

    See mm_gdbus_modem_cdma_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor.

    Parameters

    • Rest ...args: any[]

    Returns any

  • new_for_bus_finish(...args: any[]): any
  • new_for_bus_sync(...args: any[]): any
  • Like mm_gdbus_modem_cdma_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection.

    The calling thread is blocked until a reply is received.

    See mm_gdbus_modem_cdma_proxy_new_for_bus() for the asynchronous version of this constructor.

    Parameters

    • Rest ...args: any[]

    Returns any

  • new_sync(...args: any[]): any
  • Synchronously creates a proxy for the D-Bus interface org.freedesktop.ModemManager1.Modem.ModemCdma. See g_dbus_proxy_new_sync() for more details.

    The calling thread is blocked until a reply is received.

    See mm_gdbus_modem_cdma_proxy_new() for the asynchronous version of this constructor.

    Parameters

    • Rest ...args: any[]

    Returns any

  • 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