URIS Class Reference

A class which cointains all variables and methods for creating URL objects for performing the queries to Freesound. More...

#include <FreesoundAPI.h>

Public Member Functions
	URIS ()
	Default constructor, creates an empty object. More...
	~URIS ()
	Destructor. More...

Static Public Member Functions
static URL	uri (String uri, StringArray replacements=StringArray())
	Creates an URL given a URI from the static URIS and a String array with the parameters. More...

Static Public Attributes
static String	HOST = String("www.freesound.org")
	Freesound website.
static String	BASE = String("https://" + HOST + "/apiv2")
	The base URL for the requests.
static String	TEXT_SEARCH = String("/search/text/")
	The text search resource.
static String	CONTENT_SEARCH = String("/search/content/")
	The content search resource.
static String	COMBINED_SEARCH = String("/search/combined/")
	The combined search resource, not implemented.
static String	SOUND = String("/sounds/<sound_id>/")
	The sound instance resource.
static String	SOUND_ANALYSIS = String("/sounds/<sound_id>/analysis/")
	The sound analysis resource.
static String	SIMILAR_SOUNDS = String("/sounds/<sound_id>/similar/")
	The similar sounds resource.
static String	COMMENTS = String("/sounds/<sound_id>/comments/")
	The sound comments resource.
static String	DOWNLOAD = String("/sounds/<sound_id>/download/")
	The download sound resource.
static String	UPLOAD = String("/sounds/upload/")
	The upload sound resource.
static String	DESCRIBE = String("/sounds/<sound_id>/describe/")
	The describe sound resource.
static String	PENDING = String("/sounds/pending_uploads/")
	The pending uploads resource.
static String	BOOKMARK = String("/sounds/<sound_id>/bookmark/")
	The bookmark sound resource.
static String	RATE = String("/sounds/<sound_id>/rate/")
	The rate sound resource.
static String	COMMENT = String("/sounds/<sound_id>/comment/")
	The comment sound resource.
static String	AUTHORIZE = String("/oauth2/authorize/")
	The authorization resource.
static String	LOGOUT = String("/api-auth/logout/")
	The logout resource.
static String	LOGOUT_AUTHORIZE = String("/oauth2/logout_and_authorize/")
	The logout and authorize resource.
static String	ACCESS_TOKEN = String("/oauth2/access_token/")
	The get access token resource.
static String	ME = String("/me/")
	The me resource.
static String	USER = String("/users/<username>/")
	The user instance resource.
static String	USER_SOUNDS = String("/users/<username>/sounds/")
	The get user sounds resource.
static String	USER_PACKS = String("/users/<username>/packs/")
	The get user packs resource.
static String	USER_BOOKMARK_CATEGORIES = String("/users/<username>/bookmark_categories/")
	The get user bookmark categories resources.
static String	USER_BOOKMARK_CATEGORY_SOUNDS = String("/users/<username>/bookmark_categories/<category_id>/sounds/")
	The user bookmark category sounds resources.
static String	PACK = String("/packs/<pack_id>/")
	The get pack instance resource.
static String	PACK_SOUNDS = String("/packs/<pack_id>/sounds/")
	The pack sounds.
static String	PACK_DOWNLOAD = String("/packs/<pack_id>/download/")
	The pack download resource.
static String	CONFIRMATION = String("https://" + HOST + "/home/app_permissions/permission_granted/")
	The confirmation URL.
static String	EDIT = String("/sounds/<sound_id>/edit/")
	The edit sound resource.

Detailed Description

A class which cointains all variables and methods for creating URL objects for performing the queries to Freesound.

Author

Antonio

Date

09/07/2019

Constructor & Destructor Documentation

URIS()

URIS::URIS ( )

inline

Default constructor, creates an empty object.

Author

Antonio

Date

09/07/2019

~URIS()

URIS::~URIS ( )

inline

Destructor.

Author

Antonio

Date

09/07/2019

Member Function Documentation

uri()

static URL URIS::uri ( String  uri, StringArray  replacements = StringArray()  )

static

Creates an URL given a URI from the static URIS and a String array with the parameters.

Author

Antonio

Date

09/07/2019

Parameters

uri	URI of the resource.
replacements	(Optional) The arguments for the URL.

Returns

The URL for the request.

---

The documentation for this class was generated from the following files:

• Source/FreesoundAPI.h
• Source/FreesoundAPI.cpp