TpBasePasswordChannel

TpBasePasswordChannel — a simple X-TELEPATHY-PASSWORD channel

Properties

gboolean may-save-response Read / Write / Construct Only

Signals

void finished Run Last

Types and Values

Object Hierarchy

    GObject
    ╰── TpBaseChannel
        ╰── TpBasePasswordChannel

Implemented Interfaces

TpBasePasswordChannel implements TpSvcChannel, TpSvcChannelTypeServerAuthentication1 and TpSvcChannelInterfaceSASLAuthentication1.

Includes

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

Description

This class implements a SASL Authentication channel with the X-TELEPATHY-PASSWORD SASL mechanism. Most of the time, you should not use or instantiate this class directly. It is used by TpSimplePasswordManager behind the scenes. In some special circumstances (e.g. when the authentication channel needs to implement additional interfaces), it may be necessary to create your own custom authentication channels instead of letting TpSimplePasswordManager create them automatically. In this case, you should derive your channel from this class and then pass the channel as an argument to tp_simple_password_manager_prompt_for_channel_async().

Functions

Types and Values

struct TpBasePasswordChannel

struct TpBasePasswordChannel;

Data structure representing a channel implementing a SASL Authentication channel with the X-TELEPATHY-PASSWORD SASL mechanism.

Since 0.13.15

Property Details

The “may-save-response” property

  “may-save-response”        gboolean

Whether the client may save the authentication response.

Flags: Read / Write / Construct Only

Default value: TRUE

Signal Details

The “finished” signal

void
user_function (TpBasePasswordChannel *password,
               GString               *domain,
               guint                  code,
               gint                   message,
               gchar                 *arg4,
               gpointer               user_data)

Emitted when either the password has been provided by the user or the authentication has been aborted.

Parameters

password

the password provided by the user, or NULL if the authentication has been aborted

 

domain

domain of a GError indicating why the authentication has been aborted, or 0

 

code

error code of a GError indicating why the authentication has been aborted, or 0

 

message

a message associated with the error, or NULL

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since 0.13.15