AppSyncRequest Class

Member Function Documentation

AppSyncRequest::AppSyncRequest(const Action action)

Constructs a AppSyncRequest object for AppSync action.

AppSyncRequest::AppSyncRequest(const AppSyncRequest &other)

Constructs a copy of other.

[protected] AppSyncRequest::AppSyncRequest(AppSyncRequestPrivate * const d)

Constructs aa AppSyncRequest object with private implementation d.

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

Action AppSyncRequest::action() const

Returns the AppSync action to be performed by this request.

See also setAction().

QString AppSyncRequest::actionString() const

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

QString AppSyncRequest::apiVersion() const

Returns the AppSync API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void AppSyncRequest::setAction(const Action action)

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

See also action().

void AppSyncRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the AppSyncRequest object to be equal to other.

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