Gjsify LogoGjsify Logo

A proxy object for a Telepathy connection manager.

This might represent a connection manager which is currently running (in which case it can be introspected) or not (in which case its capabilities can be read from .manager files in the filesystem). Accordingly, this object never emits #TpProxy::invalidated unless all references to it are discarded.

Various fields and methods on this object do not work until %TP_CONNECTION_MANAGER_FEATURE_CORE is prepared. Use tp_proxy_prepare_async() to wait for this to happen.

Since 0.19.1, accessing the fields of this struct is deprecated, and they are no longer documented here. Use the accessors tp_connection_manager_get_name(), tp_connection_manager_is_running(), tp_connection_manager_dup_protocols(), tp_connection_manager_get_info_source() and the #TpConnectionManager:always-introspect property instead.

Hierarchy

Index

Constructors

Properties

always_introspect: boolean

If %TRUE, always introspect the connection manager as it comes online, even if we already have its info from a .manager file. Default %FALSE.

bus_name: string

The D-Bus bus name for this object. Read-only except during construction.

cm_name: string

The name of the connection manager, e.g. "gabble" (read-only).

connection_manager: string

The name of the connection manager, e.g. "gabble" (read-only).

dbus_daemon: DBusDaemon

The D-Bus daemon for this object (this object itself, if it is a TpDBusDaemon). Read-only except during construction.

The #TpSimpleClientFactory used to create this proxy, or %NULL if this proxy was not created through a factory.

g_type_instance: TypeInstance
info_source: number

