Invite a user to participate in a particular room. More...

#include <third_party_membership.h>

Inheritance diagram for Quotient::InviteBy3PIDJob:

Collaboration diagram for Quotient::InviteBy3PIDJob:

Public Member Functions
	InviteBy3PIDJob (const QString &roomId, const QString &idServer, const QString &idAccessToken, const QString &medium, const QString &address)

Public Member Functions inherited from Quotient::BaseJob
	BaseJob (HttpVerb verb, const QString &name, QByteArray endpoint, bool needsToken=true)

	BaseJob (HttpVerb verb, const QString &name, QByteArray endpoint, const QUrlQuery &query, RequestData &&data={}, bool needsToken=true)

QUrl	requestUrl () const

bool	isBackground () const

Status	status () const

QString	statusCaption () const

QByteArray	rawData (int bytesAtMost) const

const QByteArray &	rawData () const

QString	rawDataSample (int bytesAtMost=65535) const

QJsonObject	jsonData () const

QJsonArray	jsonItems () const

template<typename T , typename StrT >
T	loadFromJson (const StrT &keyName, T &&defaultValue={}) const

template<typename T >
T	takeFromJson (const QString &key, T &&defaultValue={})

int	error () const

virtual QString	errorString () const

QUrl	errorUrl () const

int	maxRetries () const

void	setMaxRetries (int newMaxRetries)

std::chrono::seconds	getCurrentTimeout () const

Q_INVOKABLE Quotient::BaseJob::duration_ms_t	getCurrentTimeoutMs () const

std::chrono::seconds	getNextRetryInterval () const

Q_INVOKABLE Quotient::BaseJob::duration_ms_t	getNextRetryMs () const

std::chrono::milliseconds	timeToRetry () const

Q_INVOKABLE Quotient::BaseJob::duration_ms_t	millisToRetry () const

Additional Inherited Members
Public Types inherited from Quotient::BaseJob
enum	StatusCode { Success = 0 , NoError = Success , Pending = 1 , WarningLevel = 20 , UnexpectedResponseType = 21 , UnexpectedResponseTypeWarning = UnexpectedResponseType , Unprepared = 25 , Abandoned = 50 , ErrorLevel = 100 , NetworkError = 101 , Timeout , Unauthorised , ContentAccessError , NotFound , IncorrectRequest , IncorrectResponse , TooManyRequests , RateLimited = TooManyRequests , RequestNotImplemented , UnsupportedRoomVersion , NetworkAuthRequired , UserConsentRequired , CannotLeaveRoom , UserDeactivated , FileError , UserDefinedError = 256 }

using	duration_ms_t = std::chrono::milliseconds::rep

Public Slots inherited from Quotient::BaseJob
void	initiate (Quotient::ConnectionData *connData, bool inBackground)

void	abandon ()
	Abandon the result of this job, arrived or unarrived. More...

Signals inherited from Quotient::BaseJob
void	aboutToSendRequest (QNetworkRequest *req)
	The job is about to send a network request. More...

void	sentRequest ()

void	statusChanged (Quotient::BaseJob::Status newStatus)

void	retryScheduled (int nextAttempt, Quotient::BaseJob::duration_ms_t inMilliseconds)

void	rateLimited ()

void	finished (Quotient::BaseJob *job)

void	result (Quotient::BaseJob *job)

void	success (Quotient::BaseJob *)

void	failure (Quotient::BaseJob *)

void	downloadProgress (qint64 bytesReceived, qint64 bytesTotal)

void	uploadProgress (qint64 bytesSent, qint64 bytesTotal)

Static Public Member Functions inherited from Quotient::BaseJob
template<typename... StrTs>
static QByteArray	makePath (StrTs &&... parts)

Protected Types inherited from Quotient::BaseJob
using	headers_t = QHash< QByteArray, QByteArray >

Protected Slots inherited from Quotient::BaseJob
void	timeout ()

