aboutsummaryrefslogtreecommitdiff
path: root/lib/identity/definitions/request_email_validation.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/identity/definitions/request_email_validation.h')
-rw-r--r--lib/identity/definitions/request_email_validation.h37
1 files changed, 19 insertions, 18 deletions
diff --git a/lib/identity/definitions/request_email_validation.h b/lib/identity/definitions/request_email_validation.h
index 99487073..32c6eaaf 100644
--- a/lib/identity/definitions/request_email_validation.h
+++ b/lib/identity/definitions/request_email_validation.h
@@ -6,35 +6,36 @@
#include "converters.h"
-namespace Quotient
-{
+namespace Quotient {
// Data structures
-struct RequestEmailValidation
-{
- /// A unique string generated by the client, and used to identify
- /// thevalidation attempt. It must be a string consisting of the
- /// characters``[0-9a-zA-Z.=_-]``. Its length must not exceed 255 characters
- /// and itmust not be empty.
+struct RequestEmailValidation {
+ /// 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.
QString clientSecret;
+
/// The email address to validate.
QString email;
- /// The server will only send an email if the ``send_attempt``is a number
- /// greater than the most recent one which it has seen,scoped to that
- /// ``email`` + ``client_secret`` pair. This is toavoid repeatedly sending
- /// the same email in the case of requestretries between the POSTing user
- /// and the identity server.The client should increment this value if they
- /// desire a newemail (e.g. a reminder) to be sent.
+
+ /// The server will only send an email if the ``send_attempt``
+ /// is a number greater than the most recent one which it has seen,
+ /// scoped to that ``email`` + ``client_secret`` pair. This is to
+ /// avoid repeatedly sending the same email 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
+ /// email (e.g. a reminder) to be sent.
int sendAttempt;
- /// Optional. When the validation is completed, the identityserver will
- /// redirect the user to this URL.
+
+ /// Optional. When the validation is completed, the identity
+ /// server will redirect the user to this URL.
QString nextLink;
};
template <>
-struct JsonObjectConverter<RequestEmailValidation>
-{
+struct JsonObjectConverter<RequestEmailValidation> {
static void dumpTo(QJsonObject& jo, const RequestEmailValidation& pod);
static void fillFrom(const QJsonObject& jo, RequestEmailValidation& pod);
};