Where we got the current information on supported protocols (a #TpCMInfoSource).

Since 0.7.26, the #GObject::notify signal is emitted for this property.

(Note that this is of type %G_TYPE_UINT, not %TP_TYPE_CM_INFO_SOURCE, for historical reasons.)

interfaces: string[]

Known D-Bus interface names for this object.

manager_file: string

The absolute path of the .manager file. If set to %NULL (the default), the XDG data directories will be searched for a .manager file of the correct name.

If set to the empty string, no .manager file will be read.

object_path: string

The D-Bus object path for this object. Read-only except during construction.

name: string

Methods

  • Creates a binding between source_property on source and target_property on target.

    Whenever the source_property is changed the target_property is updated using the same value. For instance:

      g_object_bind_property (action, "active", widget, "sensitive", 0);
    

    Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.

    If flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well.

    The binding will automatically be removed when either the source or the target instances are finalized. To remove the binding without affecting the source and the target you can just call g_object_unref() on the returned #GBinding instance.

    Removing the binding by calling g_object_unref() on it must only be done if the binding, source and target are only used from a single thread and it is clear that both source and target outlive the binding. Especially it is not safe to rely on this if the binding, source or target can be finalized from different threads. Keep another reference to the binding and use g_binding_unbind() instead to be on the safe side.

    A #GObject can have multiple bindings.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns Binding

  • Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transform_to: TClosure<any, any>

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

    • transform_from: TClosure<any, any>

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

    Returns Binding

  • dbus_error_to_gerror(dbus_error: string, debug_message: string): void
  • Convert a D-Bus error name into a GError as if it was returned by a method on this proxy. This method is useful when D-Bus error names are emitted in signals, such as Connection.ConnectionError and Group.MembersChangedDetailed.

    Parameters

    • dbus_error: string

      a D-Bus error name, for instance from the callback for tp_cli_connection_connect_to_connection_error()

    • debug_message: string

      a debug message that accompanied the error name, or %NULL

    Returns void

  • disconnect(id: number): void
  • dup_protocol_names(): string[]
  • Returns a list of protocol names supported by this connection manager. These are the internal protocol names used by the Telepathy specification (e.g. "jabber" and "msn"), rather than user-visible names in any particular locale.

    If this function is called before the connection manager information has been obtained, the result is always %NULL. Use tp_proxy_prepare_async() to wait for this.

    The result is copied and must be freed by the caller, but it is not necessarily still true after the main loop is re-entered.

    Returns string[]

  • Return objects representing all protocols supported by this connection manager.

    If this function is called before the connection manager information has been obtained, the result is always %NULL. Use tp_proxy_prepare_async() to wait for this.

    The caller must free the list, for instance with g_list_free_full (l, g_object_unref).

    Returns TelepathyGLib.Protocol[]

  • emit(sigName: "activated", ...args: any[]): void
  • emit(sigName: "exited", ...args: any[]): void
  • emit(sigName: "got-info", source: number, ...args: any[]): void
  • emit(sigName: "notify::always-introspect", ...args: any[]): void
  • emit(sigName: "notify::cm-name", ...args: any[]): void
  • emit(sigName: "notify::connection-manager", ...args: any[]): void
  • emit(sigName: "notify::info-source", ...args: any[]): void
  • emit(sigName: "notify::manager-file", ...args: any[]): void
  • emit(sigName: "notify::bus-name", ...args: any[]): void
  • emit(sigName: "notify::dbus-daemon", ...args: any[]): void
  • emit(sigName: "notify::factory", ...args: any[]): void
  • emit(sigName: "notify::interfaces", ...args: any[]): void
  • emit(sigName: "notify::object-path", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • force_floating(): void
  • This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().

    Returns void

  • freeze_notify(): void
  • Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

    This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

    Returns void

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

    Parameters

    • Optional key: string

      name of the key for that association

    Returns object

  • If protocol and parameter information has been obtained from the connection manager, return %TP_CM_INFO_SOURCE_LIVE; if it has been obtained from the cache in the .manager file, return %TP_CM_INFO_SOURCE_FILE. If this information has not yet been obtained, or obtaining it failed, return %TP_CM_INFO_SOURCE_NONE.

    This may increase at any time that the main loop is running; the #GObject::notify signal is emitted.

    Returns CMInfoSource

  • get_name(): string
  • Return the internal name of this connection manager in the Telepathy D-Bus API, e.g. "gabble" or "haze". This is often the name of the binary without the "telepathy-" prefix.

    The returned string is valid as long as self is. Copy it with g_strdup() if a longer lifetime is required.

    Returns string

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

  • Returns a structure representing a protocol, or %NULL if this connection manager does not support the specified protocol.

    Since 0.11.11, you can get a #GObject version with more functionality by calling tp_connection_manager_get_protocol_object().

    If this function is called before the connection manager information has been obtained, the result is always %NULL. Use tp_proxy_prepare_async() to wait for this.

    The result is not necessarily valid after the main loop is re-entered. Since 0.11.3, it can be copied with tp_connection_manager_protocol_copy() if a permanently-valid copy is needed.

    Parameters

    • protocol: string

      the name of a protocol as defined in the Telepathy D-Bus API, e.g. "jabber" or "msn"

    Returns ConnectionManagerProtocol

  • Returns an object representing a protocol, or %NULL if this connection manager does not support the specified protocol.

    If this function is called before the connection manager information has been obtained, the result is always %NULL. Use tp_proxy_prepare_async() to wait for this.

    The result should be referenced with g_object_ref() if it will be kept.

    Parameters

    • protocol: string

      the name of a protocol as defined in the Telepathy D-Bus API, e.g. "jabber" or "msn"

    Returns TelepathyGLib.Protocol

  • get_qdata(quark: number): object
  • getv(names: string[], values: any[]): void
  • Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • has_interface(iface: string): boolean
  • Return whether this proxy is known to have a particular interface. In versions older than 0.11.11, this was a macro wrapper around tp_proxy_has_interface_by_id().

    For objects that discover their interfaces at runtime, this method will indicate that interfaces are missing until they are known to be present. In subclasses that define features for use with tp_proxy_prepare_async(), successfully preparing the "core" feature for that subclass (such as %TP_CHANNEL_FEATURE_CORE or %TP_CONNECTION_FEATURE_CORE) implies that the interfaces are known.

    Parameters

    • iface: string

      the D-Bus interface required, as a string

    Returns boolean

  • has_interface_by_id(iface: number): boolean
  • Return whether this proxy is known to have a particular interface, by its quark ID. This is equivalent to using g_quark_to_string() followed by tp_proxy_has_interface(), but more efficient.

    Parameters

    • iface: number

      quark representing the D-Bus interface required

    Returns boolean

  • has_protocol(protocol: string): boolean
  • Return whether protocol is supported by this connection manager.

    If this function is called before the connection manager information has been obtained, the result is always %FALSE. Use tp_proxy_prepare_async() to wait for this.

    Parameters

    • protocol: string

      the name of a protocol as defined in the Telepathy D-Bus API, e.g. "jabber" or "msn"

    Returns boolean

  • is_floating(): boolean
  • is_prepared(feature: number): boolean
  • Return %TRUE if feature has been prepared successfully, or %FALSE if feature has not been requested, has not been prepared yet, or is not available on this object at all.

    (For instance, if feature is %TP_CHANNEL_FEATURE_CHAT_STATES and self is a #TpChannel in a protocol that doesn't actually implement chat states, or is not a #TpChannel at all, then this method will return %FALSE.)

    To prepare features, call tp_proxy_prepare_async().

    Parameters

    • feature: number

      a feature that is supported by self's class

    Returns boolean

  • is_running(): boolean
  • Return %TRUE if this connection manager currently appears to be running. This may change at any time that the main loop is running; the #TpConnectionManager::activated and #TpConnectionManager::exited signals are emitted.

    Returns boolean

  • notify(property_name: string): void
  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    • property_name: string

      the name of a property installed on the class of object.

    Returns void

  • Emits a "notify" signal for the property specified by pspec on object.

    This function omits the property name lookup, hence it is faster than g_object_notify().

    One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:

      enum
    {
    PROP_0,
    PROP_FOO,
    PROP_LAST
    };

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
    0, 100,
    50,
    G_PARAM_READWRITE);
    g_object_class_install_property (gobject_class,
    PROP_FOO,
    properties[PROP_FOO]);
    }

    and then notify a change on the "foo" property with:

      g_object_notify_by_pspec (self, properties[PROP_FOO]);
    

    Parameters

    • pspec: ParamSpec

      the #GParamSpec of a property installed on the class of object.

    Returns void

  • #TpProxy itself does not support any features, but subclasses like #TpChannel can support features, which can either be core functionality like %TP_CHANNEL_FEATURE_CORE, or extended functionality like %TP_CHANNEL_FEATURE_CHAT_STATES.

    Proxy instances start with no features prepared. When features are requested via tp_proxy_prepare_async(), the proxy starts to do the necessary setup to use those features.

    tp_proxy_prepare_async() always waits for core functionality of the proxy's class to be prepared, even if it is not specifically requested: for instance, because %TP_CHANNEL_FEATURE_CORE is core functionality of a #TpChannel,

    |[ TpChannel *channel = ...;

    tp_proxy_prepare_async (channel, NULL, callback, user_data);



    is equivalent to

    |[
    TpChannel *channel = ...;
    GQuark features[] = { TP_CHANNEL_FEATURE_CORE, 0 };

    tp_proxy_prepare_async (channel, features, callback, user_data);

    If a feature represents core functionality (like %TP_CHANNEL_FEATURE_CORE), failure to prepare it will result in tp_proxy_prepare_async() finishing unsuccessfully: if failure to prepare the feature indicates that the proxy is no longer useful, it will also emit #TpProxy::invalidated.

    If a feature represents non-essential functionality (like %TP_CHANNEL_FEATURE_CHAT_STATES), or is not supported by the object at all, then failure to prepare it is not fatal: tp_proxy_prepare_async() will complete successfully, but tp_proxy_is_prepared() will still return %FALSE for the feature, and accessor methods for the feature will typically return a dummy value.

    Some #TpProxy subclasses automatically start to prepare their core features when instantiated, and features will sometimes become prepared as a side-effect of other actions, but to ensure that a feature is present you must generally call tp_proxy_prepare_async() and wait for the result.

    Parameters

    • features: number[]

      an array of desired features, ending with 0; %NULL is equivalent to an array containing only 0

    • callback: AsyncReadyCallback

      if not %NULL, called exactly once, when the features have all been prepared or failed to prepare, or after the proxy is invalidated

    Returns void

  • Check for error in a call to tp_proxy_prepare_async(). An error here generally indicates that either the asynchronous call was cancelled, or self has emitted #TpProxy::invalidated.

    Parameters

    • result: AsyncResult

      the result passed to the callback of tp_proxy_prepare_async()

    Returns boolean

  • 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
  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

  • set_data(key: string, data?: object): void
  • Each object carries around a table of associations from strings to pointers. This function lets you set an association.

    If the object already had an association with that name, the old association will be destroyed.

    Internally, the key is converted to a #GQuark using g_quark_from_string(). This means a copy of key is kept permanently (even after object has been finalized) — so it is recommended to only use a small, bounded set of values for key in your program, to avoid the #GQuark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optional data: object

      data to associate with that key

    Returns void

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

    Parameters

    • Optional key: string

      name of the key

    Returns object

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

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

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

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

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

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • thaw_notify(): void
  • Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

    Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.

    It is an error to call this function when the freeze count is zero.

    Returns void

  • unref(): void
  • Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

    If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.

    Returns void

  • vfunc_constructed(): void
  • vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: ParamSpec): void
  • vfunc_dispose(): void
  • vfunc_finalize(): void
  • vfunc_get_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    virtual

    Parameters

    Returns void

  • vfunc_set_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • watch_closure(closure: TClosure<any, any>): void
  • This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

    Parameters

    • closure: TClosure<any, any>

      #GClosure to watch

    Returns void

  • check_valid_name(name: string): boolean
  • Check that the given string is a valid connection manager name, i.e. that it consists entirely of ASCII letters, digits and underscores, and starts with a letter.

    Parameters

    • name: string

      a possible connection manager name

    Returns boolean

  • check_valid_protocol_name(name: string): boolean
  • Check that the given string is a valid protocol name, i.e. that it consists entirely of ASCII letters, digits and hyphen/minus, and starts with a letter.

    Parameters

    • name: string

      a possible protocol name

    Returns boolean

  • compat_control(what: number, data: object): number
  • get_feature_quark_core(): number
  • init_known_interfaces(): void
  • Ensure that the known interfaces for TpConnectionManager have been set up. This is done automatically when necessary, but for correct overriding of library interfaces by local extensions, you should call this function before calling tp_proxy_or_subclass_hook_on_interface_add() with first argument %TP_TYPE_CONNECTION_MANAGER.

    Returns void

  • Find the #GParamSpec with the given name for an interface. Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • g_iface: TypeInterface

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

    • property_name: string

      name of a property to look up.

    Returns ParamSpec

  • Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

    This function is meant to be called from the interface's default vtable initialization function (the class_init member of #GTypeInfo.) It must not be called after after class_init has been called for any object types implementing this interface.

    If pspec is a floating reference, it will be consumed.

    Parameters

    • g_iface: TypeInterface

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

    • pspec: ParamSpec

      the #GParamSpec for the new property

    Returns void

  • Lists the properties of an interface.Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • g_iface: TypeInterface

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

    Returns ParamSpec[]

  • Convenience function to create a new connection manager proxy. If its protocol and parameter information are required, you should call tp_proxy_prepare_async() on the result.

    Parameters

    • dbus: DBusDaemon

      Proxy for the D-Bus daemon

    • name: string

      The connection manager name (such as "gabble")

    • manager_filename: string

      The #TpConnectionManager:manager-file property, which may (and generally should) be %NULL.

    Returns TelepathyGLib.ConnectionManager

  • 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