diff options
-rw-r--r-- | examples/quick/users/doc/src/users.qdoc | 10 | ||||
-rw-r--r-- | src/enginio_client/enginio.qdoc | 2 | ||||
-rw-r--r-- | src/enginio_client/enginioidentity.cpp | 13 | ||||
-rw-r--r-- | src/enginio_client/enginiomodel.cpp | 2 |
4 files changed, 20 insertions, 7 deletions
diff --git a/examples/quick/users/doc/src/users.qdoc b/examples/quick/users/doc/src/users.qdoc index 1a49b89..ce97e3b 100644 --- a/examples/quick/users/doc/src/users.qdoc +++ b/examples/quick/users/doc/src/users.qdoc @@ -81,9 +81,9 @@ \section1 User authentication Authentication is quite easy. The only thing that needs to be done is to assign an identity, for example - \l{EnginioOAuth2Authentication}{EnginioOAuth2Authentication} object to \l{Enginio::identity}{Enginio::identity}. - After a while, \l{Enginio::authenticationState}{Enginio::authenticationState} will change and - \l{Enginio::sessionAuthenticated}{sessionAuthenticated} or \l{Enginio::sessionAuthenticationError}{sessionAuthenticationError} + \l{EnginioOAuth2Authentication}{EnginioOAuth2Authentication} object to \l{EnginioClient::identity}{EnginioClient::identity}. + After a while, \l{EnginioClient::authenticationState}{EnginioClient::authenticationState} will change and + \l{EnginioClient::sessionAuthenticated}{sessionAuthenticated} or \l{EnginioClient::sessionAuthenticationError}{sessionAuthenticationError} will be emitted. The first thing we need to do is to create an identity object: \l{EnginioOAuth2Authentication}{EnginioOAuth2Authentication} @@ -97,7 +97,7 @@ Once the authentication query finishes, the state changes to "Authenticated" or "AuthenticationFailure" depending on the authentication result. Null - assignment to the \l{Enginio::identity}{identity} causes the session to terminate immediately: + assignment to the \l{EnginioClient::identity}{identity} causes the session to terminate immediately: \snippet users/Login.qml assignNull For educational purposes, in the example we also show a log window with data attached to @@ -106,7 +106,7 @@ \section1 Registering a new user Registration of a new user is as simple as adding a new object to the "users" collection. It can be achieved - by using the \l{Enginio::create}{create} function, as shown below: + by using the \l{EnginioClient::create}{create} function, as shown below: \snippet users/Register.qml create We could also use the \l{Enginio1::EnginioModel::append}{EnginioModel::append} method in the browsing example diff --git a/src/enginio_client/enginio.qdoc b/src/enginio_client/enginio.qdoc index 33bef15..084a80f 100644 --- a/src/enginio_client/enginio.qdoc +++ b/src/enginio_client/enginio.qdoc @@ -180,7 +180,7 @@ To use Enginio's QML API, you have to import the library. import Enginio 1.0 \endcode -Initialize the \l{Enginio}{enginio client} with the \l{Enginio::backendId}{Backend Id} value, which can be copied from the Dashboard. +Initialize the \l{Enginio}{enginio client} with the \l{EnginioClient::backendId}{Backend Id} value, which can be copied from the Dashboard. Go to Dashboard ⇒ Your Backend home-view ⇒ See ’Keys box’ ⇒ Copy Backend Id value. diff --git a/src/enginio_client/enginioidentity.cpp b/src/enginio_client/enginioidentity.cpp index 5c1bce5..feb5ddc 100644 --- a/src/enginio_client/enginioidentity.cpp +++ b/src/enginio_client/enginioidentity.cpp @@ -79,6 +79,19 @@ EnginioIdentity::EnginioIdentity(EnginioIdentityPrivate &dd, QObject *parent) : QObject(dd, parent) {} +/*! + \fn EnginioIdentity::prepareSessionToken(EnginioClientConnectionPrivate *enginio); + \brief EnginioIdentity::prepareSessionToken is called by enginio client to initialize authentication + \param enginio client pointer + \internal +*/ +/*! + \fn EnginioIdentity::removeSessionToken(EnginioClientConnectionPrivate *enginio); + \brief EnginioIdentity::prepareSessionToken is called by enginio client to finalize de-authentication + \param enginio client pointer + \internal +*/ + class EnginioUserPassAuthenticationPrivate; struct DisconnectConnection { diff --git a/src/enginio_client/enginiomodel.cpp b/src/enginio_client/enginiomodel.cpp index 178f74e..346f55c 100644 --- a/src/enginio_client/enginiomodel.cpp +++ b/src/enginio_client/enginiomodel.cpp @@ -406,7 +406,7 @@ EnginioModelBase::~EnginioModelBase() */ /*! - \property EnginioModel::enginio + \property EnginioModel::client \brief The EnginioClient used by the model. \sa EnginioClient |