CognitoIdentityRequest Class

Member Function Documentation

CognitoIdentityRequest::CognitoIdentityRequest(const Action action)

Constructs a CognitoIdentityRequest object for CognitoIdentity action.

CognitoIdentityRequest::CognitoIdentityRequest(const CognitoIdentityRequest &other)

Constructs a copy of other.

[protected] CognitoIdentityRequest::CognitoIdentityRequest(CognitoIdentityRequestPrivate * const d)

Constructs aa CognitoIdentityRequest object with private implementation d.

This overload allows derived classes to provide their own private class implementation that inherits from CognitoIdentityRequestPrivate.

Action CognitoIdentityRequest::action() const

Returns the CognitoIdentity action to be performed by this request.

See also setAction().

QString CognitoIdentityRequest::actionString() const

Returns the name of the CognitoIdentity action to be performed by this request.

QString CognitoIdentityRequest::apiVersion() const

Returns the CognitoIdentity API version implemented by this request.

See also setApiVersion().

[protected] int CognitoIdentityRequest::clearParameter(const QString &name)

Removes the a name parameter from the request, then returns the number of paramters removed (typically 0 or 1).

[protected] void CognitoIdentityRequest::clearParameters()

Removes all parameters from the request.

[protected] QVariant CognitoIdentityRequest::parameter(const QString &name, const QVariant &defaultValue = QVariant()) const

Returns the value of the name pararemter if set; defaultValue otherwise.

See also setParameter().

[protected] const QVariantMap &CognitoIdentityRequest::parameters() const

Returns the parameters included in this request.

See also setParameters().

void CognitoIdentityRequest::setAction(const Action action)

Sets the CognitoIdentity action to be performed by this request to action.

See also action().

void CognitoIdentityRequest::setApiVersion(const QString &version)

Sets the CognitoIdentity API version to include in this request to version.

See also apiVersion().

[protected] void CognitoIdentityRequest::setParameter(const QString &name, const QVariant &value)

Sets the name parameter to value.

See also parameter().

[protected] void CognitoIdentityRequest::setParameters(const QVariantMap &parameters)

Sets the paramters for this request to parameters. Any request parameters set previously will be discarded.

See also parameters().

[override virtual protected] QNetworkRequest CognitoIdentityRequest::unsignedRequest(const QUrl &endpoint) const

Reimplemented from AwsAbstractRequest::unsignedRequest().

Returns a network request for the CognitoIdentity request using the given endpoint.

This CognitoIdentity implementation builds request URLs by combining the common query parameters (such as Action and Version), with any that have been added (via setParameter) by child classes.

CognitoIdentityRequest &CognitoIdentityRequest::operator=(const CognitoIdentityRequest &other)

Sets the CognitoIdentityRequest object to be equal to other.

[virtual] bool CognitoIdentityRequest::operator==(const CognitoIdentityRequest &other) const

Returns true if this request is equal to other; false otherwise.

Note, most derived *Request classes do not need to provider their own implementations of this function, since most such request classes rely on this class' parameters functionality for all request parameters, and that parameters map is already checked via this implementation.