MobileRequest Class
(QtAws::Mobile::MobileRequest)The MobileRequest class provides an interface for Mobile requests. More...
Public Types
| enum | Action { CreateProjectAction, DeleteProjectAction, DescribeBundleAction, DescribeProjectAction, ..., UpdateProjectAction } |
| flags | Actions |
Public Functions
| MobileRequest(const Action action) | |
| MobileRequest(const MobileRequest &other) | |
| Action | action() const |
| QString | actionString() const |
| QString | apiVersion() const |
| void | setAction(const Action action) |
| void | setApiVersion(const QString &version) |
| MobileRequest & | operator=(const MobileRequest &other) |
| virtual bool | operator==(const MobileRequest &other) const |
- 7 public functions inherited from QtAws::Core::AwsAbstractRequest
Protected Functions
| MobileRequest(MobileRequestPrivate * 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 ¶meters) |
Reimplemented Protected Functions
| virtual QNetworkRequest | unsignedRequest(const QUrl &endpoint) const override |
- 4 protected functions inherited from QtAws::Core::AwsAbstractRequest
Detailed Description
The MobileRequest class provides an interface for Mobile requests.
Member Type Documentation
enum MobileRequest::Action
flags MobileRequest::Actions
This enum describes the actions that can be performed as Mobile requests.
| Constant | Value | Description |
|---|---|---|
QtAws::Mobile::MobileRequest::CreateProjectAction | 0 | Mobile CreateProject action. |
QtAws::Mobile::MobileRequest::DeleteProjectAction | 1 | Mobile DeleteProject action. |
QtAws::Mobile::MobileRequest::DescribeBundleAction | 2 | Mobile DescribeBundle action. |
QtAws::Mobile::MobileRequest::DescribeProjectAction | 3 | Mobile DescribeProject action. |
QtAws::Mobile::MobileRequest::ExportBundleAction | 4 | Mobile ExportBundle action. |
QtAws::Mobile::MobileRequest::ExportProjectAction | 5 | Mobile ExportProject action. |
QtAws::Mobile::MobileRequest::ListBundlesAction | 6 | Mobile ListBundles action. |
QtAws::Mobile::MobileRequest::ListProjectsAction | 7 | Mobile ListProjects action. |
QtAws::Mobile::MobileRequest::UpdateProjectAction | 8 | Mobile UpdateProject action. |
The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.
Member Function Documentation
MobileRequest::MobileRequest(const Action action)
Constructs a MobileRequest object for Mobile action.
MobileRequest::MobileRequest(const MobileRequest &other)
Constructs a copy of other.
[protected] MobileRequest::MobileRequest(MobileRequestPrivate * const d)
Constructs aa MobileRequest object with private implementation d.
This overload allows derived classes to provide their own private class implementation that inherits from MobileRequestPrivate.
Action MobileRequest::action() const
Returns the Mobile action to be performed by this request.
See also setAction().
QString MobileRequest::actionString() const
Returns the name of the Mobile action to be performed by this request.
QString MobileRequest::apiVersion() const
Returns the Mobile API version implemented by this request.
See also setApiVersion().
[protected] int MobileRequest::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 MobileRequest::clearParameters()
Removes all parameters from the request.
[protected] QVariant MobileRequest::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 &MobileRequest::parameters() const
Returns the parameters included in this request.
See also setParameters().
void MobileRequest::setAction(const Action action)
Sets the Mobile action to be performed by this request to action.
See also action().
void MobileRequest::setApiVersion(const QString &version)
Sets the Mobile API version to include in this request to version.
See also apiVersion().
[protected] void MobileRequest::setParameter(const QString &name, const QVariant &value)
Sets the name parameter to value.
See also parameter().
[protected] void MobileRequest::setParameters(const QVariantMap ¶meters)
Sets the paramters for this request to parameters. Any request parameters set previously will be discarded.
See also parameters().
[override virtual protected] QNetworkRequest MobileRequest::unsignedRequest(const QUrl &endpoint) const
Reimplemented from AwsAbstractRequest::unsignedRequest().
Returns a network request for the Mobile request using the given endpoint.
This Mobile 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.
MobileRequest &MobileRequest::operator=(const MobileRequest &other)
Sets the MobileRequest object to be equal to other.
[virtual] bool MobileRequest::operator==(const MobileRequest &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.