MediaStoreDataRequest Class

(QtAws::MediaStoreData::MediaStoreDataRequest)

The MediaStoreDataRequest class provides an interface for MediaStoreData requests. More...

Public Types

enum Action { DeleteObjectAction, DescribeObjectAction, GetObjectAction, ListItemsAction, PutObjectAction }
flags Actions

Public Functions

MediaStoreDataRequest(const Action action)
MediaStoreDataRequest(const MediaStoreDataRequest &other)
Action action() const
QString actionString() const
QString apiVersion() const
void setAction(const Action action)
void setApiVersion(const QString &version)
MediaStoreDataRequest &operator=(const MediaStoreDataRequest &other)
virtual bool operator==(const MediaStoreDataRequest &other) const

Protected Functions

MediaStoreDataRequest(MediaStoreDataRequestPrivate * const d)
int clearParameter(const QString &name)
void clearParameters()
QVariant parameter(const QString &name, const QVariant &defaultValue = QVariant()) const
const QVariantMap &parameters() const
void setParameter(const QString &name, const QVariant &value)
void setParameters(const QVariantMap &parameters)

Reimplemented Protected Functions

virtual QNetworkRequest unsignedRequest(const QUrl &endpoint) const override

Detailed Description

The MediaStoreDataRequest class provides an interface for MediaStoreData requests.

Member Type Documentation

enum MediaStoreDataRequest::Action
flags MediaStoreDataRequest::Actions

This enum describes the actions that can be performed as MediaStoreData requests.

ConstantValueDescription
QtAws::MediaStoreData::MediaStoreDataRequest::DeleteObjectAction0MediaStoreData DeleteObject action.
QtAws::MediaStoreData::MediaStoreDataRequest::DescribeObjectAction1MediaStoreData DescribeObject action.
QtAws::MediaStoreData::MediaStoreDataRequest::GetObjectAction2MediaStoreData GetObject action.
QtAws::MediaStoreData::MediaStoreDataRequest::ListItemsAction3MediaStoreData ListItems action.
QtAws::MediaStoreData::MediaStoreDataRequest::PutObjectAction4MediaStoreData PutObject action.

The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.

Member Function Documentation

MediaStoreDataRequest::MediaStoreDataRequest(const Action action)

Constructs a MediaStoreDataRequest object for MediaStoreData action.

MediaStoreDataRequest::MediaStoreDataRequest(const MediaStoreDataRequest &other)

Constructs a copy of other.

[protected] MediaStoreDataRequest::MediaStoreDataRequest(MediaStoreDataRequestPrivate * const d)

Constructs aa MediaStoreDataRequest object with private implementation d.

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

Action MediaStoreDataRequest::action() const

Returns the MediaStoreData action to be performed by this request.

See also setAction().

QString MediaStoreDataRequest::actionString() const

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

QString MediaStoreDataRequest::apiVersion() const

Returns the MediaStoreData API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void MediaStoreDataRequest::setAction(const Action action)

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

See also action().

void MediaStoreDataRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the MediaStoreDataRequest object to be equal to other.

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

© 2018 Paul Colby Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.