GameLiftRequest Class

Member Function Documentation

GameLiftRequest::GameLiftRequest(const Action action)

Constructs a GameLiftRequest object for GameLift action.

GameLiftRequest::GameLiftRequest(const GameLiftRequest &other)

Constructs a copy of other.

[protected] GameLiftRequest::GameLiftRequest(GameLiftRequestPrivate * const d)

Constructs aa GameLiftRequest object with private implementation d.

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

Action GameLiftRequest::action() const

Returns the GameLift action to be performed by this request.

See also setAction().

QString GameLiftRequest::actionString() const

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

QString GameLiftRequest::apiVersion() const

Returns the GameLift API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void GameLiftRequest::setAction(const Action action)

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

See also action().

void GameLiftRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the GameLiftRequest object to be equal to other.

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