QSoundCloud::ResourcesRequest Class Reference

Handles requests for SoundCloud resources. More...

Inheritance diagram for QSoundCloud::ResourcesRequest:

Public Slots
void	get (const QString &resourcePath, const QVariantMap &filters=QVariantMap())
	Requests SoundCloud resource(s) from resourcePath.
void	insert (const QString &resourcePath)
	Inserts a SoundCloud resource into resourcePath using a PUT request.
void	insert (const QVariantMap &resource, const QString &resourcePath)
	Inserts a new SoundCloud resource.
void	update (const QString &resourcePath, const QVariantMap &resource)
	Updates the SoundCloud resource at resourcePath.
void	del (const QString &resourcePath)
	Deletes the SoundCloud resource at resourcePath.
Public Slots inherited from QSoundCloud::Request
void	cancel ()
	Cancels the current HTTP request.

Additional Inherited Members
Public Types inherited from QSoundCloud::Request
enum	Operation
	The operation type of the last HTTP request. More...
enum	Status
	The status of the last HTTP request. More...
enum	Error
	The error resulting from the last HTTP request. More...
Signals inherited from QSoundCloud::Request
void	clientIdChanged ()
	Emitted when the clientId changes.
void	clientSecretChanged ()
	Emitted when the clientSecret changes.
void	accessTokenChanged (const QString &token)
	Emitted when the accessToken changes.
void	refreshTokenChanged (const QString &token)
	Emitted when the refreshToken changes.
void	urlChanged ()
	Emitted when the url changes.
void	dataChanged ()
	Emitted when the data changes.
void	headersChanged ()
	Emitted when the headers change.
void	operationChanged ()
	Emitted when the operation changes.
void	statusChanged (Status s)
	Emitted when the status changes.
void	finished ()
	Emitted when the request is completed.
Public Member Functions inherited from QSoundCloud::Request
void	setNetworkAccessManager (QNetworkAccessManager *manager)
	Sets the QNetworkAccessManager instance to be used when making requests to the SoundCloud API.
Protected Slots inherited from QSoundCloud::Request
void	head (bool authRequired=true)
	Performs a HTTP HEAD request.
void	get (bool authRequired=true)
	Performs a HTTP GET request.
void	post (bool authRequired=true)
	Performs a HTTP POST request.
void	put (bool authRequired=true)
	Performs a HTTP PUT request.
void	deleteResource (bool authRequired=true)
	Performs a HTTP DELETE request.
Properties inherited from QSoundCloud::Request
QString	clientId
	The client id used when making requests to the SoundCloud Data API.
QString	clientSecret
	The api key used when making requests to the SoundCloud Data API.
QString	accessToken
	The access token used when making requests to the SoundCloud Data API.
QString	refreshToken
	The refresh token used when making requests to the SoundCloud Data API.
QUrl	url
	The url used when making requests to the SoundCloud Data API.
QVariantMap	headers
	The headers used when making requests to the SoundCloud Data API.
QVariant	data
	The data used when making HTTP PUT/POST requests to the SoundCloud Data API.
Operation	operation
	The last HTTP operation type.
Status	status
	The status of the last request.
QVariant	result
	The result of the last HTTP request.
Error	error
	The error resulting from the last HTTP request.
QString	errorString
	A description of the error resulting from the last HTTP request.

Detailed Description

Handles requests for SoundCloud resources.

The ResourcesRequest class is used for making requests to the SoundCloud Data API that concern SoundCloud resources.

Example usage:

C++

using namespace QSoundCloud;

...

ResourcesRequest request;
request.get("/tracks/TRACK_ID");
connect(&request, SIGNAL(finished()), this, SLOT(onRequestFinished()));

...

void MyClass::onRequestFinished() {
    if (request.status() == ResourcesRequest::Ready) {            
        QMapIterator<QString, QVariant> iterator(request.result().toMap());
        
        while (iterator.hasNext()) {
            iterator.next();
            qDebug() << iterator.key() << "=" << iterator.value();
        }
    }
    else {
        qDebug() << request.errorString();
    }
}

QML

import QtQuick 1.0
import QSoundCloud 1.0

ResourcesRequest {
    id: request

    onFinished: {
        if (status == ResourcesRequest.Ready) {
            for (var att in result) {
                console.log(att + " = " + result[att]);
            }
        }
        else {
            console.log(errorString);
        }
    }
    
    Component.onCompleted: get("/tracks/TRACK_ID")
}

For more details about SoundCloud resources, see the SoundCloud reference documentation here.

Member Function Documentation

void QSoundCloud::ResourcesRequest::del ( const QString &  resourcePath )

slot

Deletes the SoundCloud resource at resourcePath.

For example, to 'unfavorite' a track on behalf of the authenticated user:

ResourcesRequest request;
request.del("/me/favorites/TRACK_ID");

void QSoundCloud::ResourcesRequest::get ( const QString &  resourcePath, const QVariantMap &  filters = QVariantMap()  )

slot

Requests SoundCloud resource(s) from resourcePath.

For example, to search tracks:

ResourcesRequest request;
QVariantMap filters;
filters["limit"] = 10;
filters["q"] = "Qt";
request.get("/tracks", filters);

void QSoundCloud::ResourcesRequest::insert ( const QString &  resourcePath )

slot

Inserts a SoundCloud resource into resourcePath using a PUT request.

For example, to 'favorite' a track on behalf of the authenticated user:

ResourcesRequest request;
request.insert("/me/favorites/TRACK_ID");

void QSoundCloud::ResourcesRequest::insert ( const QVariantMap &  resource, const QString &  resourcePath  )

slot

Inserts a new SoundCloud resource.

For example, to insert a new connection on behalf of the authenticated user:

ResourcesRequest request;
QVariantMap connection;
connection["service"] = "twitter";
connection["redirect_uri"] = "http://mywebsite.com/soundcloud_connections";
request.insert(album, "/me/connections");