TpaChannel

TpaChannel

Synopsis




#define             TPA_CHANNEL_GET_PRIVATE             (obj)
                    TpaChannelPrivate;
                    TpaChannel;
TpaChannelTarget*   tpa_channel_get_target              (TpaChannel *self);
TpaChannelType      tpa_channel_get_channel_type        (TpaChannel *self);
TpaUserContact*     tpa_channel_get_owner               (TpaChannel *self);
void                tpa_channel_close                   (TpaChannel *self);
void                tpa_channel_join                    (TpaChannel *self);
gboolean            tpa_channel_has_joined              (TpaChannel *self);
gboolean            tpa_channel_has_group_support       (TpaChannel *self);
TpaContactGroup*    tpa_channel_get_contact_group       (TpaChannel *self);

Object Hierarchy


  GObject
   +----TpaObject
         +----TpaChannel
               +----TpaTextChannel
               +----TpaStreamChannel

Properties


  "proxy"                    gpointer              : Write / Construct Only
  "target"                   TpaChannelTarget      : Write / Construct Only
  "type"                     guint                 : Write / Construct Only
  "user"                     TpaUserContact        : Read / Write / Construct

Signals


  "closed"                                         : Run Last / Has Details

Description

Details

TPA_CHANNEL_GET_PRIVATE()

#define             TPA_CHANNEL_GET_PRIVATE(obj)

obj :

TpaChannelPrivate

typedef struct _TpaChannelPrivate TpaChannelPrivate;


TpaChannel

typedef struct _TpaChannel TpaChannel;


tpa_channel_get_target ()

TpaChannelTarget*   tpa_channel_get_target              (TpaChannel *self);

Get target of the channel.

self : TpaChannel instance.
Returns : TpaChannelTarget target.

tpa_channel_get_channel_type ()

TpaChannelType      tpa_channel_get_channel_type        (TpaChannel *self);

Get type of the channel.

self : TpaChannel instance.
Returns : TpaChannelType type.

tpa_channel_get_owner ()

TpaUserContact*     tpa_channel_get_owner               (TpaChannel *self);

self : TpaChannel instance.
Returns :

tpa_channel_close ()

void                tpa_channel_close                   (TpaChannel *self);

self : TpaChannel instance.

tpa_channel_join ()

void                tpa_channel_join                    (TpaChannel *self);

self :

tpa_channel_has_joined ()

gboolean            tpa_channel_has_joined              (TpaChannel *self);

self :
Returns :

tpa_channel_has_group_support ()

gboolean            tpa_channel_has_group_support       (TpaChannel *self);

self :
Returns :

tpa_channel_get_contact_group ()

TpaContactGroup*    tpa_channel_get_contact_group       (TpaChannel *self);

self :
Returns :

Property Details

The "proxy" property

  "proxy"                    gpointer              : Write / Construct Only

proxy.


The "target" property

  "target"                   TpaChannelTarget      : Write / Construct Only

target.


The "type" property

  "type"                     guint                 : Write / Construct Only

type.

Allowed values: <= 1

Default value: 0


The "user" property

  "user"                     TpaUserContact        : Read / Write / Construct

user.

Signal Details

The "closed" signal

void                user_function                      (TpaChannel *tpachannel,
                                                        gpointer    user_data)       : Run Last / Has Details

tpachannel : the object which received the signal.
user_data : user data set when the signal handler was connected.