virtual Status	checkReply (const QNetworkReply *reply) const
	Check the pending or received reply for upfront issues. More...

Protected Member Functions inherited from Quotient::BaseJob
const headers_t &	requestHeaders () const

void	setRequestHeader (const headers_t::key_type &headerName, const headers_t::mapped_type &headerValue)

void	setRequestHeaders (const headers_t &headers)

QUrlQuery	query () const

void	setRequestQuery (const QUrlQuery &query)

const RequestData &	requestData () const

void	setRequestData (RequestData &&data)

const QByteArrayList &	expectedContentTypes () const

void	addExpectedContentType (const QByteArray &contentType)

void	setExpectedContentTypes (const QByteArrayList &contentTypes)

QByteArrayList	expectedKeys () const

void	addExpectedKey (const QByteArray &key)

void	setExpectedKeys (const QByteArrayList &keys)

const QNetworkReply *	reply () const

QNetworkReply *	reply ()

virtual void	doPrepare ()

virtual void	onSentRequest (QNetworkReply *)

virtual void	beforeAbandon ()

virtual Status	prepareResult ()
	An extension point for additional reply processing. More...

virtual Status	prepareError (Status currentStatus)
	Process details of the error. More...

QJsonValue	takeValueFromJson (const QString &key)
	Get direct access to the JSON response object in the job. More...

void	setStatus (Status s)

void	setStatus (int code, QString message)

void	setLoggingCategory (QMessageLogger::CategoryFunction lcf)
	Set the logging category for the given job instance. More...

	~BaseJob () override

Static Protected Member Functions inherited from Quotient::BaseJob
static QUrl	makeRequestUrl (QUrl baseUrl, const QByteArray &encodedPath, const QUrlQuery &query={})

Properties inherited from Quotient::BaseJob
QUrl	requestUrl

int	maxRetries

int	statusCode

Detailed Description

Invite a user to participate in a particular room.

Note that there are two forms of this API, which are documented separately. This version of the API does not require that the inviter know the Matrix identifier of the invitee, and instead relies on third-party identifiers. The homeserver uses an identity server to perform the mapping from third-party identifier to a Matrix identifier. The other is documented in the joining rooms section.

This API invites a user to participate in a particular room. They do not start participating in the room until they actually join the room.

Only users currently in a particular room can invite other users to join that room.

If the identity server did know the Matrix user identifier for the third-party identifier, the homeserver will append a m.room.member event to the room.

If the identity server does not know a Matrix user identifier for the passed third-party identifier, the homeserver will issue an invitation which can be accepted upon providing proof of ownership of the third- party identifier. This is achieved by the identity server generating a token, which it gives to the inviting homeserver. The homeserver will add an m.room.third_party_invite event into the graph for the room, containing that token.

When the invitee binds the invited third-party identifier to a Matrix user ID, the identity server will give the user a list of pending invitations, each containing:

The room ID to which they were invited
The token given to the homeserver
A signature of the token, signed with the identity server's private key
The matrix user ID who invited them to the room

If a token is requested from the identity server, the homeserver will append a m.room.third_party_invite event to the room.

Definition at line 51 of file third_party_membership.h.

Constructor & Destructor Documentation

◆ InviteBy3PIDJob()

Quotient::InviteBy3PIDJob::InviteBy3PIDJob	(	const QString &	roomId,
		const QString &	idServer,
		const QString &	idAccessToken,
		const QString &	medium,
		const QString &	address
	)

explicit

Parameters

roomId	The room identifier (not alias) to which to invite the user.
idServer	The hostname+port of the identity server which should be used for third-party identifier lookups.
idAccessToken	An access token previously registered with the identity server. Servers can treat this as optional to distinguish between r0.5-compatible clients and this specification version.
medium	The kind of address being passed in the address field, for example `email` (see the list of recognised values).
address	The invitee's third-party identifier.

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

Quotient/csapi/third_party_membership.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ InviteBy3PIDJob()