KinesisVideoMediaRequest Class

Member Function Documentation

KinesisVideoMediaRequest::KinesisVideoMediaRequest(const Action action)

Constructs a KinesisVideoMediaRequest object for KinesisVideoMedia action.

KinesisVideoMediaRequest::KinesisVideoMediaRequest(const KinesisVideoMediaRequest &other)

Constructs a copy of other.

[protected] KinesisVideoMediaRequest::KinesisVideoMediaRequest(KinesisVideoMediaRequestPrivate * const d)

Constructs aa KinesisVideoMediaRequest object with private implementation d.

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

Action KinesisVideoMediaRequest::action() const

Returns the KinesisVideoMedia action to be performed by this request.

See also setAction().

QString KinesisVideoMediaRequest::actionString() const

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

QString KinesisVideoMediaRequest::apiVersion() const

Returns the KinesisVideoMedia API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void KinesisVideoMediaRequest::setAction(const Action action)

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

See also action().

void KinesisVideoMediaRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the KinesisVideoMediaRequest object to be equal to other.

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