libQuotient
A Qt library for building matrix clients
Quotient::SsoSession Class Reference

#include <ssosession.h>

Inheritance diagram for Quotient::SsoSession:
Collaboration diagram for Quotient::SsoSession:

Public Member Functions

 SsoSession (Connection *connection, const QString &initialDeviceName, const QString &deviceId={})
 
 ~SsoSession () override=default
 
QUrl ssoUrl () const
 
QUrl callbackUrl () const
 

Properties

QUrl ssoUrl
 
QUrl callbackUrl
 

Detailed Description

Single sign-on (SSO) session encapsulation

This class is responsible for setting up of a new SSO session, providing a URL to be opened (usually, in a web browser) and handling the callback response after completing the single sign-on, all the way to actually logging the user in. It does NOT open and render the SSO URL, it only does the necessary backstage work.

Clients only need to open the URL; the rest is done for them. Client code can look something like:

QDesktopServices::openUrl(
connection->prepareForSso(initialDeviceName)->ssoUrl());

Definition at line 29 of file ssosession.h.

Constructor & Destructor Documentation

◆ SsoSession()

Quotient::SsoSession::SsoSession ( Connection connection,
const QString &  initialDeviceName,
const QString &  deviceId = {} 
)

◆ ~SsoSession()

Quotient::SsoSession::~SsoSession ( )
overridedefault

Member Function Documentation

◆ callbackUrl()

QUrl Quotient::SsoSession::callbackUrl ( ) const

◆ ssoUrl()

QUrl Quotient::SsoSession::ssoUrl ( ) const

Property Documentation

◆ callbackUrl

QUrl Quotient::SsoSession::callbackUrl
read

Definition at line 1 of file ssosession.h.

◆ ssoUrl

QUrl Quotient::SsoSession::ssoUrl
read

Definition at line 1 of file ssosession.h.


The documentation for this class was generated from the following file: