Bug 28420 - Need accessor for all Channel properties
Summary: Need accessor for all Channel properties
Status: RESOLVED FIXED
Alias: None
Product: Telepathy
Classification: Unclassified
Component: tp-glib (show other bugs)
Version: unspecified
Hardware: Other All
: medium enhancement
Assignee: Guillaume Desmottes
QA Contact: Telepathy bugs list
URL: http://git.Collabora.co.uk/?p=user/ca...
Whiteboard: review+
Keywords: patch
Depends on:
Blocks:
 
Reported: 2010-06-07 05:11 UTC by Guillaume Desmottes
Modified: 2010-09-08 04:21 UTC (History)
0 users

See Also:
i915 platform:
i915 features:


Attachments

Description Guillaume Desmottes 2010-06-07 05:11:24 UTC
Currently only those properties have a tp_channel_get_* accessor: ChannelType, TargetHandle, TargetID.

We should probably add:

gboolean tp_channel_get_requested (TpChannel *self);
TpHandle tp_channel_get_initiator_handle  (TpChannel *self, TpHandleType *handle_type);
const gchar *       tp_channel_get_initiator_identifier (TpChannel *self);
Comment 1 Simon McVittie 2010-09-07 07:50:59 UTC
15:48 < smcv> cassidy: the only problem is Requested, which has no sensible 
              value for "I have no idea"
15:48 < cassidy> hum right :\
15:48 < smcv> cassidy: but Requested has been mandatory for ages and MC will 
              basically blow up without it
15:49 < smcv> cassidy: so I think it'd be OK to assume it was unrequested
15:50 < cassidy> yeah, new code which will use this new API will be fine
Comment 3 Simon McVittie 2010-09-08 03:27:55 UTC
> -  tp_debug_set_flags ("all");
> +  //tp_debug_set_flags ("all");

If you want to make this change (which would be entirely reasonable IMO), just delete the line.

(One day I'd like a mechanism to capture each debug log to a file, and cat them for each failed test; this is not that day, unless you're feeling tremendously enthusiastic.)

> +   * %TRUE if the channel has been requested.

I think this deserves better documentation: in practice, nobody notices that Requested is how you detect an "incoming"/"outgoing" channel. Perhaps something like this:

    %TRUE if this channel was created in response to a local request, such
    as a call to tp_account_channel_request_create_channel_async(). %FALSE
    if this channel was initiated by a remote contact
    (the #TpChannel:initiator-handle), or if it appeared as a side-effect
    of some other action.

    For instance, this is %FALSE on incoming calls and file transfers,
    remotely-initiated 1-1 text conversations, and invitations to chatrooms,
    and %TRUE on outgoing calls and file transfers, locally-initiated 1-1
    text conversations, and chatrooms joined by local user action.

> +   * The #TpHandle of the initiator of this channel.

I think it's worth expanding on this too:

    The %TP_HANDLE_TYPE_CONTACT #TpHandle of the initiator of this
    channel, or 0 if there is no particular initiator.

    If the channel was initiated by a remote contact, this handle represents
    that contact, and #TpChannel:requested will be %FALSE. For instance,
    for an incoming call this property indicates the caller, and for a
    chatroom invitation this property indicates who sent the invitation.

    If the channel was requested by the local user, #TpChannel:requested
    will be %TRUE, and this property may be the #TpChannel:group-self-handle
    or #TpConnection:self-handle.

    If the channel appeared for some other reason (for instance as a
    side-effect of connecting to the server), this property may be 0.

> +   * The identifier of the initiator of this channel.

    If #TpChannel:initiator-handle is 0, this will always be "".
    Otherwise, this will be the #TpContact:identifier of the contact
    with that handle.
Comment 4 Guillaume Desmottes 2010-09-08 03:55:00 UTC
Fixed (I squashed the changes).
Comment 5 Simon McVittie 2010-09-08 04:01:42 UTC
Ship it!
Comment 6 Guillaume Desmottes 2010-09-08 04:21:42 UTC
Merged to master, will be in 0.11.15


Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.