CognitoSyncRequest Class

Member Function Documentation

CognitoSyncRequest::CognitoSyncRequest(const Action action)

Constructs a CognitoSyncRequest object for CognitoSync action.

CognitoSyncRequest::CognitoSyncRequest(const CognitoSyncRequest &other)

Constructs a copy of other.

[protected] CognitoSyncRequest::CognitoSyncRequest(CognitoSyncRequestPrivate * const d)

Constructs aa CognitoSyncRequest object with private implementation d.

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

Action CognitoSyncRequest::action() const

Returns the CognitoSync action to be performed by this request.

See also setAction().

QString CognitoSyncRequest::actionString() const

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

QString CognitoSyncRequest::apiVersion() const

Returns the CognitoSync API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void CognitoSyncRequest::setAction(const Action action)

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

See also action().

void CognitoSyncRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the CognitoSyncRequest object to be equal to other.

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