Home · All Classes · All Namespaces · Modules · Functions · Files |
The ServerAuthenticationChannel class is a base class for all ServerAuthentication types. More...
#include <TelepathyQt/ServerAuthenticationChannel>
Inherits Tp::Channel.
The ServerAuthenticationChannel class is a base class for all ServerAuthentication types.
A ServerAuthentication is a mechanism for a connection to perform an authentication operation. Such an authentication can happen in several ways (at the moment, only Captcha is supported) - this channel will expose a high-level object representing the requested method, allowing a handler to carry on the authentication procedure.
Note that when an authentication procedure succeeds, you can expect this channel to be closed automatically. Please refer to the methods' implementation docs for more details about this.
Class destructor.
Tp::ServerAuthenticationChannel::ServerAuthenticationChannel | ( | const ConnectionPtr & | connection, |
const QString & | objectPath, | ||
const QVariantMap & | immutableProperties, | ||
const Feature & | coreFeature = ServerAuthenticationChannel::FeatureCore |
||
) | [protected] |
Construct a new ServerAuthenticationChannel object.
connection | Connection owning this channel, and specifying the service. |
objectPath | The channel object path. |
immutableProperties | The channel immutable properties. |
coreFeature | The core feature of the channel type, if any. The corresponding introspectable should depend on ServerAuthenticationChannel::FeatureCore. |
ServerAuthenticationChannelPtr Tp::ServerAuthenticationChannel::create | ( | const ConnectionPtr & | connection, |
const QString & | objectPath, | ||
const QVariantMap & | immutableProperties | ||
) | [static] |
Create a new ServerAuthenticationChannel channel.
connection | Connection owning this channel, and specifying the service. |
objectPath | The channel object path. |
immutableProperties | The channel immutable properties. |
Reimplemented from Tp::Channel.
CaptchaAuthenticationPtr Tp::ServerAuthenticationChannel::captchaAuthentication | ( | ) | const |
Return the CaptchaAuthentication object for this channel, if the channel implements the CaptchaAuthentication interface and is a ServerAuthentication Channel.
Note that this method will return a meaningful value only if hasCaptchaInterface() returns true
.
This method requires ServerAuthenticationChannel::FeatureCore to be ready.
bool Tp::ServerAuthenticationChannel::hasCaptchaInterface | ( | ) | const |
Return whether this ServerAuthenticationChannel implements Captcha as its authentication mechanism. Should this be true, captchaAuthentication() can be safely accessed.
This method requires ServerAuthenticationChannel::FeatureCore to be ready.
true
if this channel implements the Captcha interface, false
otherwise. const Feature Tp::ServerAuthenticationChannel::FeatureCore [static] |
Feature representing the core that needs to become ready to make the ServerAuthenticationChannel object usable.
Note that this feature must be enabled in order to use most ServerAuthenticationChannel methods. See specific methods documentation for more details.
Reimplemented from Tp::Channel.
Copyright © 2008-2011 Collabora Ltd. and Nokia Corporation | Telepathy-Qt 0.9.3 |