channel-text

channel-text

Synopsis

                    TplChannelTextPriv;
TplChannelText *    tpl_channel_text_new                (TpConnection *conn,
                                                         const gchar *object_path,
                                                         GHashTable *tp_chan_props,
                                                         TpAccount *account,
                                                         GError **error);
TplChannel *        tpl_channel_text_get_tpl_channel    (TplChannelText *self);
TpContact *         tpl_channel_text_get_remote_contact (TplChannelText *self);
TpContact *         tpl_channel_text_get_my_contact     (TplChannelText *self);
gboolean            tpl_channel_text_is_chatroom        (TplChannelText *self);
const gchar *       tpl_channel_text_get_chatroom_id    (TplChannelText *self);
void                tpl_channel_text_set_tpl_channel    (TplChannelText *self,
                                                         TplChannel *tpl_chan);
void                tpl_channel_text_set_remote_contact (TplChannelText *self,
                                                         TpContact *data);
void                tpl_channel_text_set_my_contact     (TplChannelText *self,
                                                         TpContact *data);
void                tpl_channel_text_set_chatroom       (TplChannelText *self,
                                                         gboolean data);
void                tpl_channel_text_set_chatroom_id    (TplChannelText *self,
                                                         const gchar *data);
void                tpl_channel_text_call_when_ready    (TplChannelText *self,
                                                         GAsyncReadyCallback cb,
                                                         gpointer user_data);

Description

Details

TplChannelTextPriv

typedef struct _TplChannelTextPriv TplChannelTextPriv;


tpl_channel_text_new ()

TplChannelText *    tpl_channel_text_new                (TpConnection *conn,
                                                         const gchar *object_path,
                                                         GHashTable *tp_chan_props,
                                                         TpAccount *account,
                                                         GError **error);

Convenience function to create a new TPL Channel Text proxy. The returned TplChannelText is not guaranteed to be ready at the point of return.

TplChannelText is actually a subclass of the abstract TplChannel which is a subclass of TpChannel. Use TpChannel methods, casting the TplChannelText instance to a TpChannel, to access TpChannel data/methods from it.

TplChannelText is usually created using tpl_channel_factory_build, from within a TplObserver singleton, when its Observer_Channel method is called by the Channel Dispatcher.

conn :

TpConnection instance owning the channel

object_path :

the channel's DBus path

tp_chan_props :

channel's immutable properties, obtained for example by %tp_channel_borrow_immutable_properties()

account :

TpAccount instance, related to the new TplChannelText

error :

location of the GError, used in case a problem is raised while creating the channel

Returns :

the TplChannelText instance or NULL in object_path is not valid

tpl_channel_text_get_tpl_channel ()

TplChannel *        tpl_channel_text_get_tpl_channel    (TplChannelText *self);

self :

Returns :


tpl_channel_text_get_remote_contact ()

TpContact *         tpl_channel_text_get_remote_contact (TplChannelText *self);

self :

Returns :


tpl_channel_text_get_my_contact ()

TpContact *         tpl_channel_text_get_my_contact     (TplChannelText *self);

self :

Returns :


tpl_channel_text_is_chatroom ()

gboolean            tpl_channel_text_is_chatroom        (TplChannelText *self);

self :

Returns :


tpl_channel_text_get_chatroom_id ()

const gchar *       tpl_channel_text_get_chatroom_id    (TplChannelText *self);

self :

Returns :


tpl_channel_text_set_tpl_channel ()

void                tpl_channel_text_set_tpl_channel    (TplChannelText *self,
                                                         TplChannel *tpl_chan);

self :

tpl_chan :


tpl_channel_text_set_remote_contact ()

void                tpl_channel_text_set_remote_contact (TplChannelText *self,
                                                         TpContact *data);

self :

data :


tpl_channel_text_set_my_contact ()

void                tpl_channel_text_set_my_contact     (TplChannelText *self,
                                                         TpContact *data);

self :

data :


tpl_channel_text_set_chatroom ()

void                tpl_channel_text_set_chatroom       (TplChannelText *self,
                                                         gboolean data);

self :

data :


tpl_channel_text_set_chatroom_id ()

void                tpl_channel_text_set_chatroom_id    (TplChannelText *self,
                                                         const gchar *data);

self :

data :


tpl_channel_text_call_when_ready ()

void                tpl_channel_text_call_when_ready    (TplChannelText *self,
                                                         GAsyncReadyCallback cb,
                                                         gpointer user_data);

self :

cb :

user_data :