CognitoIdentityProviderRequest Class

Member Function Documentation

CognitoIdentityProviderRequest::CognitoIdentityProviderRequest(const Action action)

Constructs a CognitoIdentityProviderRequest object for CognitoIdentityProvider action.

CognitoIdentityProviderRequest::CognitoIdentityProviderRequest(const CognitoIdentityProviderRequest &other)

Constructs a copy of other.

[protected] CognitoIdentityProviderRequest::CognitoIdentityProviderRequest(CognitoIdentityProviderRequestPrivate * const d)

Constructs aa CognitoIdentityProviderRequest object with private implementation d.

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

Action CognitoIdentityProviderRequest::action() const

Returns the CognitoIdentityProvider action to be performed by this request.

See also setAction().

QString CognitoIdentityProviderRequest::actionString() const

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

QString CognitoIdentityProviderRequest::apiVersion() const

Returns the CognitoIdentityProvider API version implemented by this request.

See also setApiVersion().

[protected] int CognitoIdentityProviderRequest::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 CognitoIdentityProviderRequest::clearParameters()

Removes all parameters from the request.

[protected] QVariant CognitoIdentityProviderRequest::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 &CognitoIdentityProviderRequest::parameters() const

Returns the parameters included in this request.

See also setParameters().

void CognitoIdentityProviderRequest::setAction(const Action action)

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

See also action().

void CognitoIdentityProviderRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

[protected] void CognitoIdentityProviderRequest::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 CognitoIdentityProviderRequest::unsignedRequest(const QUrl &endpoint) const

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

This CognitoIdentityProvider 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.

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

Sets the CognitoIdentityProviderRequest object to be equal to other.

[virtual] bool CognitoIdentityProviderRequest::operator==(const CognitoIdentityProviderRequest &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.