#include <request_msisdn_validation.h>

Public Attributes
QString	clientSecret

QString	country

QString	phoneNumber
	The phone number to validate. More...

int	sendAttempt

QString	nextLink {}

QString	idServer {}

QString	idAccessToken {}

Detailed Description

Definition at line 9 of file request_msisdn_validation.h.

Member Data Documentation

◆ clientSecret

QString Quotient::MsisdnValidationData::clientSecret

A unique string generated by the client, and used to identify the validation attempt. It must be a string consisting of the characters [0-9a-zA-Z.=_-]. Its length must not exceed 255 characters and it must not be empty.

Definition at line 14 of file request_msisdn_validation.h.

◆ country

QString Quotient::MsisdnValidationData::country

The two-letter uppercase ISO-3166-1 alpha-2 country code that the number in phone_number should be parsed as if it were dialled from.

Definition at line 18 of file request_msisdn_validation.h.

◆ idAccessToken

QString Quotient::MsisdnValidationData::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.

Required if an id_server is supplied.

Definition at line 50 of file request_msisdn_validation.h.

◆ idServer

QString Quotient::MsisdnValidationData::idServer {}

The hostname of the identity server to communicate with. May optionally include a port. This parameter is ignored when the homeserver handles 3PID verification.

This parameter is deprecated with a plan to be removed in a future specification version for /account/password and /register requests.

Definition at line 43 of file request_msisdn_validation.h.

◆ nextLink

QString Quotient::MsisdnValidationData::nextLink {}

Optional. When the validation is completed, the identity server will redirect the user to this URL. This option is ignored when submitting 3PID validation information through a POST request.

Definition at line 35 of file request_msisdn_validation.h.

◆ phoneNumber

QString Quotient::MsisdnValidationData::phoneNumber

The phone number to validate.

Definition at line 21 of file request_msisdn_validation.h.

◆ sendAttempt

int Quotient::MsisdnValidationData::sendAttempt

The server will only send an SMS if the send_attempt is a number greater than the most recent one which it has seen, scoped to that country + phone_number + client_secret triple. This is to avoid repeatedly sending the same SMS in the case of request retries between the POSTing user and the identity server. The client should increment this value if they desire a new SMS (e.g. a reminder) to be sent.

Definition at line 30 of file request_msisdn_validation.h.

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

Quotient/csapi/definitions/request_msisdn_validation.h

Public Attributes