MediaLiveRequest Class

Member Function Documentation

MediaLiveRequest::MediaLiveRequest(const Action action)

Constructs a MediaLiveRequest object for MediaLive action.

MediaLiveRequest::MediaLiveRequest(const MediaLiveRequest &other)

Constructs a copy of other.

[protected] MediaLiveRequest::MediaLiveRequest(MediaLiveRequestPrivate * const d)

Constructs aa MediaLiveRequest object with private implementation d.

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

Action MediaLiveRequest::action() const

Returns the MediaLive action to be performed by this request.

See also setAction().

QString MediaLiveRequest::actionString() const

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

QString MediaLiveRequest::apiVersion() const

Returns the MediaLive API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void MediaLiveRequest::setAction(const Action action)

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

See also action().

void MediaLiveRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the MediaLiveRequest object to be equal to other.

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