TpChannelIface

TpChannelIface — interface representing basic channel properties

Synopsis


#include <telepathy-glib/channel-iface.h>

void                (*TpChannelFunc)                    (TpChannelIface *self,
                                                         gpointer userdata);
                    TpChannelIface;
                    TpChannelIfaceClass;

Object Hierarchy

  GInterface
   +----TpChannelIface

Known Implementations

TpChannelIface is implemented by TpChannel.

Properties

  "channel-type"             gchar*                : Read / Write / Construct Only
  "handle"                   guint                 : Read / Write / Construct Only
  "handle-type"              guint                 : Read / Write / Construct Only
  "object-path"              gchar*                : Read / Write / Construct Only

Description

This interface defines a basic set of channel properties. It's mainly used in TpChannelFactoryIface to represent the returned channel objects.

Details

TpChannelFunc ()

void                (*TpChannelFunc)                    (TpChannelIface *self,
                                                         gpointer userdata);

A callback for functions which act on channels.

self : An object implementing the channel interface
userdata : Arbitrary user-supplied data

TpChannelIface

typedef struct _TpChannelIface TpChannelIface;

Opaque typedef representing a channel.


TpChannelIfaceClass

typedef struct {
  GTypeInterface parent_class;
} TpChannelIfaceClass;

The class of the TpChannelIface interface.

GTypeInterface parent_class; The parent interface

Property Details

The "channel-type" property

  "channel-type"             gchar*                : Read / Write / Construct Only

The D-Bus interface representing the type of this channel. Read-only except during construction (and in connection managers, attempts to set it during construction will usually be ignored or treated as an error).

This is really only read-write for the benefit of TpChannel - GLib considers CONSTRUCT_ONLY|READWRITE to be incompatible with READONLY, because CONSTRUCT_ONLY is a restriction (arguably a GLib bug)

Default value: NULL


The "handle" property

  "handle"                   guint                 : Read / Write / Construct Only

This channel's associated handle, or 0 if there is no associated handle. Read-only except during construction (and depending on the channel type, attempts to set it during construction might also be ignored).

Default value: 0


The "handle-type" property

  "handle-type"              guint                 : Read / Write / Construct Only

The type (TpHandleType) of this channel's associated handle, or 0 if there is no associated handle. Read-only except during construction (and depending on the channel type, attempts to set it during construction might also be ignored).

Default value: 0


The "object-path" property

  "object-path"              gchar*                : Read / Write / Construct Only

The D-Bus object path used for this object on the bus. Read-only except during construction.

Default value: NULL

See Also

TpSvcChannel, TpChannelFactoryIface