libQuotient
A Qt library for building matrix clients
Quotient::RegisterJob::Response Struct Reference

#include <registration.h>

Public Attributes

QString userId {}
 
QString accessToken {}
 
QString refreshToken {}
 
std::optional< int > expiresInMs {}
 
QString deviceId {}
 

Detailed Description

Definition at line 138 of file registration.h.

Member Data Documentation

◆ accessToken

QString Quotient::RegisterJob::Response::accessToken {}

An access token for the account. This access token can then be used to authorize other requests. Required if the inhibit_login option is false.

Definition at line 148 of file registration.h.

◆ deviceId

QString Quotient::RegisterJob::Response::deviceId {}

ID of the registered device. Will be the same as the corresponding parameter in the request, if one was specified. Required if the inhibit_login option is false.

Definition at line 170 of file registration.h.

◆ expiresInMs

std::optional<int> Quotient::RegisterJob::Response::expiresInMs {}

The lifetime of the access token, in milliseconds. Once the access token has expired a new access token can be obtained by using the provided refresh token. If no refresh token is provided, the client will need to re-log in to obtain a new access token. If not given, the client can assume that the access token will not expire.

Omitted if the inhibit_login option is true.

Definition at line 165 of file registration.h.

◆ refreshToken

QString Quotient::RegisterJob::Response::refreshToken {}

A refresh token for the account. This token can be used to obtain a new access token when it expires by calling the /refresh endpoint.

Omitted if the inhibit_login option is true.

Definition at line 155 of file registration.h.

◆ userId

QString Quotient::RegisterJob::Response::userId {}

The fully-qualified Matrix user ID (MXID) that has been registered.

Any user ID returned by this API must conform to the grammar given in the Matrix specification.

Definition at line 143 of file registration.h.


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