From 84cbc6ba772971138d88748aaf1f73e53f48f989 Mon Sep 17 00:00:00 2001 From: Jan Berkel Date: Thu, 19 May 2011 14:21:14 +0200 Subject: [PATCH 1/4] Reset gh-pages --- .gitignore | 1 + 1 file changed, 1 insertion(+) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ea30561 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +#empty From 34583daf8251b04898176d6ff289fae191f0b3b8 Mon Sep 17 00:00:00 2001 From: Jan Berkel Date: Thu, 19 May 2011 14:27:02 +0200 Subject: [PATCH 2/4] javadocs for 1.0.0 --- javadoc/1.0.0/allclasses-frame.html | 57 + javadoc/1.0.0/allclasses-noframe.html | 57 + .../1.0.0/com/soundcloud/api/ApiWrapper.html | 1171 +++++++++++++++++ .../api/CloudAPI.InvalidTokenException.html | 248 ++++ .../api/CloudAPI.TokenListener.html | 233 ++++ .../1.0.0/com/soundcloud/api/CloudAPI.html | 782 +++++++++++ .../1.0.0/com/soundcloud/api/Endpoints.html | 692 ++++++++++ javadoc/1.0.0/com/soundcloud/api/Env.html | 455 +++++++ javadoc/1.0.0/com/soundcloud/api/Http.html | 324 +++++ .../com/soundcloud/api/Params.Comment.html | 243 ++++ .../com/soundcloud/api/Params.Track.html | 711 ++++++++++ .../1.0.0/com/soundcloud/api/Params.User.html | 441 +++++++ javadoc/1.0.0/com/soundcloud/api/Params.html | 201 +++ .../api/Request.TransferProgressListener.html | 209 +++ javadoc/1.0.0/com/soundcloud/api/Request.html | 605 +++++++++ javadoc/1.0.0/com/soundcloud/api/Token.html | 628 +++++++++ .../com/soundcloud/api/package-frame.html | 85 ++ .../com/soundcloud/api/package-summary.html | 257 ++++ .../com/soundcloud/api/package-tree.html | 171 +++ javadoc/1.0.0/constant-values.html | 776 +++++++++++ javadoc/1.0.0/deprecated-list.html | 142 ++ javadoc/1.0.0/help-doc.html | 209 +++ javadoc/1.0.0/index-all.html | 796 +++++++++++ javadoc/1.0.0/index.html | 36 + javadoc/1.0.0/overview-tree.html | 173 +++ javadoc/1.0.0/package-list | 1 + javadoc/1.0.0/resources/inherit.gif | Bin 0 -> 57 bytes javadoc/1.0.0/serialized-form.html | 287 ++++ javadoc/1.0.0/stylesheet.css | 29 + 29 files changed, 10019 insertions(+) create mode 100644 javadoc/1.0.0/allclasses-frame.html create mode 100644 javadoc/1.0.0/allclasses-noframe.html create mode 100644 javadoc/1.0.0/com/soundcloud/api/ApiWrapper.html create mode 100644 javadoc/1.0.0/com/soundcloud/api/CloudAPI.InvalidTokenException.html create mode 100644 javadoc/1.0.0/com/soundcloud/api/CloudAPI.TokenListener.html create mode 100644 javadoc/1.0.0/com/soundcloud/api/CloudAPI.html create mode 100644 javadoc/1.0.0/com/soundcloud/api/Endpoints.html create mode 100644 javadoc/1.0.0/com/soundcloud/api/Env.html create mode 100644 javadoc/1.0.0/com/soundcloud/api/Http.html create mode 100644 javadoc/1.0.0/com/soundcloud/api/Params.Comment.html create mode 100644 javadoc/1.0.0/com/soundcloud/api/Params.Track.html create mode 100644 javadoc/1.0.0/com/soundcloud/api/Params.User.html create mode 100644 javadoc/1.0.0/com/soundcloud/api/Params.html create mode 100644 javadoc/1.0.0/com/soundcloud/api/Request.TransferProgressListener.html create mode 100644 javadoc/1.0.0/com/soundcloud/api/Request.html create mode 100644 javadoc/1.0.0/com/soundcloud/api/Token.html create mode 100644 javadoc/1.0.0/com/soundcloud/api/package-frame.html create mode 100644 javadoc/1.0.0/com/soundcloud/api/package-summary.html create mode 100644 javadoc/1.0.0/com/soundcloud/api/package-tree.html create mode 100644 javadoc/1.0.0/constant-values.html create mode 100644 javadoc/1.0.0/deprecated-list.html create mode 100644 javadoc/1.0.0/help-doc.html create mode 100644 javadoc/1.0.0/index-all.html create mode 100644 javadoc/1.0.0/index.html create mode 100644 javadoc/1.0.0/overview-tree.html create mode 100644 javadoc/1.0.0/package-list create mode 100644 javadoc/1.0.0/resources/inherit.gif create mode 100644 javadoc/1.0.0/serialized-form.html create mode 100644 javadoc/1.0.0/stylesheet.css diff --git a/javadoc/1.0.0/allclasses-frame.html b/javadoc/1.0.0/allclasses-frame.html new file mode 100644 index 0000000..622afaa --- /dev/null +++ b/javadoc/1.0.0/allclasses-frame.html @@ -0,0 +1,57 @@ + + + + + + +All Classes (SoundCloud Java API Wrapper 1.0.0) + + + + + + + + + + + +All Classes +
+ + + + + +
ApiWrapper +
+CloudAPI +
+CloudAPI.InvalidTokenException +
+CloudAPI.TokenListener +
+Endpoints +
+Env +
+Http +
+Params +
+Params.Comment +
+Params.Track +
+Params.User +
+Request +
+Request.TransferProgressListener +
+Token +
+
+ + + diff --git a/javadoc/1.0.0/allclasses-noframe.html b/javadoc/1.0.0/allclasses-noframe.html new file mode 100644 index 0000000..90558d3 --- /dev/null +++ b/javadoc/1.0.0/allclasses-noframe.html @@ -0,0 +1,57 @@ + + + + + + +All Classes (SoundCloud Java API Wrapper 1.0.0) + + + + + + + + + + + +All Classes +
+ + + + + +
ApiWrapper +
+CloudAPI +
+CloudAPI.InvalidTokenException +
+CloudAPI.TokenListener +
+Endpoints +
+Env +
+Http +
+Params +
+Params.Comment +
+Params.Track +
+Params.User +
+Request +
+Request.TransferProgressListener +
+Token +
+
+ + + diff --git a/javadoc/1.0.0/com/soundcloud/api/ApiWrapper.html b/javadoc/1.0.0/com/soundcloud/api/ApiWrapper.html new file mode 100644 index 0000000..085b907 --- /dev/null +++ b/javadoc/1.0.0/com/soundcloud/api/ApiWrapper.html @@ -0,0 +1,1171 @@ + + + + + + +ApiWrapper (SoundCloud Java API Wrapper 1.0.0) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.soundcloud.api +
+Class ApiWrapper

+
+java.lang.Object
+  extended by com.soundcloud.api.ApiWrapper
+
+
+
All Implemented Interfaces:
CloudAPI, java.io.Serializable
+
+
+
+
public class ApiWrapper
extends java.lang.Object
implements CloudAPI, java.io.Serializable
+ + +

+Interface with SoundCloud, using OAuth2. + This API wrapper makes a few assumptions - namely: +

+ Example usage: + + 
+ ApiWrapper wrapper = new ApiWrapper("client_id", "client_secret", null, null, Env.SANDBOX);
+ wrapper.login("login", "password");
+ HttpResponse response = wrapper.get(Request.to("/tracks"));
+
+ +

+ +

+

+
See Also:
CloudAPI, +Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.soundcloud.api.CloudAPI
CloudAPI.InvalidTokenException, CloudAPI.TokenListener
+  + + + + + + + + + + + +
+Field Summary
+ Envenv + +
+          The current environment
+  + + + + + + + +
Fields inherited from interface com.soundcloud.api.CloudAPI
AUTHORIZATION_CODE, CLIENT_CREDENTIALS, OAUTH_SCHEME, OAUTH1_TOKEN, PASSWORD, REALM, REFRESH_TOKEN, USER_AGENT, VERSION
+  + + + + + + + + + + +
+Constructor Summary
ApiWrapper(java.lang.String clientId, + java.lang.String clientSecret, + java.net.URI redirectUri, + Token token, + Env env) + +
+          Constructs a new ApiWrapper instance.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+protected  HttpRequestaddAcceptHeader(HttpRequest request) + +
+          Forces JSON
+protected  HttpRequestaddAuthHeader(HttpRequest request) + +
+          Adds an OAuth2 header to a given request
+protected  HttpRequestaddHeaders(HttpRequest req) + +
+          Adds all required headers to the request
+ TokenauthorizationCode(java.lang.String code) + +
+          Request a token using + Authorization Code.
+ java.net.URIauthorizationCodeUrl(java.lang.String... options) + +
+          Request login via authorization code + After login, control will go to the redirect URI (wrapper specific), with + one of the following query parameters appended: + + code in case of success, this will contain the code used for the + authorizationCode call to obtain the access token.
+ TokenclientCredentials() + +
+          Request a "signup" token using + Client Credentials.
+static HeadercreateOAuthHeader(Token token) + +
+          Creates an OAuth2 header for the given token
+ HttpResponsedelete(Request request) + +
+           
+ TokenexchangeOAuth1Token(java.lang.String oauth1AccessToken) + +
+          Exchange an OAuth1 Token for new OAuth2 tokens.
+ HttpResponseexecute(HttpRequest req) + +
+          Execute an API request, adds the necessary headers.
+static ApiWrapperfromFile(java.io.File f) + +
+          Read wrapper from a file
+ HttpResponseget(Request request) + +
+           
+ org.apache.http.client.HttpClientgetHttpClient() + +
+           
+protected  HttpParamsgetParams() + +
+           
+protected  org.apache.http.client.RequestDirectorgetRequestDirector(HttpRequestExecutor requestExec, + org.apache.http.conn.ClientConnectionManager conman, + ConnectionReuseStrategy reustrat, + org.apache.http.conn.ConnectionKeepAliveStrategy kastrat, + org.apache.http.conn.routing.HttpRoutePlanner rouplan, + HttpProcessor httpProcessor, + org.apache.http.client.HttpRequestRetryHandler retryHandler, + org.apache.http.client.RedirectHandler redirectHandler, + org.apache.http.client.AuthenticationHandler targetAuthHandler, + org.apache.http.client.AuthenticationHandler proxyAuthHandler, + org.apache.http.client.UserTokenHandler stateHandler, + HttpParams params) + +
+          This method mainly exists to make the wrapper more testable.
+protected  org.apache.http.conn.scheme.SocketFactorygetSocketFactory() + +
+           
+protected  org.apache.http.conn.ssl.SSLSocketFactorygetSSLSocketFactory() + +
+           
+ TokengetToken() + +
+           
+ java.net.URIgetURI(Request request, + boolean api, + boolean secure) + +
+          Constructs URI path for a given resource.
+protected  java.lang.StringgetUserAgent() + +
+          User-Agent to identify ourselves with - defaults to USER_AGENT
+ TokeninvalidateToken() + +
+          This method should be called when the token was found to be invalid.
+ Tokenlogin(java.lang.String username, + java.lang.String password) + +
+          Request a token using + Resource Owner Password Credentials.
+ HttpResponsepost(Request request) + +
+           
+ HttpResponseput(Request request) + +
+           
+ TokenrefreshToken() + +
+          Tries to refresh the currently used access token with the refresh token.
+protected  TokenrequestToken(Request request) + +
+          Request an OAuth2 token from SoundCloud
+ longresolve(java.lang.String url) + +
+          Resolve the given SoundCloud URI
+ voidsetToken(Token newToken) + +
+           
+ voidsetTokenListener(CloudAPI.TokenListener listener) + +
+          Registers a listener.
+ voidtoFile(java.io.File f) + +
+          serialize the wrapper to a File
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+env

+
+public final Env env
+
+
The current environment +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+ApiWrapper

+
+public ApiWrapper(java.lang.String clientId,
+                  java.lang.String clientSecret,
+                  java.net.URI redirectUri,
+                  Token token,
+                  Env env)
+
+
Constructs a new ApiWrapper instance. +

+

+
Parameters:
clientId - the application client id
clientSecret - the application client secret
redirectUri - the registered redirect url, or null
token - an valid token, or null if not known
env - the environment to use (LIVE/SANDBOX)
See Also:
API documentation
+
+ + + + + + + + +
+Method Detail
+ +

+login

+
+public Token login(java.lang.String username,
+                   java.lang.String password)
+            throws java.io.IOException
+
+
Description copied from interface: CloudAPI
+
Request a token using + Resource Owner Password Credentials. +

+

+
Specified by:
login in interface CloudAPI
+
+
+
Parameters:
username - SoundCloud username
password - SoundCloud password +
Returns:
a valid token +
Throws: +
CloudAPI.InvalidTokenException - invalid token +
java.io.IOException - In case of network/server errors
+
+
+
+ +

+authorizationCode

+
+public Token authorizationCode(java.lang.String code)
+                        throws java.io.IOException
+
+
Description copied from interface: CloudAPI
+
Request a token using + Authorization Code. +

+

+
Specified by:
authorizationCode in interface CloudAPI
+
+
+
Parameters:
code - the authorization code +
Returns:
a valid token +
Throws: +
CloudAPI.InvalidTokenException - invalid token +
java.io.IOException - In case of network/server errors
+
+
+
+ +

+clientCredentials

+
+public Token clientCredentials()
+                        throws java.io.IOException
+
+
Description copied from interface: CloudAPI
+
Request a "signup" token using + Client Credentials. + + Note that this token is not set as the current token in the wrapper - it should only be used + for one request (typically the signup / user creation request). + Also note that not all apps are allowed to request this token type (the wrapper throws + InvalidTokenException in this case). +

+

+
Specified by:
clientCredentials in interface CloudAPI
+
+
+ +
Returns:
a valid token +
Throws: +
java.io.IOException - IO/Error +
CloudAPI.InvalidTokenException - if requested scope is not available
+
+
+
+ +

+refreshToken

+
+public Token refreshToken()
+                   throws java.io.IOException
+
+
Description copied from interface: CloudAPI
+
Tries to refresh the currently used access token with the refresh token. + If successful the API wrapper will have the new token set already. +

+

+
Specified by:
refreshToken in interface CloudAPI
+
+
+ +
Returns:
a valid token +
Throws: +
java.io.IOException - in case of network problems +
CloudAPI.InvalidTokenException - invalid token
+
+
+
+ +

+exchangeOAuth1Token

+
+public Token exchangeOAuth1Token(java.lang.String oauth1AccessToken)
+                          throws java.io.IOException
+
+
Description copied from interface: CloudAPI
+
Exchange an OAuth1 Token for new OAuth2 tokens. The old OAuth1 token will be expired if + the exchange is successful. +

+

+
Specified by:
exchangeOAuth1Token in interface CloudAPI
+
+
+
Parameters:
oauth1AccessToken - a valid OAuth1 access token, registered with the same client +
Returns:
a valid token +
Throws: +
java.io.IOException - IO/Error +
CloudAPI.InvalidTokenException - Token error
+
+
+
+ +

+invalidateToken

+
+public Token invalidateToken()
+
+
Description copied from interface: CloudAPI
+
This method should be called when the token was found to be invalid. + Also replaces the current token, if there is one available. +

+

+
Specified by:
invalidateToken in interface CloudAPI
+
+
+ +
Returns:
an alternative token, or null if none available + (which indicates that a refresh could be tried)
+
+
+
+ +

+authorizationCodeUrl

+
+public java.net.URI authorizationCodeUrl(java.lang.String... options)
+
+
Description copied from interface: CloudAPI
+
Request login via authorization code + After login, control will go to the redirect URI (wrapper specific), with + one of the following query parameters appended: +
    +
  • code in case of success, this will contain the code used for the + authorizationCode call to obtain the access token. +
  • error in case of failure, this contains an error code (most likely + access_denied). +
+

+

+
Specified by:
authorizationCodeUrl in interface CloudAPI
+
+
+
Parameters:
options - auth endpoint to use (leave out for default) +
Returns:
the URI to open in a browser/WebView etc.
See Also:
CloudAPI.authorizationCode(String)
+
+
+
+ +

+getURI

+
+public java.net.URI getURI(Request request,
+                           boolean api,
+                           boolean secure)
+
+
Constructs URI path for a given resource. +

+

+
+
+
+
Parameters:
request - the resource to access
api - api or web
secure - whether to use SSL or not +
Returns:
a valid URI
+
+
+
+ +

+requestToken

+
+protected Token requestToken(Request request)
+                      throws java.io.IOException
+
+
Request an OAuth2 token from SoundCloud +

+

+
+
+
+
Parameters:
request - the token request +
Returns:
the token +
Throws: +
java.io.IOException - network error +
CloudAPI.InvalidTokenException - unauthorized
+
+
+
+ +

+getParams

+
+protected HttpParams getParams()
+
+
+
+
+
+ +
Returns:
parameters used by the underlying HttpClient
+
+
+
+ +

+getSocketFactory

+
+protected org.apache.http.conn.scheme.SocketFactory getSocketFactory()
+
+
+
+
+
+ +
Returns:
SocketFactory used by the underlying HttpClient
+
+
+
+ +

+getSSLSocketFactory

+
+protected org.apache.http.conn.ssl.SSLSocketFactory getSSLSocketFactory()
+
+
+
+
+
+ +
Returns:
SSL SocketFactory used by the underlying HttpClient
+
+
+
+ +

+getUserAgent

+
+protected java.lang.String getUserAgent()
+
+
User-Agent to identify ourselves with - defaults to USER_AGENT +

+

+
+
+
+ +
Returns:
the agent to use
See Also:
CloudAPI.USER_AGENT
+
+
+
+ +

+getHttpClient

+
+public org.apache.http.client.HttpClient getHttpClient()
+
+
+
+
+
+ +
Returns:
The HttpClient instance used to make the calls
+
+
+
+ +

+resolve

+
+public long resolve(java.lang.String url)
+             throws java.io.IOException
+
+
Description copied from interface: CloudAPI
+
Resolve the given SoundCloud URI +

+

+
Specified by:
resolve in interface CloudAPI
+
+
+
Parameters:
url - SoundCloud model URI, e.g. http://soundcloud.com/bob +
Returns:
the id or -1 if uri not found +
Throws: +
java.io.IOException - network errors
+
+
+
+ +

+get

+
+public HttpResponse get(Request request)
+                 throws java.io.IOException
+
+
+
Specified by:
get in interface CloudAPI
+
+
+
Parameters:
request - resource to GET +
Returns:
the HTTP response +
Throws: +
java.io.IOException - IO/Error
+
+
+
+ +

+put

+
+public HttpResponse put(Request request)
+                 throws java.io.IOException
+
+
+
Specified by:
put in interface CloudAPI
+
+
+
Parameters:
request - resource to PUT +
Returns:
the HTTP response +
Throws: +
java.io.IOException - IO/Error
+
+
+
+ +

+post

+
+public HttpResponse post(Request request)
+                  throws java.io.IOException
+
+
+
Specified by:
post in interface CloudAPI
+
+
+
Parameters:
request - resource to POST +
Returns:
the HTTP response +
Throws: +
java.io.IOException - IO/Error
+
+
+
+ +

+delete

+
+public HttpResponse delete(Request request)
+                    throws java.io.IOException
+
+
+
Specified by:
delete in interface CloudAPI
+
+
+
Parameters:
request - resource to DELETE +
Returns:
the HTTP response +
Throws: +
java.io.IOException - IO/Error
+
+
+
+ +

+getToken

+
+public Token getToken()
+
+
+
Specified by:
getToken in interface CloudAPI
+
+
+ +
Returns:
the current token
+
+
+
+ +

+setToken

+
+public void setToken(Token newToken)
+
+
+
Specified by:
setToken in interface CloudAPI
+
+
+
Parameters:
newToken - the token to be used
+
+
+
+ +

+setTokenListener

+
+public void setTokenListener(CloudAPI.TokenListener listener)
+
+
Description copied from interface: CloudAPI
+
Registers a listener. The listener will be informed when an access token was found + to be invalid, and when the token had to be refreshed. +

+

+
Specified by:
setTokenListener in interface CloudAPI
+
+
+
Parameters:
listener - token listener
+
+
+
+ +

+execute

+
+public HttpResponse execute(HttpRequest req)
+                     throws java.io.IOException
+
+
Execute an API request, adds the necessary headers. +

+

+
+
+
+
Parameters:
req - the HTTP request +
Returns:
the HTTP response +
Throws: +
java.io.IOException - network error etc.
+
+
+
+ +

+toFile

+
+public void toFile(java.io.File f)
+            throws java.io.IOException
+
+
serialize the wrapper to a File +

+

+
+
+
+
Parameters:
f - target +
Throws: +
java.io.IOException - IO problems
+
+
+
+ +

+fromFile

+
+public static ApiWrapper fromFile(java.io.File f)
+                           throws java.io.IOException,
+                                  java.lang.ClassNotFoundException
+
+
Read wrapper from a file +

+

+
+
+
+
Parameters:
f - the file +
Returns:
the wrapper +
Throws: +
java.io.IOException - IO problems +
java.lang.ClassNotFoundException - class not found
+
+
+
+ +

+createOAuthHeader

+
+public static Header createOAuthHeader(Token token)
+
+
Creates an OAuth2 header for the given token +

+

+
+
+
+
+
+
+
+ +

+addAuthHeader

+
+protected HttpRequest addAuthHeader(HttpRequest request)
+
+
Adds an OAuth2 header to a given request +

+

+
+
+
+
+
+
+
+ +

+addAcceptHeader

+
+protected HttpRequest addAcceptHeader(HttpRequest request)
+
+
Forces JSON +

+

+
+
+
+
+
+
+
+ +

+addHeaders

+
+protected HttpRequest addHeaders(HttpRequest req)
+
+
Adds all required headers to the request +

+

+
+
+
+
+
+
+
+ +

+getRequestDirector

+
+protected org.apache.http.client.RequestDirector getRequestDirector(HttpRequestExecutor requestExec,
+                                                                    org.apache.http.conn.ClientConnectionManager conman,
+                                                                    ConnectionReuseStrategy reustrat,
+                                                                    org.apache.http.conn.ConnectionKeepAliveStrategy kastrat,
+                                                                    org.apache.http.conn.routing.HttpRoutePlanner rouplan,
+                                                                    HttpProcessor httpProcessor,
+                                                                    org.apache.http.client.HttpRequestRetryHandler retryHandler,
+                                                                    org.apache.http.client.RedirectHandler redirectHandler,
+                                                                    org.apache.http.client.AuthenticationHandler targetAuthHandler,
+                                                                    org.apache.http.client.AuthenticationHandler proxyAuthHandler,
+                                                                    org.apache.http.client.UserTokenHandler stateHandler,
+                                                                    HttpParams params)
+
+
This method mainly exists to make the wrapper more testable. oh, apache's insanity. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/javadoc/1.0.0/com/soundcloud/api/CloudAPI.InvalidTokenException.html b/javadoc/1.0.0/com/soundcloud/api/CloudAPI.InvalidTokenException.html new file mode 100644 index 0000000..1f52a7f --- /dev/null +++ b/javadoc/1.0.0/com/soundcloud/api/CloudAPI.InvalidTokenException.html @@ -0,0 +1,248 @@ + + + + + + +CloudAPI.InvalidTokenException (SoundCloud Java API Wrapper 1.0.0) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.soundcloud.api +
+Class CloudAPI.InvalidTokenException

+
+java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by com.soundcloud.api.CloudAPI.InvalidTokenException
+
+
+
All Implemented Interfaces:
java.io.Serializable
+
+
+
Enclosing interface:
CloudAPI
+
+
+
+
public static class CloudAPI.InvalidTokenException
extends java.io.IOException
+ + +

+Thrown when token is not valid. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
CloudAPI.InvalidTokenException(int code, + java.lang.String status) + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+CloudAPI.InvalidTokenException

+
+public CloudAPI.InvalidTokenException(int code,
+                                      java.lang.String status)
+
+
+
Parameters:
code - the HTTP error code
status - the HTTP status, or other error message
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/javadoc/1.0.0/com/soundcloud/api/CloudAPI.TokenListener.html b/javadoc/1.0.0/com/soundcloud/api/CloudAPI.TokenListener.html new file mode 100644 index 0000000..45f9436 --- /dev/null +++ b/javadoc/1.0.0/com/soundcloud/api/CloudAPI.TokenListener.html @@ -0,0 +1,233 @@ + + + + + + +CloudAPI.TokenListener (SoundCloud Java API Wrapper 1.0.0) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.soundcloud.api +
+Interface CloudAPI.TokenListener

+
+
Enclosing interface:
CloudAPI
+
+
+
+
public static interface CloudAPI.TokenListener
+ + +

+Interested in changes to the current token. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + +
+Method Summary
+ TokenonTokenInvalid(Token token) + +
+          Called when token was found to be invalid
+ voidonTokenRefreshed(Token token) + +
+          Called when the token got successfully refreshed
+  +

+ + + + + + + + +
+Method Detail
+ +

+onTokenInvalid

+
+Token onTokenInvalid(Token token)
+
+
Called when token was found to be invalid +

+

+
Parameters:
token - the invalid token +
Returns:
a cached token if available, or null
+
+
+
+ +

+onTokenRefreshed

+
+void onTokenRefreshed(Token token)
+
+
Called when the token got successfully refreshed +

+

+
Parameters:
token - the refreshed token
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/javadoc/1.0.0/com/soundcloud/api/CloudAPI.html b/javadoc/1.0.0/com/soundcloud/api/CloudAPI.html new file mode 100644 index 0000000..c15d8cc --- /dev/null +++ b/javadoc/1.0.0/com/soundcloud/api/CloudAPI.html @@ -0,0 +1,782 @@ + + + + + + +CloudAPI (SoundCloud Java API Wrapper 1.0.0) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.soundcloud.api +
+Interface CloudAPI

+
+
All Known Implementing Classes:
ApiWrapper
+
+
+
+
public interface CloudAPI
+ + +

+Interface with SoundCloud, using OAuth2. + + This is the interface, for the implementation see ApiWrapper. +

+ +

+

+
See Also:
ApiWrapper
+
+ +

+ + + + + + + + + + + + + + + +
+Nested Class Summary
+static classCloudAPI.InvalidTokenException + +
+          Thrown when token is not valid.
+static interfaceCloudAPI.TokenListener + +
+          Interested in changes to the current token.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static java.lang.StringAUTHORIZATION_CODE + +
+           
+static java.lang.StringCLIENT_CREDENTIALS + +
+           
+static java.lang.StringOAUTH_SCHEME + +
+           
+static java.lang.StringOAUTH1_TOKEN + +
+           
+static java.lang.StringPASSWORD + +
+           
+static java.lang.StringREALM + +
+           
+static java.lang.StringREFRESH_TOKEN + +
+           
+static java.lang.StringUSER_AGENT + +
+           
+static java.lang.StringVERSION + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ TokenauthorizationCode(java.lang.String code) + +
+          Request a token using + Authorization Code.
+ java.net.URIauthorizationCodeUrl(java.lang.String... options) + +
+          Request login via authorization code + After login, control will go to the redirect URI (wrapper specific), with + one of the following query parameters appended: + + code in case of success, this will contain the code used for the + authorizationCode call to obtain the access token.
+ TokenclientCredentials() + +
+          Request a "signup" token using + Client Credentials.
+ HttpResponsedelete(Request request) + +
+           
+ TokenexchangeOAuth1Token(java.lang.String oauth1AccessToken) + +
+          Exchange an OAuth1 Token for new OAuth2 tokens.
+ HttpResponseget(Request request) + +
+           
+ TokengetToken() + +
+           
+ TokeninvalidateToken() + +
+          This method should be called when the token was found to be invalid.
+ Tokenlogin(java.lang.String username, + java.lang.String password) + +
+          Request a token using + Resource Owner Password Credentials.
+ HttpResponsepost(Request request) + +
+           
+ HttpResponseput(Request request) + +
+           
+ TokenrefreshToken() + +
+          Tries to refresh the currently used access token with the refresh token.
+ longresolve(java.lang.String uri) + +
+          Resolve the given SoundCloud URI
+ voidsetToken(Token token) + +
+           
+ voidsetTokenListener(CloudAPI.TokenListener listener) + +
+          Registers a listener.
+  +

+ + + + + + + + +
+Field Detail
+ +

+PASSWORD

+
+static final java.lang.String PASSWORD
+
+
+
See Also:
Constant Field Values
+
+
+ +

+AUTHORIZATION_CODE

+
+static final java.lang.String AUTHORIZATION_CODE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+REFRESH_TOKEN

+
+static final java.lang.String REFRESH_TOKEN
+
+
+
See Also:
Constant Field Values
+
+
+ +

+OAUTH1_TOKEN

+
+static final java.lang.String OAUTH1_TOKEN
+
+
+
See Also:
Constant Field Values
+
+
+ +

+CLIENT_CREDENTIALS

+
+static final java.lang.String CLIENT_CREDENTIALS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+REALM

+
+static final java.lang.String REALM
+
+
+
See Also:
Constant Field Values
+
+
+ +

+OAUTH_SCHEME

+
+static final java.lang.String OAUTH_SCHEME
+
+
+
See Also:
Constant Field Values
+
+
+ +

+VERSION

+
+static final java.lang.String VERSION
+
+
+
See Also:
Constant Field Values
+
+
+ +

+USER_AGENT

+
+static final java.lang.String USER_AGENT
+
+
+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Method Detail
+ +

+login

+
+Token login(java.lang.String username,
+            java.lang.String password)
+            throws java.io.IOException
+
+
Request a token using + Resource Owner Password Credentials. +

+

+
Parameters:
username - SoundCloud username
password - SoundCloud password +
Returns:
a valid token +
Throws: +
CloudAPI.InvalidTokenException - invalid token +
java.io.IOException - In case of network/server errors
+
+
+
+ +

+authorizationCode

+
+Token authorizationCode(java.lang.String code)
+                        throws java.io.IOException
+
+
Request a token using + Authorization Code. +

+

+
Parameters:
code - the authorization code +
Returns:
a valid token +
Throws: +
CloudAPI.InvalidTokenException - invalid token +
java.io.IOException - In case of network/server errors
+
+
+
+ +

+clientCredentials

+
+Token clientCredentials()
+                        throws java.io.IOException
+
+
Request a "signup" token using + Client Credentials. + + Note that this token is not set as the current token in the wrapper - it should only be used + for one request (typically the signup / user creation request). + Also note that not all apps are allowed to request this token type (the wrapper throws + InvalidTokenException in this case). +

+

+ +
Returns:
a valid token +
Throws: +
java.io.IOException - IO/Error +
CloudAPI.InvalidTokenException - if requested scope is not available
+
+
+
+ +

+refreshToken

+
+Token refreshToken()
+                   throws java.io.IOException
+
+
Tries to refresh the currently used access token with the refresh token. + If successful the API wrapper will have the new token set already. +

+

+ +
Returns:
a valid token +
Throws: +
java.io.IOException - in case of network problems +
CloudAPI.InvalidTokenException - invalid token +
java.lang.IllegalStateException - if no refresh token present
+
+
+
+ +

+exchangeOAuth1Token

+
+Token exchangeOAuth1Token(java.lang.String oauth1AccessToken)
+                          throws java.io.IOException
+
+
Exchange an OAuth1 Token for new OAuth2 tokens. The old OAuth1 token will be expired if + the exchange is successful. +

+

+
Parameters:
oauth1AccessToken - a valid OAuth1 access token, registered with the same client +
Returns:
a valid token +
Throws: +
java.io.IOException - IO/Error +
CloudAPI.InvalidTokenException - Token error
+
+
+
+ +

+invalidateToken

+
+Token invalidateToken()
+
+
This method should be called when the token was found to be invalid. + Also replaces the current token, if there is one available. +

+

+ +
Returns:
an alternative token, or null if none available + (which indicates that a refresh could be tried)
+
+
+
+ +

+get

+
+HttpResponse get(Request request)
+                 throws java.io.IOException
+
+
+
Parameters:
request - resource to GET +
Returns:
the HTTP response +
Throws: +
java.io.IOException - IO/Error
+
+
+
+ +

+post

+
+HttpResponse post(Request request)
+                  throws java.io.IOException
+
+
+
Parameters:
request - resource to POST +
Returns:
the HTTP response +
Throws: +
java.io.IOException - IO/Error
+
+
+
+ +

+put

+
+HttpResponse put(Request request)
+                 throws java.io.IOException
+
+
+
Parameters:
request - resource to PUT +
Returns:
the HTTP response +
Throws: +
java.io.IOException - IO/Error
+
+
+
+ +

+delete

+
+HttpResponse delete(Request request)
+                    throws java.io.IOException
+
+
+
Parameters:
request - resource to DELETE +
Returns:
the HTTP response +
Throws: +
java.io.IOException - IO/Error
+
+
+
+ +

+resolve

+
+long resolve(java.lang.String uri)
+             throws java.io.IOException
+
+
Resolve the given SoundCloud URI +

+

+
Parameters:
uri - SoundCloud model URI, e.g. http://soundcloud.com/bob +
Returns:
the id or -1 if uri not found +
Throws: +
java.io.IOException - network errors
+
+
+
+ +

+getToken

+
+Token getToken()
+
+
+ +
Returns:
the current token
+
+
+
+ +

+setToken

+
+void setToken(Token token)
+
+
+
Parameters:
token - the token to be used
+
+
+
+ +

+setTokenListener

+
+void setTokenListener(CloudAPI.TokenListener listener)
+
+
Registers a listener. The listener will be informed when an access token was found + to be invalid, and when the token had to be refreshed. +

+

+
Parameters:
listener - token listener
+
+
+
+ +

+authorizationCodeUrl

+
+java.net.URI authorizationCodeUrl(java.lang.String... options)
+
+
Request login via authorization code + After login, control will go to the redirect URI (wrapper specific), with + one of the following query parameters appended: +
    +
  • code in case of success, this will contain the code used for the + authorizationCode call to obtain the access token. +
  • error in case of failure, this contains an error code (most likely + access_denied). +
+

+

+
Parameters:
options - auth endpoint to use (leave out for default) +
Returns:
the URI to open in a browser/WebView etc.
See Also:
authorizationCode(String)
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/javadoc/1.0.0/com/soundcloud/api/Endpoints.html b/javadoc/1.0.0/com/soundcloud/api/Endpoints.html new file mode 100644 index 0000000..9680c1b --- /dev/null +++ b/javadoc/1.0.0/com/soundcloud/api/Endpoints.html @@ -0,0 +1,692 @@ + + + + + + +Endpoints (SoundCloud Java API Wrapper 1.0.0) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.soundcloud.api +
+Interface Endpoints

+
+
+
public interface Endpoints
+ + +

+Various SoundCloud API endpoints. + See the API docs for the most + recent listing. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static java.lang.StringCONNECT + +
+           
+static java.lang.StringFACEBOOK_CONNECT + +
+           
+static java.lang.StringMY_ACTIVITIES + +
+           
+static java.lang.StringMY_CONFIRMATION + +
+           
+static java.lang.StringMY_CONNECTIONS + +
+           
+static java.lang.StringMY_DETAILS + +
+           
+static java.lang.StringMY_EXCLUSIVE_TRACKS + +
+           
+static java.lang.StringMY_FAVORITE + +
+           
+static java.lang.StringMY_FAVORITES + +
+           
+static java.lang.StringMY_FOLLOWER + +
+           
+static java.lang.StringMY_FOLLOWERS + +
+           
+static java.lang.StringMY_FOLLOWING + +
+           
+static java.lang.StringMY_FOLLOWINGS + +
+           
+static java.lang.StringMY_PLAYLISTS + +
+           
+static java.lang.StringMY_TRACKS + +
+           
+static java.lang.StringRESOLVE + +
+           
+static java.lang.StringSEND_PASSWORD + +
+           
+static java.lang.StringTOKEN + +
+           
+static java.lang.StringTRACK_COMMENTS + +
+           
+static java.lang.StringTRACK_DETAILS + +
+           
+static java.lang.StringTRACKS + +
+           
+static java.lang.StringUSER_DETAILS + +
+           
+static java.lang.StringUSER_FAVORITES + +
+           
+static java.lang.StringUSER_FOLLOWERS + +
+           
+static java.lang.StringUSER_FOLLOWINGS + +
+           
+static java.lang.StringUSER_PLAYLISTS + +
+           
+static java.lang.StringUSER_TRACKS + +
+           
+static java.lang.StringUSERS + +
+           
+  +

+ + + + + + + + +
+Field Detail
+ +

+TOKEN

+
+static final java.lang.String TOKEN
+
+
+
See Also:
Constant Field Values
+
+
+ +

+TRACKS

+
+static final java.lang.String TRACKS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+TRACK_DETAILS

+
+static final java.lang.String TRACK_DETAILS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+TRACK_COMMENTS

+
+static final java.lang.String TRACK_COMMENTS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+USERS

+
+static final java.lang.String USERS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+USER_DETAILS

+
+static final java.lang.String USER_DETAILS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+USER_FOLLOWINGS

+
+static final java.lang.String USER_FOLLOWINGS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+USER_FOLLOWERS

+
+static final java.lang.String USER_FOLLOWERS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+USER_TRACKS

+
+static final java.lang.String USER_TRACKS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+USER_FAVORITES

+
+static final java.lang.String USER_FAVORITES
+
+
+
See Also:
Constant Field Values
+
+
+ +

+USER_PLAYLISTS

+
+static final java.lang.String USER_PLAYLISTS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+MY_DETAILS

+
+static final java.lang.String MY_DETAILS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+MY_CONNECTIONS

+
+static final java.lang.String MY_CONNECTIONS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+MY_ACTIVITIES

+
+static final java.lang.String MY_ACTIVITIES
+
+
+
See Also:
Constant Field Values
+
+
+ +

+MY_EXCLUSIVE_TRACKS

+
+static final java.lang.String MY_EXCLUSIVE_TRACKS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+MY_TRACKS

+
+static final java.lang.String MY_TRACKS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+MY_PLAYLISTS

+
+static final java.lang.String MY_PLAYLISTS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+MY_FAVORITES

+
+static final java.lang.String MY_FAVORITES
+
+
+
See Also:
Constant Field Values
+
+
+ +

+MY_FAVORITE

+
+static final java.lang.String MY_FAVORITE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+MY_FOLLOWERS

+
+static final java.lang.String MY_FOLLOWERS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+MY_FOLLOWER

+
+static final java.lang.String MY_FOLLOWER
+
+
+
See Also:
Constant Field Values
+
+
+ +

+MY_FOLLOWINGS

+
+static final java.lang.String MY_FOLLOWINGS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+MY_FOLLOWING

+
+static final java.lang.String MY_FOLLOWING
+
+
+
See Also:
Constant Field Values
+
+
+ +

+MY_CONFIRMATION

+
+static final java.lang.String MY_CONFIRMATION
+
+
+
See Also:
Constant Field Values
+
+
+ +

+RESOLVE

+
+static final java.lang.String RESOLVE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+SEND_PASSWORD

+
+static final java.lang.String SEND_PASSWORD
+
+
+
See Also:
Constant Field Values
+
+
+ +

+CONNECT

+
+static final java.lang.String CONNECT
+
+
+
See Also:
Constant Field Values
+
+
+ +

+FACEBOOK_CONNECT

+
+static final java.lang.String FACEBOOK_CONNECT
+
+
+
See Also:
Constant Field Values
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/javadoc/1.0.0/com/soundcloud/api/Env.html b/javadoc/1.0.0/com/soundcloud/api/Env.html new file mode 100644 index 0000000..34ffda7 --- /dev/null +++ b/javadoc/1.0.0/com/soundcloud/api/Env.html @@ -0,0 +1,455 @@ + + + + + + +Env (SoundCloud Java API Wrapper 1.0.0) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ +

+ +com.soundcloud.api +
+Enum Env

+
+java.lang.Object
+  extended by java.lang.Enum<Env>
+      extended by com.soundcloud.api.Env
+
+
+
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Env>
+
+
+
+
public enum Env
extends java.lang.Enum<Env>
+ + +

+The environment to operate against. + Use SANDBOX for testing your app, and LIVE for production applications. +

+ +

+

+ +

+ + + + + + + + + + + + + +
+Enum Constant Summary
LIVE + +
+          The main production site, http://soundcloud.com
SANDBOX + +
+          For testing, http://sandbox-soundcloud.com
+  + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+ HttpHostauthResourceHost + +
+           
+ HttpHostresourceHost + +
+           
+ HttpHostsslAuthResourceHost + +
+           
+ HttpHostsslResourceHost + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ HttpHostgetAuthResourceHost(boolean secure) + +
+           
+ HttpHostgetResourceHost(boolean secure) + +
+           
+static EnvvalueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static Env[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  + + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+LIVE

+
+public static final Env LIVE
+
+
The main production site, http://soundcloud.com +

+

+
+
+
+ +

+SANDBOX

+
+public static final Env SANDBOX
+
+
For testing, http://sandbox-soundcloud.com +

+

+
+
+ + + + + + + + +
+Field Detail
+ +

+resourceHost

+
+public final HttpHost resourceHost
+
+
+
+
+
+ +

+sslResourceHost

+
+public final HttpHost sslResourceHost
+
+
+
+
+
+ +

+authResourceHost

+
+public final HttpHost authResourceHost
+
+
+
+
+
+ +

+sslAuthResourceHost

+
+public final HttpHost sslAuthResourceHost
+
+
+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static Env[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (Env c : Env.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static Env valueOf(java.lang.String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name +
java.lang.NullPointerException - if the argument is null
+
+
+
+ +

+getResourceHost

+
+public HttpHost getResourceHost(boolean secure)
+
+
+
+
+
+
+ +

+getAuthResourceHost

+
+public HttpHost getAuthResourceHost(boolean secure)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ + + diff --git a/javadoc/1.0.0/com/soundcloud/api/Http.html b/javadoc/1.0.0/com/soundcloud/api/Http.html new file mode 100644 index 0000000..e03ad6d --- /dev/null +++ b/javadoc/1.0.0/com/soundcloud/api/Http.html @@ -0,0 +1,324 @@ + + + + + + +Http (SoundCloud Java API Wrapper 1.0.0) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.soundcloud.api +
+Class Http

+
+java.lang.Object
+  extended by com.soundcloud.api.Http
+
+
+
+
public class Http
extends java.lang.Object
+ + +

+Helper class for various HTTP related functions. +

+ +

+

+ +

+ + + + + + + + + + + + + + + +
+Field Summary
+static intBUFFER_SIZE + +
+           
+static intTIMEOUT + +
+          Connection timeout
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static HttpParamsdefaultParams() + +
+           
+static JSONObjectgetJSON(HttpResponse response) + +
+           
+static java.lang.StringgetString(HttpResponse response) + +
+          Returns a String representation of the response
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+BUFFER_SIZE

+
+public static final int BUFFER_SIZE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+TIMEOUT

+
+public static final int TIMEOUT
+
+
Connection timeout +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Method Detail
+ +

+getString

+
+public static java.lang.String getString(HttpResponse response)
+                                  throws java.io.IOException
+
+
Returns a String representation of the response +

+

+
Parameters:
response - an HTTP response +
Returns:
the content body +
Throws: +
java.io.IOException - network error
+
+
+
+ +

+getJSON

+
+public static JSONObject getJSON(HttpResponse response)
+                          throws java.io.IOException
+
+
+ +
Throws: +
java.io.IOException
+
+
+
+ +

+defaultParams

+
+public static HttpParams defaultParams()
+
+
+ +
Returns:
the default HttpParams
See Also:
+ android.net.http.AndroidHttpClient#newInstance(String, Context)
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/javadoc/1.0.0/com/soundcloud/api/Params.Comment.html b/javadoc/1.0.0/com/soundcloud/api/Params.Comment.html new file mode 100644 index 0000000..e3561aa --- /dev/null +++ b/javadoc/1.0.0/com/soundcloud/api/Params.Comment.html @@ -0,0 +1,243 @@ + + + + + + +Params.Comment (SoundCloud Java API Wrapper 1.0.0) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.soundcloud.api +
+Interface Params.Comment

+
+
Enclosing interface:
Params
+
+
+
+
public static interface Params.Comment
+ + +

+Comments +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + +
+Field Summary
+static java.lang.StringBODY + +
+           
+static java.lang.StringREPLY_TO + +
+           
+static java.lang.StringTIMESTAMP + +
+           
+  +

+ + + + + + + + +
+Field Detail
+ +

+BODY

+
+static final java.lang.String BODY
+
+
+
See Also:
Constant Field Values
+
+
+ +

+TIMESTAMP

+
+static final java.lang.String TIMESTAMP
+
+
+
See Also:
Constant Field Values
+
+
+ +

+REPLY_TO

+
+static final java.lang.String REPLY_TO
+
+
+
See Also:
Constant Field Values
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/javadoc/1.0.0/com/soundcloud/api/Params.Track.html b/javadoc/1.0.0/com/soundcloud/api/Params.Track.html new file mode 100644 index 0000000..9054ff2 --- /dev/null +++ b/javadoc/1.0.0/com/soundcloud/api/Params.Track.html @@ -0,0 +1,711 @@ + + + + + + +Params.Track (SoundCloud Java API Wrapper 1.0.0) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.soundcloud.api +
+Interface Params.Track

+
+
Enclosing interface:
Params
+
+
+
+
public static interface Params.Track
+ + +

+Tracks +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static java.lang.StringARTWORK_DATA + +
+           
+static java.lang.StringASSET_DATA + +
+           
+static java.lang.StringBPM + +
+           
+static java.lang.StringDESCRIPTION + +
+           
+static java.lang.StringDOWNLOADABLE + +
+           
+static java.lang.StringGENRE + +
+           
+static java.lang.StringISRC + +
+           
+static java.lang.StringKEY_SIGNATURE + +
+           
+static java.lang.StringLABEL_ID + +
+           
+static java.lang.StringLABEL_NAME + +
+           
+static java.lang.StringLICENSE + +
+           
+static java.lang.StringPERMALINK + +
+           
+static java.lang.StringPOST_TO + +
+           
+static java.lang.StringPOST_TO_EMPTY + +
+           
+static java.lang.StringPRIVATE + +
+           
+static java.lang.StringPUBLIC + +
+           
+static java.lang.StringPURCHASE_URL + +
+           
+static java.lang.StringRELEASE + +
+           
+static java.lang.StringRELEASE_DAY + +
+           
+static java.lang.StringRELEASE_MONTH + +
+           
+static java.lang.StringRELEASE_YEAR + +
+           
+static java.lang.StringSHARED_EMAILS + +
+           
+static java.lang.StringSHARING + +
+           
+static java.lang.StringSHARING_NOTE + +
+           
+static java.lang.StringSTREAMABLE + +
+           
+static java.lang.StringTAG_LIST + +
+           
+static java.lang.StringTITLE + +
+           
+static java.lang.StringTYPE + +
+           
+static java.lang.StringVIDEO_URL + +
+           
+  +

+ + + + + + + + +
+Field Detail
+ +

+TITLE

+
+static final java.lang.String TITLE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+TYPE

+
+static final java.lang.String TYPE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+DESCRIPTION

+
+static final java.lang.String DESCRIPTION
+
+
+
See Also:
Constant Field Values
+
+
+ +

+ASSET_DATA

+
+static final java.lang.String ASSET_DATA
+
+
+
See Also:
Constant Field Values
+
+
+ +

+ARTWORK_DATA

+
+static final java.lang.String ARTWORK_DATA
+
+
+
See Also:
Constant Field Values
+
+
+ +

+POST_TO

+
+static final java.lang.String POST_TO
+
+
+
See Also:
Constant Field Values
+
+
+ +

+POST_TO_EMPTY

+
+static final java.lang.String POST_TO_EMPTY
+
+
+
See Also:
Constant Field Values
+
+
+ +

+TAG_LIST

+
+static final java.lang.String TAG_LIST
+
+
+
See Also:
Constant Field Values
+
+
+ +

+PERMALINK

+
+static final java.lang.String PERMALINK
+
+
+
See Also:
Constant Field Values
+
+
+ +

+SHARING

+
+static final java.lang.String SHARING
+
+
+
See Also:
Constant Field Values
+
+
+ +

+STREAMABLE

+
+static final java.lang.String STREAMABLE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+DOWNLOADABLE

+
+static final java.lang.String DOWNLOADABLE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+GENRE

+
+static final java.lang.String GENRE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+RELEASE

+
+static final java.lang.String RELEASE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+RELEASE_DAY

+
+static final java.lang.String RELEASE_DAY
+
+
+
See Also:
Constant Field Values
+
+
+ +

+RELEASE_MONTH

+
+static final java.lang.String RELEASE_MONTH
+
+
+
See Also:
Constant Field Values
+
+
+ +

+RELEASE_YEAR

+
+static final java.lang.String RELEASE_YEAR
+
+
+
See Also:
Constant Field Values
+
+
+ +

+PURCHASE_URL

+
+static final java.lang.String PURCHASE_URL
+
+
+
See Also:
Constant Field Values
+
+
+ +

+LABEL_NAME

+
+static final java.lang.String LABEL_NAME
+
+
+
See Also:
Constant Field Values
+
+
+ +

+LABEL_ID

+
+static final java.lang.String LABEL_ID
+
+
+
See Also:
Constant Field Values
+
+
+ +

+VIDEO_URL

+
+static final java.lang.String VIDEO_URL
+
+
+
See Also:
Constant Field Values
+
+
+ +

+ISRC

+
+static final java.lang.String ISRC
+
+
+
See Also:
Constant Field Values
+
+
+ +

+KEY_SIGNATURE

+
+static final java.lang.String KEY_SIGNATURE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+BPM

+
+static final java.lang.String BPM
+
+
+
See Also:
Constant Field Values
+
+
+ +

+LICENSE

+
+static final java.lang.String LICENSE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+SHARED_EMAILS

+
+static final java.lang.String SHARED_EMAILS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+SHARING_NOTE

+
+static final java.lang.String SHARING_NOTE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+PUBLIC

+
+static final java.lang.String PUBLIC
+
+
+
See Also:
Constant Field Values
+
+
+ +

+PRIVATE

+
+static final java.lang.String PRIVATE
+
+
+
See Also:
Constant Field Values
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/javadoc/1.0.0/com/soundcloud/api/Params.User.html b/javadoc/1.0.0/com/soundcloud/api/Params.User.html new file mode 100644 index 0000000..5a1ddd8 --- /dev/null +++ b/javadoc/1.0.0/com/soundcloud/api/Params.User.html @@ -0,0 +1,441 @@ + + + + + + +Params.User (SoundCloud Java API Wrapper 1.0.0) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.soundcloud.api +
+Interface Params.User

+
+
Enclosing interface:
Params
+
+
+
+
public static interface Params.User
+ + +

+Users +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static java.lang.StringAVATAR + +
+           
+static java.lang.StringCITY + +
+           
+static java.lang.StringDESCRIPTION + +
+           
+static java.lang.StringDISCOGS_NAME + +
+           
+static java.lang.StringEMAIL + +
+           
+static java.lang.StringFULLNAME + +
+           
+static java.lang.StringMYSPACE_NAME + +
+           
+static java.lang.StringNAME + +
+           
+static java.lang.StringPASSWORD + +
+           
+static java.lang.StringPASSWORD_CONFIRMATION + +
+           
+static java.lang.StringPERMALINK + +
+           
+static java.lang.StringTERMS_OF_USE + +
+           
+static java.lang.StringWEBSITE + +
+           
+static java.lang.StringWEBSITE_TITLE + +
+           
+  +

+ + + + + + + + +
+Field Detail
+ +

+NAME

+
+static final java.lang.String NAME
+
+
+
See Also:
Constant Field Values
+
+
+ +

+FULLNAME

+
+static final java.lang.String FULLNAME
+
+
+
See Also:
Constant Field Values
+
+
+ +

+DESCRIPTION

+
+static final java.lang.String DESCRIPTION
+
+
+
See Also:
Constant Field Values
+
+
+ +

+CITY

+
+static final java.lang.String CITY
+
+
+
See Also:
Constant Field Values
+
+
+ +

+PERMALINK

+
+static final java.lang.String PERMALINK
+
+
+
See Also:
Constant Field Values
+
+
+ +

+DISCOGS_NAME

+
+static final java.lang.String DISCOGS_NAME
+
+
+
See Also:
Constant Field Values
+
+
+ +

+MYSPACE_NAME

+
+static final java.lang.String MYSPACE_NAME
+
+
+
See Also:
Constant Field Values
+
+
+ +

+WEBSITE

+
+static final java.lang.String WEBSITE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+WEBSITE_TITLE

+
+static final java.lang.String WEBSITE_TITLE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+EMAIL

+
+static final java.lang.String EMAIL
+
+
+
See Also:
Constant Field Values
+
+
+ +

+PASSWORD

+
+static final java.lang.String PASSWORD
+
+
+
See Also:
Constant Field Values
+
+
+ +

+PASSWORD_CONFIRMATION

+
+static final java.lang.String PASSWORD_CONFIRMATION
+
+
+
See Also:
Constant Field Values
+
+
+ +

+TERMS_OF_USE

+
+static final java.lang.String TERMS_OF_USE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+AVATAR

+
+static final java.lang.String AVATAR
+
+
+
See Also:
Constant Field Values
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/javadoc/1.0.0/com/soundcloud/api/Params.html b/javadoc/1.0.0/com/soundcloud/api/Params.html new file mode 100644 index 0000000..3e3af08 --- /dev/null +++ b/javadoc/1.0.0/com/soundcloud/api/Params.html @@ -0,0 +1,201 @@ + + + + + + +Params (SoundCloud Java API Wrapper 1.0.0) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.soundcloud.api +
+Interface Params

+
+
+
public interface Params
+ + +

+Request parameters for various objects. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + +
+Nested Class Summary
+static interfaceParams.Comment + +
+          Comments
+static interfaceParams.Track + +
+          Tracks
+static interfaceParams.User + +
+          Users
+  +

+ +

+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/javadoc/1.0.0/com/soundcloud/api/Request.TransferProgressListener.html b/javadoc/1.0.0/com/soundcloud/api/Request.TransferProgressListener.html new file mode 100644 index 0000000..46e79ce --- /dev/null +++ b/javadoc/1.0.0/com/soundcloud/api/Request.TransferProgressListener.html @@ -0,0 +1,209 @@ + + + + + + +Request.TransferProgressListener (SoundCloud Java API Wrapper 1.0.0) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.soundcloud.api +
+Interface Request.TransferProgressListener

+
+
Enclosing class:
Request
+
+
+
+
public static interface Request.TransferProgressListener
+ + +

+Updates about the amount of bytes already transferred. +

+ +

+

+ +

+ + + + + + + + + + + + +
+Method Summary
+ voidtransferred(long amount) + +
+           
+  +

+ + + + + + + + +
+Method Detail
+ +

+transferred

+
+void transferred(long amount)
+
+
+
Parameters:
amount - number of bytes already transferred.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/javadoc/1.0.0/com/soundcloud/api/Request.html b/javadoc/1.0.0/com/soundcloud/api/Request.html new file mode 100644 index 0000000..f659c04 --- /dev/null +++ b/javadoc/1.0.0/com/soundcloud/api/Request.html @@ -0,0 +1,605 @@ + + + + + + +Request (SoundCloud Java API Wrapper 1.0.0) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.soundcloud.api +
+Class Request

+
+java.lang.Object
+  extended by com.soundcloud.api.Request
+
+
+
All Implemented Interfaces:
java.lang.Iterable<NameValuePair>
+
+
+
+
public class Request
extends java.lang.Object
implements java.lang.Iterable<NameValuePair>
+ + +

+Convenience class for constructing HTTP requests. + + Example: + + 

+  HttpRequest request = Request.to("/tracks")
+     .with("track[user]", 1234)
+     .withFile("track[asset_data]", new File("track.mp3")
+     .buildRequest(HttpPost.class);
+
+  httpClient.execute(request);
+
+ +

+ +

+

+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static interfaceRequest.TransferProgressListener + +
+          Updates about the amount of bytes already transferred.
+  + + + + + + + + + + + + + +
+Constructor Summary
Request() + +
+          Empty request
Request(java.lang.String resource) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ Requestadd(java.lang.String name, + java.lang.Object value) + +
+          Adds a key value pair
+ + + + + +
+<T extends org.apache.http.client.methods.HttpRequestBase> +
+T
+		buildRequest(java.lang.Class<T> method) + +
+          Builds a request with the given set of parameters and files.
+ java.util.Iterator<NameValuePair>iterator() + +
+           
+ java.lang.StringqueryString() + +
+           
+ RequestsetProgressListener(Request.TransferProgressListener listener) + +
+           
+ intsize() + +
+           
+static Requestto(java.lang.String resource, + java.lang.Object... args) + +
+           
+ java.lang.StringtoString() + +
+           
+ java.lang.StringtoUrl() + +
+           
+ java.lang.StringtoUrl(java.lang.String resource) + +
+           
+ RequestusingToken(Token token) + +
+          The request should be made with a specific token.
+ Requestwith(java.lang.Object... args) + +
+           
+ RequestwithFile(java.lang.String name, + java.io.File file) + +
+          Registers a file to be uploaded with a POST or PUT request.
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Request

+
+public Request()
+
+
Empty request +

+

+
+ +

+Request

+
+public Request(java.lang.String resource)
+
+
+
Parameters:
resource - the base resource
+
+ + + + + + + + +
+Method Detail
+ +

+to

+
+public static Request to(java.lang.String resource,
+                         java.lang.Object... args)
+
+
+
+
+
+
Parameters:
resource - the resource to request
args - optional string expansion arguments (passed to String#format(String, Object...) +
Returns:
the request +
Throws: +
java.util.IllegalFormatException - - If a format string contains an illegal syntax,
See Also:
String.format(String, Object...)
+
+
+
+ +

+add

+
+public Request add(java.lang.String name,
+                   java.lang.Object value)
+
+
Adds a key value pair +

+

+
+
+
+
Parameters:
name - the name
value - the value +
Returns:
this
+
+
+
+ +

+with

+
+public Request with(java.lang.Object... args)
+
+
+
+
+
+
Parameters:
args - a list of arguments +
Returns:
this
+
+
+
+ +

+usingToken

+
+public Request usingToken(Token token)
+
+
The request should be made with a specific token. +

+

+
+
+
+
Parameters:
token - the token +
Returns:
this
+
+
+
+ +

+size

+
+public int size()
+
+
+
+
+
+ +
Returns:
the size of the parameters
+
+
+
+ +

+queryString

+
+public java.lang.String queryString()
+
+
+
+
+
+ +
Returns:
a String that is suitable for use as an application/x-www-form-urlencoded + list of parameters in an HTTP PUT or HTTP POST.
+
+
+
+ +

+toUrl

+
+public java.lang.String toUrl(java.lang.String resource)
+
+
+
+
+
+
Parameters:
resource - the resource +
Returns:
an URL with the query string parameters appended
+
+
+
+ +

+toUrl

+
+public java.lang.String toUrl()
+
+
+
+
+
+
+
+
+
+ +

+withFile

+
+public Request withFile(java.lang.String name,
+                        java.io.File file)
+
+
Registers a file to be uploaded with a POST or PUT request. +

+

+
+
+
+
Parameters:
name - the name of the file
file - the file to be submitted +
Returns:
this
+
+
+
+ +

+setProgressListener

+
+public Request setProgressListener(Request.TransferProgressListener listener)
+
+
+
+
+
+
Parameters:
listener - a listener for receiving notifications about transfer progress +
Returns:
this
+
+
+
+ +

+buildRequest

+
+public <T extends org.apache.http.client.methods.HttpRequestBase> T buildRequest(java.lang.Class<T> method)
+
+
Builds a request with the given set of parameters and files. +

+

+
+
+
+
Type Parameters:
T - the type of request to use
Parameters:
method - the type of request to use +
Returns:
HTTP request, prepared to be executed
+
+
+
+ +

+toString

+
+public java.lang.String toString()
+
+
+
Overrides:
toString in class java.lang.Object
+
+
+
+
+
+
+ +

+iterator

+
+public java.util.Iterator<NameValuePair> iterator()
+
+
+
Specified by:
iterator in interface java.lang.Iterable<NameValuePair>
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/javadoc/1.0.0/com/soundcloud/api/Token.html b/javadoc/1.0.0/com/soundcloud/api/Token.html new file mode 100644 index 0000000..f386876 --- /dev/null +++ b/javadoc/1.0.0/com/soundcloud/api/Token.html @@ -0,0 +1,628 @@ + + + + + + +Token (SoundCloud Java API Wrapper 1.0.0) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.soundcloud.api +
+Class Token

+
+java.lang.Object
+  extended by com.soundcloud.api.Token
+
+
+
All Implemented Interfaces:
java.io.Serializable
+
+
+
+
public class Token
extends java.lang.Object
implements java.io.Serializable
+ + +

+Represents an OAuth2 access/refresh token pair. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+ java.lang.Stringaccess + +
+           
+static java.lang.StringACCESS_TOKEN + +
+           
+static java.lang.StringEXPIRES_IN + +
+           
+ longexpiresIn + +
+           
+ java.lang.Stringrefresh + +
+           
+static java.lang.StringREFRESH_TOKEN + +
+           
+ java.lang.Stringscope + +
+           
+static java.lang.StringSCOPE + +
+           
+static java.lang.StringSCOPE_SIGNUP + +
+           
+  + + + + + + + + + + + + + +
+Constructor Summary
Token(JSONObject json) + +
+          Construct a new token from a JSON response
Token(java.lang.String access, + java.lang.String refresh) + +
+          Constructs a new token with the given sub-tokens
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ booleanequals(java.lang.Object o) + +
+           
+ java.util.DategetExpiresIn() + +
+           
+ inthashCode() + +
+           
+ voidinvalidate() + +
+          Invalidates the access token
+ booleansignupScoped() + +
+           
+ booleanstarScoped() + +
+           
+ java.lang.StringtoString() + +
+           
+ booleanvalid() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+ACCESS_TOKEN

+
+public static final java.lang.String ACCESS_TOKEN
+
+
+
See Also:
Constant Field Values
+
+
+ +

+REFRESH_TOKEN

+
+public static final java.lang.String REFRESH_TOKEN
+
+
+
See Also:
Constant Field Values
+
+
+ +

+SCOPE

+
+public static final java.lang.String SCOPE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+EXPIRES_IN

+
+public static final java.lang.String EXPIRES_IN
+
+
+
See Also:
Constant Field Values
+
+
+ +

+SCOPE_SIGNUP

+
+public static final java.lang.String SCOPE_SIGNUP
+
+
+
See Also:
Constant Field Values
+
+
+ +

+access

+
+public java.lang.String access
+
+
+
+
+
+ +

+refresh

+
+public java.lang.String refresh
+
+
+
+
+
+ +

+scope

+
+public java.lang.String scope
+
+
+
+
+
+ +

+expiresIn

+
+public long expiresIn
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+Token

+
+public Token(java.lang.String access,
+             java.lang.String refresh)
+
+
Constructs a new token with the given sub-tokens +

+

+
Parameters:
access - A token used by the client to make authenticated requests on behalf of the resource owner.
refresh - A token used by the client to obtain a new access token without having + to involve the resource owner.
+
+
+ +

+Token

+
+public Token(JSONObject json)
+      throws java.io.IOException
+
+
Construct a new token from a JSON response +

+

+
Parameters:
json - the json response +
Throws: +
java.io.IOException - JSON format error
+
+ + + + + + + + +
+Method Detail
+ +

+invalidate

+
+public void invalidate()
+
+
Invalidates the access token +

+

+
+
+
+
+
+
+
+ +

+getExpiresIn

+
+public java.util.Date getExpiresIn()
+
+
+
+
+
+ +
Returns:
null or the date of expiration of this token
+
+
+
+ +

+starScoped

+
+public boolean starScoped()
+
+
+
+
+
+ +
Returns:
has token the wildcard scope ("*")
+
+
+
+ +

+signupScoped

+
+public boolean signupScoped()
+
+
+
+
+
+ +
Returns:
has token the signup scope ("signup")
+
+
+
+ +

+valid

+
+public boolean valid()
+
+
+
+
+
+ +
Returns:
is this token valid
+
+
+
+ +

+toString

+
+public java.lang.String toString()
+
+
+
Overrides:
toString in class java.lang.Object
+
+
+
+
+
+
+ +

+equals

+
+public boolean equals(java.lang.Object o)
+
+
+
Overrides:
equals in class java.lang.Object
+
+
+
+
+
+
+ +

+hashCode

+
+public int hashCode()
+
+
+
Overrides:
hashCode in class java.lang.Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/javadoc/1.0.0/com/soundcloud/api/package-frame.html b/javadoc/1.0.0/com/soundcloud/api/package-frame.html new file mode 100644 index 0000000..56e6c60 --- /dev/null +++ b/javadoc/1.0.0/com/soundcloud/api/package-frame.html @@ -0,0 +1,85 @@ + + + + + + +com.soundcloud.api (SoundCloud Java API Wrapper 1.0.0) + + + + + + + + + + + +com.soundcloud.api + + + + +
+Interfaces  + +
+CloudAPI +
+CloudAPI.TokenListener +
+Endpoints +
+Params +
+Params.Comment +
+Params.Track +
+Params.User +
+Request.TransferProgressListener
+ + + + + + +
+Classes  + +
+ApiWrapper +
+Http +
+Request +
+Token
+ + + + + + +
+Enums  + +
+Env
+ + + + + + +
+Exceptions  + +
+CloudAPI.InvalidTokenException
+ + + + diff --git a/javadoc/1.0.0/com/soundcloud/api/package-summary.html b/javadoc/1.0.0/com/soundcloud/api/package-summary.html new file mode 100644 index 0000000..73ba61e --- /dev/null +++ b/javadoc/1.0.0/com/soundcloud/api/package-summary.html @@ -0,0 +1,257 @@ + + + + + + +com.soundcloud.api (SoundCloud Java API Wrapper 1.0.0) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.soundcloud.api +

+Provides an API Wrapper to access the + SoundCloud API. +

+See: +
+          Description +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Interface Summary
CloudAPIInterface with SoundCloud, using OAuth2.
CloudAPI.TokenListenerInterested in changes to the current token.
EndpointsVarious SoundCloud API endpoints.
ParamsRequest parameters for various objects.
Params.CommentComments
Params.TrackTracks
Params.UserUsers
Request.TransferProgressListenerUpdates about the amount of bytes already transferred.
+  + +

+ + + + + + + + + + + + + + + + + + + + + +
+Class Summary
ApiWrapperInterface with SoundCloud, using OAuth2.
HttpHelper class for various HTTP related functions.
RequestConvenience class for constructing HTTP requests.
TokenRepresents an OAuth2 access/refresh token pair.
+  + +

+ + + + + + + + + +
+Enum Summary
EnvThe environment to operate against.
+  + +

+ + + + + + + + + +
+Exception Summary
CloudAPI.InvalidTokenExceptionThrown when token is not valid.
+  + +

+

+Package com.soundcloud.api Description +

+ +

+Provides an API Wrapper to access the + SoundCloud API. + + See the project README for more + information. +

+ +

+

+
Version:
+
1.0.0, 05/19/11
+
See Also:
ApiWrapper
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/javadoc/1.0.0/com/soundcloud/api/package-tree.html b/javadoc/1.0.0/com/soundcloud/api/package-tree.html new file mode 100644 index 0000000..793014a --- /dev/null +++ b/javadoc/1.0.0/com/soundcloud/api/package-tree.html @@ -0,0 +1,171 @@ + + + + + + +com.soundcloud.api Class Hierarchy (SoundCloud Java API Wrapper 1.0.0) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.soundcloud.api +

+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +

+Enum Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/javadoc/1.0.0/constant-values.html b/javadoc/1.0.0/constant-values.html new file mode 100644 index 0000000..277a404 --- /dev/null +++ b/javadoc/1.0.0/constant-values.html @@ -0,0 +1,776 @@ + + + + + + +Constant Field Values (SoundCloud Java API Wrapper 1.0.0) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Constant Field Values

+
+
+Contents + + + + + + +
+com.soundcloud.*
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
com.soundcloud.api.CloudAPI
+public static final java.lang.StringAUTHORIZATION_CODE"authorization_code"
+public static final java.lang.StringCLIENT_CREDENTIALS"client_credentials"
+public static final java.lang.StringOAUTH_SCHEME"oauth"
+public static final java.lang.StringOAUTH1_TOKEN"oauth1_token"
+public static final java.lang.StringPASSWORD"password"
+public static final java.lang.StringREALM"SoundCloud"
+public static final java.lang.StringREFRESH_TOKEN"refresh_token"
+public static final java.lang.StringUSER_AGENT"SoundCloud Java Wrapper (1.0.0)"
+public static final java.lang.StringVERSION"1.0.0"
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
com.soundcloud.api.Endpoints
+public static final java.lang.StringCONNECT"/connect"
+public static final java.lang.StringFACEBOOK_CONNECT"/connect/via/facebook"
+public static final java.lang.StringMY_ACTIVITIES"/me/activities/tracks"
+public static final java.lang.StringMY_CONFIRMATION"/me/email-confirmations"
+public static final java.lang.StringMY_CONNECTIONS"/me/connections"
+public static final java.lang.StringMY_DETAILS"/me"
+public static final java.lang.StringMY_EXCLUSIVE_TRACKS"/me/activities/tracks/exclusive"
+public static final java.lang.StringMY_FAVORITE"/me/favorites/%d"
+public static final java.lang.StringMY_FAVORITES"/me/favorites"
+public static final java.lang.StringMY_FOLLOWER"/me/followers/%d"
+public static final java.lang.StringMY_FOLLOWERS"/me/followers"
+public static final java.lang.StringMY_FOLLOWING"/me/followings/%d"
+public static final java.lang.StringMY_FOLLOWINGS"/me/followings"
+public static final java.lang.StringMY_PLAYLISTS"/me/playlists"
+public static final java.lang.StringMY_TRACKS"/me/tracks"
+public static final java.lang.StringRESOLVE"/resolve"
+public static final java.lang.StringSEND_PASSWORD"/passwords/reset-instructions"
+public static final java.lang.StringTOKEN"/oauth2/token"
+public static final java.lang.StringTRACK_COMMENTS"/tracks/%d/comments"
+public static final java.lang.StringTRACK_DETAILS"/tracks/%d"
+public static final java.lang.StringTRACKS"/tracks"
+public static final java.lang.StringUSER_DETAILS"/users/%d"
+public static final java.lang.StringUSER_FAVORITES"/users/%d/favorites"
+public static final java.lang.StringUSER_FOLLOWERS"/users/%d/followers"
+public static final java.lang.StringUSER_FOLLOWINGS"/users/%d/followings"
+public static final java.lang.StringUSER_PLAYLISTS"/users/%d/playlists"
+public static final java.lang.StringUSER_TRACKS"/users/%d/tracks"
+public static final java.lang.StringUSERS"/users"
+ +

+ +

+ + + + + + + + + + + + + + + + + +
com.soundcloud.api.Http
+public static final intBUFFER_SIZE8192
+public static final intTIMEOUT20000
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + +
com.soundcloud.api.Params.Comment
+public static final java.lang.StringBODY"comment[body]"
+public static final java.lang.StringREPLY_TO"comment[reply_to]"
+public static final java.lang.StringTIMESTAMP"comment[timestamp]"
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
com.soundcloud.api.Params.Track
+public static final java.lang.StringARTWORK_DATA"track[artwork_data]"
+public static final java.lang.StringASSET_DATA"track[asset_data]"
+public static final java.lang.StringBPM"track[bpm]"
+public static final java.lang.StringDESCRIPTION"track[description]"
+public static final java.lang.StringDOWNLOADABLE"track[downloadable]"
+public static final java.lang.StringGENRE"track[genre]"
+public static final java.lang.StringISRC"track[isrc]"
+public static final java.lang.StringKEY_SIGNATURE"track[key_signature]"
+public static final java.lang.StringLABEL_ID"track[label_id]"
+public static final java.lang.StringLABEL_NAME"track[label_name]"
+public static final java.lang.StringLICENSE"track[license]"
+public static final java.lang.StringPERMALINK"track[permalink]"
+public static final java.lang.StringPOST_TO"track[post_to][][id]"
+public static final java.lang.StringPOST_TO_EMPTY"track[post_to][]"
+public static final java.lang.StringPRIVATE"private"
+public static final java.lang.StringPUBLIC"public"
+public static final java.lang.StringPURCHASE_URL"track[purchase_url]"
+public static final java.lang.StringRELEASE"track[release]"
+public static final java.lang.StringRELEASE_DAY"track[release_day]"
+public static final java.lang.StringRELEASE_MONTH"track[release_month]"
+public static final java.lang.StringRELEASE_YEAR"track[release_year]"
+public static final java.lang.StringSHARED_EMAILS"track[shared_to][emails][][address]"
+public static final java.lang.StringSHARING"track[sharing]"
+public static final java.lang.StringSHARING_NOTE"track[sharing_note]"
+public static final java.lang.StringSTREAMABLE"track[streamable]"
+public static final java.lang.StringTAG_LIST"track[tag_list]"
+public static final java.lang.StringTITLE"track[title]"
+public static final java.lang.StringTYPE"track[track_type]"
+public static final java.lang.StringVIDEO_URL"track[video_url]"
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
com.soundcloud.api.Params.User
+public static final java.lang.StringAVATAR"user[avatar_data]"
+public static final java.lang.StringCITY"user[city]"
+public static final java.lang.StringDESCRIPTION"user[description]"
+public static final java.lang.StringDISCOGS_NAME"user[discogs_name]"
+public static final java.lang.StringEMAIL"user[email]"
+public static final java.lang.StringFULLNAME"user[full_name]"
+public static final java.lang.StringMYSPACE_NAME"user[myspace_name]"
+public static final java.lang.StringNAME"user[username]"
+public static final java.lang.StringPASSWORD"user[password]"
+public static final java.lang.StringPASSWORD_CONFIRMATION"user[password_confirmation]"
+public static final java.lang.StringPERMALINK"user[permalink]"
+public static final java.lang.StringTERMS_OF_USE"user[terms_of_use]"
+public static final java.lang.StringWEBSITE"user[website]"
+public static final java.lang.StringWEBSITE_TITLE"user[website_title]"
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
com.soundcloud.api.Token
+public static final java.lang.StringACCESS_TOKEN"access_token"
+public static final java.lang.StringEXPIRES_IN"expires_in"
+public static final java.lang.StringREFRESH_TOKEN"refresh_token"
+public static final java.lang.StringSCOPE"scope"
+public static final java.lang.StringSCOPE_SIGNUP"signup"
+ +

+ +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/javadoc/1.0.0/deprecated-list.html b/javadoc/1.0.0/deprecated-list.html new file mode 100644 index 0000000..e74a7a6 --- /dev/null +++ b/javadoc/1.0.0/deprecated-list.html @@ -0,0 +1,142 @@ + + + + + + +Deprecated List (SoundCloud Java API Wrapper 1.0.0) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree   Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Deprecated API

+
+
+Contents + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree   Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/javadoc/1.0.0/help-doc.html b/javadoc/1.0.0/help-doc.html new file mode 100644 index 0000000..c854a3b --- /dev/null +++ b/javadoc/1.0.0/help-doc.html @@ -0,0 +1,209 @@ + + + + + + +API Help (SoundCloud Java API Wrapper 1.0.0) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree  Deprecated  Index   Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+How This API Document Is Organized

+
+This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

+Package

+
+ +

+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

    +
  • Interfaces (italic)
  • Classes
  • Enums
  • Exceptions
  • Errors
  • Annotation Types
+
+

+Class/Interface

+
+ +

+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

    +
  • Class inheritance diagram
  • Direct Subclasses
  • All Known Subinterfaces
  • All Known Implementing Classes
  • Class/interface declaration
  • Class/interface description +

    +

  • Nested Class Summary
  • Field Summary
  • Constructor Summary
  • Method Summary +

    +

  • Field Detail
  • Constructor Detail
  • Method Detail
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+ +

+Annotation Type

+
+ +

+Each annotation type has its own separate page with the following sections:

    +
  • Annotation Type declaration
  • Annotation Type description
  • Required Element Summary
  • Optional Element Summary
  • Element Detail
+
+ +

+Enum

+
+ +

+Each enum has its own separate page with the following sections:

    +
  • Enum declaration
  • Enum description
  • Enum Constant Summary
  • Enum Constant Detail
+
+

+Tree (Class Hierarchy)

+
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
    +
  • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
  • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
+
+

+Deprecated API

+
+The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+

+Index

+
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+

+Prev/Next

+These links take you to the next or previous class, interface, package, or related page.

+Frames/No Frames

+These links show and hide the HTML frames. All pages are available with or without frames. +

+

+Serialized Form

+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

+

+Constant Field Values

+The Constant Field Values page lists the static final fields and their values. +

+ + +This help file applies to API documentation generated using the standard doclet. + +
+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree  Deprecated  Index   Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/javadoc/1.0.0/index-all.html b/javadoc/1.0.0/index-all.html new file mode 100644 index 0000000..cf0c807 --- /dev/null +++ b/javadoc/1.0.0/index-all.html @@ -0,0 +1,796 @@ + + + + + + +Index (SoundCloud Java API Wrapper 1.0.0) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree  Deprecated   Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I K L M N O P Q R S T U V W
+

+A

+
+
access - +Variable in class com.soundcloud.api.Token +
  +
ACCESS_TOKEN - +Static variable in class com.soundcloud.api.Token +
  +
add(String, Object) - +Method in class com.soundcloud.api.Request +
Adds a key value pair +
addAcceptHeader(HttpRequest) - +Method in class com.soundcloud.api.ApiWrapper +
Forces JSON +
addAuthHeader(HttpRequest) - +Method in class com.soundcloud.api.ApiWrapper +
Adds an OAuth2 header to a given request +
addHeaders(HttpRequest) - +Method in class com.soundcloud.api.ApiWrapper +
Adds all required headers to the request +
ApiWrapper - Class in com.soundcloud.api
Interface with SoundCloud, using OAuth2.
ApiWrapper(String, String, URI, Token, Env) - +Constructor for class com.soundcloud.api.ApiWrapper +
Constructs a new ApiWrapper instance. +
ARTWORK_DATA - +Static variable in interface com.soundcloud.api.Params.Track +
  +
ASSET_DATA - +Static variable in interface com.soundcloud.api.Params.Track +
  +
AUTHORIZATION_CODE - +Static variable in interface com.soundcloud.api.CloudAPI +
  +
authorizationCode(String) - +Method in class com.soundcloud.api.ApiWrapper +
  +
authorizationCode(String) - +Method in interface com.soundcloud.api.CloudAPI +
Request a token using + Authorization Code. +
authorizationCodeUrl(String...) - +Method in class com.soundcloud.api.ApiWrapper +
  +
authorizationCodeUrl(String...) - +Method in interface com.soundcloud.api.CloudAPI +
Request login via authorization code + After login, control will go to the redirect URI (wrapper specific), with + one of the following query parameters appended: + + code in case of success, this will contain the code used for the + authorizationCode call to obtain the access token. +
authResourceHost - +Variable in enum com.soundcloud.api.Env +
  +
AVATAR - +Static variable in interface com.soundcloud.api.Params.User +
  +
+
+

+B

+
+
BODY - +Static variable in interface com.soundcloud.api.Params.Comment +
  +
BPM - +Static variable in interface com.soundcloud.api.Params.Track +
  +
BUFFER_SIZE - +Static variable in class com.soundcloud.api.Http +
  +
buildRequest(Class<T>) - +Method in class com.soundcloud.api.Request +
Builds a request with the given set of parameters and files. +
+
+

+C

+
+
CITY - +Static variable in interface com.soundcloud.api.Params.User +
  +
CLIENT_CREDENTIALS - +Static variable in interface com.soundcloud.api.CloudAPI +
  +
clientCredentials() - +Method in class com.soundcloud.api.ApiWrapper +
  +
clientCredentials() - +Method in interface com.soundcloud.api.CloudAPI +
Request a "signup" token using + Client Credentials. +
CloudAPI - Interface in com.soundcloud.api
Interface with SoundCloud, using OAuth2.
CloudAPI.InvalidTokenException - Exception in com.soundcloud.api
Thrown when token is not valid.
CloudAPI.InvalidTokenException(int, String) - +Constructor for exception com.soundcloud.api.CloudAPI.InvalidTokenException +
  +
CloudAPI.TokenListener - Interface in com.soundcloud.api
Interested in changes to the current token.
com.soundcloud.api - package com.soundcloud.api
Provides an API Wrapper to access the + SoundCloud API.
CONNECT - +Static variable in interface com.soundcloud.api.Endpoints +
  +
createOAuthHeader(Token) - +Static method in class com.soundcloud.api.ApiWrapper +
Creates an OAuth2 header for the given token +
+
+

+D

+
+
defaultParams() - +Static method in class com.soundcloud.api.Http +
  +
delete(Request) - +Method in class com.soundcloud.api.ApiWrapper +
  +
delete(Request) - +Method in interface com.soundcloud.api.CloudAPI +
  +
DESCRIPTION - +Static variable in interface com.soundcloud.api.Params.Track +
  +
DESCRIPTION - +Static variable in interface com.soundcloud.api.Params.User +
  +
DISCOGS_NAME - +Static variable in interface com.soundcloud.api.Params.User +
  +
DOWNLOADABLE - +Static variable in interface com.soundcloud.api.Params.Track +
  +
+
+

+E

+
+
EMAIL - +Static variable in interface com.soundcloud.api.Params.User +
  +
Endpoints - Interface in com.soundcloud.api
Various SoundCloud API endpoints.
env - +Variable in class com.soundcloud.api.ApiWrapper +
The current environment +
Env - Enum in com.soundcloud.api
The environment to operate against.
equals(Object) - +Method in class com.soundcloud.api.Token +
  +
exchangeOAuth1Token(String) - +Method in class com.soundcloud.api.ApiWrapper +
  +
exchangeOAuth1Token(String) - +Method in interface com.soundcloud.api.CloudAPI +
Exchange an OAuth1 Token for new OAuth2 tokens. +
execute(HttpRequest) - +Method in class com.soundcloud.api.ApiWrapper +
Execute an API request, adds the necessary headers. +
EXPIRES_IN - +Static variable in class com.soundcloud.api.Token +
  +
expiresIn - +Variable in class com.soundcloud.api.Token +
  +
+
+

+F

+
+
FACEBOOK_CONNECT - +Static variable in interface com.soundcloud.api.Endpoints +
  +
fromFile(File) - +Static method in class com.soundcloud.api.ApiWrapper +
Read wrapper from a file +
FULLNAME - +Static variable in interface com.soundcloud.api.Params.User +
  +
+
+

+G

+
+
GENRE - +Static variable in interface com.soundcloud.api.Params.Track +
  +
get(Request) - +Method in class com.soundcloud.api.ApiWrapper +
  +
get(Request) - +Method in interface com.soundcloud.api.CloudAPI +
  +
getAuthResourceHost(boolean) - +Method in enum com.soundcloud.api.Env +
  +
getExpiresIn() - +Method in class com.soundcloud.api.Token +
  +
getHttpClient() - +Method in class com.soundcloud.api.ApiWrapper +
  +
getJSON(HttpResponse) - +Static method in class com.soundcloud.api.Http +
  +
getParams() - +Method in class com.soundcloud.api.ApiWrapper +
  +
getRequestDirector(HttpRequestExecutor, ClientConnectionManager, ConnectionReuseStrategy, ConnectionKeepAliveStrategy, HttpRoutePlanner, HttpProcessor, HttpRequestRetryHandler, RedirectHandler, AuthenticationHandler, AuthenticationHandler, UserTokenHandler, HttpParams) - +Method in class com.soundcloud.api.ApiWrapper +
This method mainly exists to make the wrapper more testable. +
getResourceHost(boolean) - +Method in enum com.soundcloud.api.Env +
  +
getSocketFactory() - +Method in class com.soundcloud.api.ApiWrapper +
  +
getSSLSocketFactory() - +Method in class com.soundcloud.api.ApiWrapper +
  +
getString(HttpResponse) - +Static method in class com.soundcloud.api.Http +
Returns a String representation of the response +
getToken() - +Method in class com.soundcloud.api.ApiWrapper +
  +
getToken() - +Method in interface com.soundcloud.api.CloudAPI +
  +
getURI(Request, boolean, boolean) - +Method in class com.soundcloud.api.ApiWrapper +
Constructs URI path for a given resource. +
getUserAgent() - +Method in class com.soundcloud.api.ApiWrapper +
User-Agent to identify ourselves with - defaults to USER_AGENT +
+
+

+H

+
+
hashCode() - +Method in class com.soundcloud.api.Token +
  +
Http - Class in com.soundcloud.api
Helper class for various HTTP related functions.
+
+

+I

+
+
invalidate() - +Method in class com.soundcloud.api.Token +
Invalidates the access token +
invalidateToken() - +Method in class com.soundcloud.api.ApiWrapper +
  +
invalidateToken() - +Method in interface com.soundcloud.api.CloudAPI +
This method should be called when the token was found to be invalid. +
ISRC - +Static variable in interface com.soundcloud.api.Params.Track +
  +
iterator() - +Method in class com.soundcloud.api.Request +
  +
+
+

+K

+
+
KEY_SIGNATURE - +Static variable in interface com.soundcloud.api.Params.Track +
  +
+
+

+L

+
+
LABEL_ID - +Static variable in interface com.soundcloud.api.Params.Track +
  +
LABEL_NAME - +Static variable in interface com.soundcloud.api.Params.Track +
  +
LICENSE - +Static variable in interface com.soundcloud.api.Params.Track +
  +
login(String, String) - +Method in class com.soundcloud.api.ApiWrapper +
  +
login(String, String) - +Method in interface com.soundcloud.api.CloudAPI +
Request a token using + Resource Owner Password Credentials. +
+
+

+M

+
+
MY_ACTIVITIES - +Static variable in interface com.soundcloud.api.Endpoints +
  +
MY_CONFIRMATION - +Static variable in interface com.soundcloud.api.Endpoints +
  +
MY_CONNECTIONS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
MY_DETAILS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
MY_EXCLUSIVE_TRACKS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
MY_FAVORITE - +Static variable in interface com.soundcloud.api.Endpoints +
  +
MY_FAVORITES - +Static variable in interface com.soundcloud.api.Endpoints +
  +
MY_FOLLOWER - +Static variable in interface com.soundcloud.api.Endpoints +
  +
MY_FOLLOWERS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
MY_FOLLOWING - +Static variable in interface com.soundcloud.api.Endpoints +
  +
MY_FOLLOWINGS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
MY_PLAYLISTS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
MY_TRACKS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
MYSPACE_NAME - +Static variable in interface com.soundcloud.api.Params.User +
  +
+
+

+N

+
+
NAME - +Static variable in interface com.soundcloud.api.Params.User +
  +
+
+

+O

+
+
OAUTH1_TOKEN - +Static variable in interface com.soundcloud.api.CloudAPI +
  +
OAUTH_SCHEME - +Static variable in interface com.soundcloud.api.CloudAPI +
  +
onTokenInvalid(Token) - +Method in interface com.soundcloud.api.CloudAPI.TokenListener +
Called when token was found to be invalid +
onTokenRefreshed(Token) - +Method in interface com.soundcloud.api.CloudAPI.TokenListener +
Called when the token got successfully refreshed +
+
+

+P

+
+
Params - Interface in com.soundcloud.api
Request parameters for various objects.
Params.Comment - Interface in com.soundcloud.api
Comments
Params.Track - Interface in com.soundcloud.api
Tracks
Params.User - Interface in com.soundcloud.api
Users
PASSWORD - +Static variable in interface com.soundcloud.api.CloudAPI +
  +
PASSWORD - +Static variable in interface com.soundcloud.api.Params.User +
  +
PASSWORD_CONFIRMATION - +Static variable in interface com.soundcloud.api.Params.User +
  +
PERMALINK - +Static variable in interface com.soundcloud.api.Params.Track +
  +
PERMALINK - +Static variable in interface com.soundcloud.api.Params.User +
  +
post(Request) - +Method in class com.soundcloud.api.ApiWrapper +
  +
post(Request) - +Method in interface com.soundcloud.api.CloudAPI +
  +
POST_TO - +Static variable in interface com.soundcloud.api.Params.Track +
  +
POST_TO_EMPTY - +Static variable in interface com.soundcloud.api.Params.Track +
  +
PRIVATE - +Static variable in interface com.soundcloud.api.Params.Track +
  +
PUBLIC - +Static variable in interface com.soundcloud.api.Params.Track +
  +
PURCHASE_URL - +Static variable in interface com.soundcloud.api.Params.Track +
  +
put(Request) - +Method in class com.soundcloud.api.ApiWrapper +
  +
put(Request) - +Method in interface com.soundcloud.api.CloudAPI +
  +
+
+

+Q

+
+
queryString() - +Method in class com.soundcloud.api.Request +
  +
+
+

+R

+
+
REALM - +Static variable in interface com.soundcloud.api.CloudAPI +
  +
refresh - +Variable in class com.soundcloud.api.Token +
  +
REFRESH_TOKEN - +Static variable in interface com.soundcloud.api.CloudAPI +
  +
REFRESH_TOKEN - +Static variable in class com.soundcloud.api.Token +
  +
refreshToken() - +Method in class com.soundcloud.api.ApiWrapper +
  +
refreshToken() - +Method in interface com.soundcloud.api.CloudAPI +
Tries to refresh the currently used access token with the refresh token. +
RELEASE - +Static variable in interface com.soundcloud.api.Params.Track +
  +
RELEASE_DAY - +Static variable in interface com.soundcloud.api.Params.Track +
  +
RELEASE_MONTH - +Static variable in interface com.soundcloud.api.Params.Track +
  +
RELEASE_YEAR - +Static variable in interface com.soundcloud.api.Params.Track +
  +
REPLY_TO - +Static variable in interface com.soundcloud.api.Params.Comment +
  +
Request - Class in com.soundcloud.api
Convenience class for constructing HTTP requests.
Request() - +Constructor for class com.soundcloud.api.Request +
Empty request +
Request(String) - +Constructor for class com.soundcloud.api.Request +
  +
Request.TransferProgressListener - Interface in com.soundcloud.api
Updates about the amount of bytes already transferred.
requestToken(Request) - +Method in class com.soundcloud.api.ApiWrapper +
Request an OAuth2 token from SoundCloud +
resolve(String) - +Method in class com.soundcloud.api.ApiWrapper +
  +
resolve(String) - +Method in interface com.soundcloud.api.CloudAPI +
Resolve the given SoundCloud URI +
RESOLVE - +Static variable in interface com.soundcloud.api.Endpoints +
  +
resourceHost - +Variable in enum com.soundcloud.api.Env +
  +
+
+

+S

+
+
SCOPE - +Static variable in class com.soundcloud.api.Token +
  +
scope - +Variable in class com.soundcloud.api.Token +
  +
SCOPE_SIGNUP - +Static variable in class com.soundcloud.api.Token +
  +
SEND_PASSWORD - +Static variable in interface com.soundcloud.api.Endpoints +
  +
setProgressListener(Request.TransferProgressListener) - +Method in class com.soundcloud.api.Request +
  +
setToken(Token) - +Method in class com.soundcloud.api.ApiWrapper +
  +
setToken(Token) - +Method in interface com.soundcloud.api.CloudAPI +
  +
setTokenListener(CloudAPI.TokenListener) - +Method in class com.soundcloud.api.ApiWrapper +
  +
setTokenListener(CloudAPI.TokenListener) - +Method in interface com.soundcloud.api.CloudAPI +
Registers a listener. +
SHARED_EMAILS - +Static variable in interface com.soundcloud.api.Params.Track +
  +
SHARING - +Static variable in interface com.soundcloud.api.Params.Track +
  +
SHARING_NOTE - +Static variable in interface com.soundcloud.api.Params.Track +
  +
signupScoped() - +Method in class com.soundcloud.api.Token +
  +
size() - +Method in class com.soundcloud.api.Request +
  +
sslAuthResourceHost - +Variable in enum com.soundcloud.api.Env +
  +
sslResourceHost - +Variable in enum com.soundcloud.api.Env +
  +
starScoped() - +Method in class com.soundcloud.api.Token +
  +
STREAMABLE - +Static variable in interface com.soundcloud.api.Params.Track +
  +
+
+

+T

+
+
TAG_LIST - +Static variable in interface com.soundcloud.api.Params.Track +
  +
TERMS_OF_USE - +Static variable in interface com.soundcloud.api.Params.User +
  +
TIMEOUT - +Static variable in class com.soundcloud.api.Http +
Connection timeout +
TIMESTAMP - +Static variable in interface com.soundcloud.api.Params.Comment +
  +
TITLE - +Static variable in interface com.soundcloud.api.Params.Track +
  +
to(String, Object...) - +Static method in class com.soundcloud.api.Request +
  +
toFile(File) - +Method in class com.soundcloud.api.ApiWrapper +
serialize the wrapper to a File +
TOKEN - +Static variable in interface com.soundcloud.api.Endpoints +
  +
Token - Class in com.soundcloud.api
Represents an OAuth2 access/refresh token pair.
Token(String, String) - +Constructor for class com.soundcloud.api.Token +
Constructs a new token with the given sub-tokens +
Token(JSONObject) - +Constructor for class com.soundcloud.api.Token +
Construct a new token from a JSON response +
toString() - +Method in class com.soundcloud.api.Request +
  +
toString() - +Method in class com.soundcloud.api.Token +
  +
toUrl(String) - +Method in class com.soundcloud.api.Request +
  +
toUrl() - +Method in class com.soundcloud.api.Request +
  +
TRACK_COMMENTS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
TRACK_DETAILS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
TRACKS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
transferred(long) - +Method in interface com.soundcloud.api.Request.TransferProgressListener +
  +
TYPE - +Static variable in interface com.soundcloud.api.Params.Track +
  +
+
+

+U

+
+
USER_AGENT - +Static variable in interface com.soundcloud.api.CloudAPI +
  +
USER_DETAILS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
USER_FAVORITES - +Static variable in interface com.soundcloud.api.Endpoints +
  +
USER_FOLLOWERS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
USER_FOLLOWINGS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
USER_PLAYLISTS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
USER_TRACKS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
USERS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
usingToken(Token) - +Method in class com.soundcloud.api.Request +
The request should be made with a specific token. +
+
+

+V

+
+
valid() - +Method in class com.soundcloud.api.Token +
  +
valueOf(String) - +Static method in enum com.soundcloud.api.Env +
Returns the enum constant of this type with the specified name. +
values() - +Static method in enum com.soundcloud.api.Env +
Returns an array containing the constants of this enum type, in +the order they are declared. +
VERSION - +Static variable in interface com.soundcloud.api.CloudAPI +
  +
VIDEO_URL - +Static variable in interface com.soundcloud.api.Params.Track +
  +
+
+

+W

+
+
WEBSITE - +Static variable in interface com.soundcloud.api.Params.User +
  +
WEBSITE_TITLE - +Static variable in interface com.soundcloud.api.Params.User +
  +
with(Object...) - +Method in class com.soundcloud.api.Request +
  +
withFile(String, File) - +Method in class com.soundcloud.api.Request +
Registers a file to be uploaded with a POST or PUT request. +
+
+A B C D E F G H I K L M N O P Q R S T U V W + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree  Deprecated   Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/javadoc/1.0.0/index.html b/javadoc/1.0.0/index.html new file mode 100644 index 0000000..a12c57f --- /dev/null +++ b/javadoc/1.0.0/index.html @@ -0,0 +1,36 @@ + + + + + + +SoundCloud Java API Wrapper 1.0.0 + + + + + + + + +<H2> +Frame Alert</H2> + +<P> +This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +<BR> +Link to<A HREF="com/soundcloud/api/package-summary.html">Non-frame version.</A> + + + diff --git a/javadoc/1.0.0/overview-tree.html b/javadoc/1.0.0/overview-tree.html new file mode 100644 index 0000000..1457da1 --- /dev/null +++ b/javadoc/1.0.0/overview-tree.html @@ -0,0 +1,173 @@ + + + + + + +Class Hierarchy (SoundCloud Java API Wrapper 1.0.0) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For All Packages

+
+
+
Package Hierarchies:
com.soundcloud.api
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +

+Enum Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/javadoc/1.0.0/package-list b/javadoc/1.0.0/package-list new file mode 100644 index 0000000..149e54d --- /dev/null +++ b/javadoc/1.0.0/package-list @@ -0,0 +1 @@ +com.soundcloud.api diff --git a/javadoc/1.0.0/resources/inherit.gif b/javadoc/1.0.0/resources/inherit.gif new file mode 100644 index 0000000000000000000000000000000000000000..c814867a13deb0ca7ea2156c6ca1d5a03372af7e GIT binary patch literal 57 zcmZ?wbhEHbIIT!9-C*e{wE9>Kx3D)-;0v)C; KYxQGgum%9JOA&7X literal 0 HcmV?d00001 diff --git a/javadoc/1.0.0/serialized-form.html b/javadoc/1.0.0/serialized-form.html new file mode 100644 index 0000000..7ed999a --- /dev/null +++ b/javadoc/1.0.0/serialized-form.html @@ -0,0 +1,287 @@ + + + + + + +Serialized Form (SoundCloud Java API Wrapper 1.0.0) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Serialized Form

+
+
+ + + + + +
+Package com.soundcloud.api
+ +

+ + + + + +
+Class com.soundcloud.api.ApiWrapper extends java.lang.Object implements Serializable
+ +

+serialVersionUID: 3662083416905771921L + +

+ + + + + +
+Serialized Fields
+ +

+env

+
+Env env
+
+
The current environment +

+

+
+
+
+

+mToken

+
+Token mToken
+
+
+
+
+
+

+mClientId

+
+java.lang.String mClientId
+
+
+
+
+
+

+mClientSecret

+
+java.lang.String mClientSecret
+
+
+
+
+
+

+mRedirectUri

+
+java.net.URI mRedirectUri
+
+
+
+
+ +

+ + + + + +
+Class com.soundcloud.api.CloudAPI.InvalidTokenException extends java.io.IOException implements Serializable
+ +

+serialVersionUID: 1954919760451539868L + +

+ +

+ + + + + +
+Class com.soundcloud.api.Token extends java.lang.Object implements Serializable
+ +

+serialVersionUID: 766168501082045382L + +

+ + + + + +
+Serialized Fields
+ +

+access

+
+java.lang.String access
+
+
+
+
+
+

+refresh

+
+java.lang.String refresh
+
+
+
+
+
+

+scope

+
+java.lang.String scope
+
+
+
+
+
+

+expiresIn

+
+long expiresIn
+
+
+
+
+ +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/javadoc/1.0.0/stylesheet.css b/javadoc/1.0.0/stylesheet.css new file mode 100644 index 0000000..6ea9e51 --- /dev/null +++ b/javadoc/1.0.0/stylesheet.css @@ -0,0 +1,29 @@ +/* Javadoc style sheet */ + +/* Define colors, fonts and other style attributes here to override the defaults */ + +/* Page background color */ +body { background-color: #FFFFFF; color:#000000 } + +/* Headings */ +h1 { font-size: 145% } + +/* Table colors */ +.TableHeadingColor { background: #CCCCFF; color:#000000 } /* Dark mauve */ +.TableSubHeadingColor { background: #EEEEFF; color:#000000 } /* Light mauve */ +.TableRowColor { background: #FFFFFF; color:#000000 } /* White */ + +/* Font used in left-hand frame lists */ +.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } + +/* Navigation bar fonts and colors */ +.NavBarCell1 { background-color:#EEEEFF; color:#000000} /* Light mauve */ +.NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */ +.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;} +.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;} + +.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} + From cac7f1b334d71b068074c0fa9301f39afe5c3446 Mon Sep 17 00:00:00 2001 From: Jan Berkel Date: Tue, 24 May 2011 15:28:20 +0200 Subject: [PATCH 3/4] javadocs for 1.0.0 --- javadoc/1.0.0/allclasses-frame.html | 4 +- javadoc/1.0.0/allclasses-noframe.html | 4 +- .../1.0.0/com/soundcloud/api/ApiWrapper.html | 41 +++++++++- .../api/CloudAPI.InvalidTokenException.html | 4 +- .../api/CloudAPI.TokenListener.html | 4 +- .../1.0.0/com/soundcloud/api/CloudAPI.html | 37 ++++++++- .../1.0.0/com/soundcloud/api/Endpoints.html | 4 +- javadoc/1.0.0/com/soundcloud/api/Env.html | 4 +- javadoc/1.0.0/com/soundcloud/api/Http.html | 4 +- .../com/soundcloud/api/Params.Comment.html | 4 +- .../com/soundcloud/api/Params.Track.html | 4 +- .../1.0.0/com/soundcloud/api/Params.User.html | 4 +- javadoc/1.0.0/com/soundcloud/api/Params.html | 4 +- .../api/Request.TransferProgressListener.html | 4 +- javadoc/1.0.0/com/soundcloud/api/Request.html | 20 ++--- javadoc/1.0.0/com/soundcloud/api/Token.html | 75 ++++++++++++++++--- .../com/soundcloud/api/package-frame.html | 4 +- .../com/soundcloud/api/package-summary.html | 4 +- .../com/soundcloud/api/package-tree.html | 4 +- javadoc/1.0.0/constant-values.html | 16 +++- javadoc/1.0.0/deprecated-list.html | 4 +- javadoc/1.0.0/help-doc.html | 4 +- javadoc/1.0.0/index-all.html | 26 +++++-- javadoc/1.0.0/index.html | 2 +- javadoc/1.0.0/overview-tree.html | 4 +- javadoc/1.0.0/serialized-form.html | 4 +- 26 files changed, 224 insertions(+), 69 deletions(-) diff --git a/javadoc/1.0.0/allclasses-frame.html b/javadoc/1.0.0/allclasses-frame.html index 622afaa..5765759 100644 --- a/javadoc/1.0.0/allclasses-frame.html +++ b/javadoc/1.0.0/allclasses-frame.html @@ -2,12 +2,12 @@ - + All Classes (SoundCloud Java API Wrapper 1.0.0) - + diff --git a/javadoc/1.0.0/allclasses-noframe.html b/javadoc/1.0.0/allclasses-noframe.html index 90558d3..85fb67e 100644 --- a/javadoc/1.0.0/allclasses-noframe.html +++ b/javadoc/1.0.0/allclasses-noframe.html @@ -2,12 +2,12 @@ - + All Classes (SoundCloud Java API Wrapper 1.0.0) - + diff --git a/javadoc/1.0.0/com/soundcloud/api/ApiWrapper.html b/javadoc/1.0.0/com/soundcloud/api/ApiWrapper.html index 085b907..4653036 100644 --- a/javadoc/1.0.0/com/soundcloud/api/ApiWrapper.html +++ b/javadoc/1.0.0/com/soundcloud/api/ApiWrapper.html @@ -2,12 +2,12 @@ - + ApiWrapper (SoundCloud Java API Wrapper 1.0.0) - + @@ -259,6 +259,15 @@

+ Token +clientCredentials(java.lang.String scope) + +
+          Requests a token using + Client Credentials. + + + static Header createOAuthHeader(Token token) @@ -608,6 +617,34 @@

+

+clientCredentials

+
+public Token clientCredentials(java.lang.String scope)
+                        throws java.io.IOException
+
+
Description copied from interface: CloudAPI
+
Requests a token using + Client Credentials. + + Note that this token is not set as the current token in the wrapper - it should only be used + for one request (typically the signup / user creation request). + Also note that not all apps are allowed to request for all scopes (the wrapper throws + InvalidTokenException in this case). +

+

+
Specified by:
clientCredentials in interface CloudAPI
+
+
+
Parameters:
scope - the requested scope +
Returns:
a valid token +
Throws: +
java.io.IOException - IO/Error +
CloudAPI.InvalidTokenException - if requested scope is not available
+
+
+
+

refreshToken

diff --git a/javadoc/1.0.0/com/soundcloud/api/CloudAPI.InvalidTokenException.html b/javadoc/1.0.0/com/soundcloud/api/CloudAPI.InvalidTokenException.html
index 1f52a7f..272d96a 100644
--- a/javadoc/1.0.0/com/soundcloud/api/CloudAPI.InvalidTokenException.html
+++ b/javadoc/1.0.0/com/soundcloud/api/CloudAPI.InvalidTokenException.html
@@ -2,12 +2,12 @@
 
 
 
-
+
 
 CloudAPI.InvalidTokenException (SoundCloud Java API Wrapper 1.0.0)
 
 
-
+
 
 
 
diff --git a/javadoc/1.0.0/com/soundcloud/api/CloudAPI.TokenListener.html b/javadoc/1.0.0/com/soundcloud/api/CloudAPI.TokenListener.html
index 45f9436..aa2b107 100644
--- a/javadoc/1.0.0/com/soundcloud/api/CloudAPI.TokenListener.html
+++ b/javadoc/1.0.0/com/soundcloud/api/CloudAPI.TokenListener.html
@@ -2,12 +2,12 @@
 
 
 
-
+
 
 CloudAPI.TokenListener (SoundCloud Java API Wrapper 1.0.0)
 
 
-
+
 
 
 
diff --git a/javadoc/1.0.0/com/soundcloud/api/CloudAPI.html b/javadoc/1.0.0/com/soundcloud/api/CloudAPI.html
index c15d8cc..2d851f5 100644
--- a/javadoc/1.0.0/com/soundcloud/api/CloudAPI.html
+++ b/javadoc/1.0.0/com/soundcloud/api/CloudAPI.html
@@ -2,12 +2,12 @@
 
 
 
-
+
 
 CloudAPI (SoundCloud Java API Wrapper 1.0.0)
 
 
-
+
 
 
 
@@ -257,6 +257,15 @@ 

 
 
 
+ Token
+clientCredentials(java.lang.String scope)
+
+

+          Requests a token using 
+ Client Credentials.
+
+
+
  HttpResponse
 delete(Request request)
 
@@ -529,6 +538,30 @@ 

 
 

 
+

+clientCredentials

+
+Token clientCredentials(java.lang.String scope)
+                        throws java.io.IOException

+

+
Requests a token using 
+ Client Credentials.
+
+ Note that this token is not set as the current token in the wrapper - it should only be used
+ for one request (typically the signup / user creation request).
+ Also note that not all apps are allowed to request for all scopes (the wrapper throws
+ InvalidTokenException in this case).
+

+

+
Parameters:
scope - the requested scope
+
Returns:
a valid token
+
Throws:
+
java.io.IOException - IO/Error
+
CloudAPI.InvalidTokenException - if requested scope is not available

+

+

+

+
 

 refreshToken

 
diff --git a/javadoc/1.0.0/com/soundcloud/api/Endpoints.html b/javadoc/1.0.0/com/soundcloud/api/Endpoints.html
index 9680c1b..db26a68 100644
--- a/javadoc/1.0.0/com/soundcloud/api/Endpoints.html
+++ b/javadoc/1.0.0/com/soundcloud/api/Endpoints.html
@@ -2,12 +2,12 @@
 
 
 
-
+
 
 Endpoints (SoundCloud Java API Wrapper 1.0.0)
 
 
-
+
 
 
 
diff --git a/javadoc/1.0.0/com/soundcloud/api/Env.html b/javadoc/1.0.0/com/soundcloud/api/Env.html
index 34ffda7..bd69b40 100644
--- a/javadoc/1.0.0/com/soundcloud/api/Env.html
+++ b/javadoc/1.0.0/com/soundcloud/api/Env.html
@@ -2,12 +2,12 @@
 
 
 
-
+
 
 Env (SoundCloud Java API Wrapper 1.0.0)
 
 
-
+
 
 
 
diff --git a/javadoc/1.0.0/com/soundcloud/api/Http.html b/javadoc/1.0.0/com/soundcloud/api/Http.html
index e03ad6d..20dc941 100644
--- a/javadoc/1.0.0/com/soundcloud/api/Http.html
+++ b/javadoc/1.0.0/com/soundcloud/api/Http.html
@@ -2,12 +2,12 @@
 
 
 
-
+
 
 Http (SoundCloud Java API Wrapper 1.0.0)
 
 
-
+
 
 
 
diff --git a/javadoc/1.0.0/com/soundcloud/api/Params.Comment.html b/javadoc/1.0.0/com/soundcloud/api/Params.Comment.html
index e3561aa..7733290 100644
--- a/javadoc/1.0.0/com/soundcloud/api/Params.Comment.html
+++ b/javadoc/1.0.0/com/soundcloud/api/Params.Comment.html
@@ -2,12 +2,12 @@
 
 
 
-
+
 
 Params.Comment (SoundCloud Java API Wrapper 1.0.0)
 
 
-
+
 
 
 
diff --git a/javadoc/1.0.0/com/soundcloud/api/Params.Track.html b/javadoc/1.0.0/com/soundcloud/api/Params.Track.html
index 9054ff2..def7476 100644
--- a/javadoc/1.0.0/com/soundcloud/api/Params.Track.html
+++ b/javadoc/1.0.0/com/soundcloud/api/Params.Track.html
@@ -2,12 +2,12 @@
 
 
 
-
+
 
 Params.Track (SoundCloud Java API Wrapper 1.0.0)
 
 
-
+
 
 
 
diff --git a/javadoc/1.0.0/com/soundcloud/api/Params.User.html b/javadoc/1.0.0/com/soundcloud/api/Params.User.html
index 5a1ddd8..f3dc4ad 100644
--- a/javadoc/1.0.0/com/soundcloud/api/Params.User.html
+++ b/javadoc/1.0.0/com/soundcloud/api/Params.User.html
@@ -2,12 +2,12 @@
 
 
 
-
+
 
 Params.User (SoundCloud Java API Wrapper 1.0.0)
 
 
-
+
 
 
 
diff --git a/javadoc/1.0.0/com/soundcloud/api/Params.html b/javadoc/1.0.0/com/soundcloud/api/Params.html
index 3e3af08..38269d3 100644
--- a/javadoc/1.0.0/com/soundcloud/api/Params.html
+++ b/javadoc/1.0.0/com/soundcloud/api/Params.html
@@ -2,12 +2,12 @@
 
 
 
-
+
 
 Params (SoundCloud Java API Wrapper 1.0.0)
 
 
-
+
 
 
 
diff --git a/javadoc/1.0.0/com/soundcloud/api/Request.TransferProgressListener.html b/javadoc/1.0.0/com/soundcloud/api/Request.TransferProgressListener.html
index 46e79ce..5ad8e5c 100644
--- a/javadoc/1.0.0/com/soundcloud/api/Request.TransferProgressListener.html
+++ b/javadoc/1.0.0/com/soundcloud/api/Request.TransferProgressListener.html
@@ -2,12 +2,12 @@
 
 
 
-
+
 
 Request.TransferProgressListener (SoundCloud Java API Wrapper 1.0.0)
 
 
-
+
 
 
 
diff --git a/javadoc/1.0.0/com/soundcloud/api/Request.html b/javadoc/1.0.0/com/soundcloud/api/Request.html
index f659c04..4a8c12b 100644
--- a/javadoc/1.0.0/com/soundcloud/api/Request.html
+++ b/javadoc/1.0.0/com/soundcloud/api/Request.html
@@ -2,12 +2,12 @@
 
 
 
-
+
 
 Request (SoundCloud Java API Wrapper 1.0.0)
 
 
-
+
 
 
 
@@ -515,13 +515,13 @@ 

 
 

 
-

-toString

+

+iterator

 
-public java.lang.String toString()

+public java.util.Iterator<NameValuePair> iterator()

 

 

-
Overrides:
toString in class java.lang.Object

+
Specified by:
iterator in interface java.lang.Iterable<NameValuePair>

 
 

 

@@ -529,13 +529,13 @@ 

 
 

 
-

-iterator

+

+toString

 
-public java.util.Iterator<NameValuePair> iterator()

+public java.lang.String toString()
-
Specified by:
iterator in interface java.lang.Iterable<NameValuePair>
+
Overrides:
toString in class java.lang.Object
diff --git a/javadoc/1.0.0/com/soundcloud/api/Token.html b/javadoc/1.0.0/com/soundcloud/api/Token.html index f386876..2ea35bc 100644 --- a/javadoc/1.0.0/com/soundcloud/api/Token.html +++ b/javadoc/1.0.0/com/soundcloud/api/Token.html @@ -2,12 +2,12 @@ - + Token (SoundCloud Java API Wrapper 1.0.0) - + @@ -180,6 +180,22 @@

static java.lang.String SCOPE +
+            + + + +static java.lang.String +SCOPE_DEFAULT + +
+            + + + +static java.lang.String +SCOPE_PLAYCOUNT +
            @@ -227,6 +243,14 @@

 boolean +defaultScoped() + +
+            + + + + boolean equals(java.lang.Object o)
@@ -259,7 +283,7 @@

 boolean -signupScoped() +scoped(java.lang.String scope)
            @@ -267,7 +291,7 @@

 boolean -starScoped() +signupScoped()
            @@ -351,6 +375,16 @@

+

+SCOPE_DEFAULT

+
+public static final java.lang.String SCOPE_DEFAULT
+
+
+
See Also:
Constant Field Values
+
+
+

SCOPE_SIGNUP

@@ -361,6 +395,16 @@ 

 
 

 
+

+SCOPE_PLAYCOUNT

+
+public static final java.lang.String SCOPE_PLAYCOUNT

+

+

+
See Also:
Constant Field Values

+

+

+
 

 access

 
@@ -479,17 +523,16 @@ 

 
 

 
-

-starScoped

+

+defaultScoped

 
-public boolean starScoped()

+public boolean defaultScoped()

 

 

 

 

 

-
-
Returns:
has token the wildcard scope ("*")

+
@@ -509,6 +552,20 @@

+

+scoped

+
+public boolean scoped(java.lang.String scope)
+
+
+
+
+
+
+
+
+
+

valid

diff --git a/javadoc/1.0.0/com/soundcloud/api/package-frame.html b/javadoc/1.0.0/com/soundcloud/api/package-frame.html
index 56e6c60..38ded1a 100644
--- a/javadoc/1.0.0/com/soundcloud/api/package-frame.html
+++ b/javadoc/1.0.0/com/soundcloud/api/package-frame.html
@@ -2,12 +2,12 @@
 
 
 
-
+
 
 com.soundcloud.api (SoundCloud Java API Wrapper 1.0.0)
 
 
-
+
 
 
 
diff --git a/javadoc/1.0.0/com/soundcloud/api/package-summary.html b/javadoc/1.0.0/com/soundcloud/api/package-summary.html
index 73ba61e..06324b0 100644
--- a/javadoc/1.0.0/com/soundcloud/api/package-summary.html
+++ b/javadoc/1.0.0/com/soundcloud/api/package-summary.html
@@ -2,12 +2,12 @@
 
 
 
-
+
 
 com.soundcloud.api (SoundCloud Java API Wrapper 1.0.0)
 
 
-
+
 
 
 
diff --git a/javadoc/1.0.0/com/soundcloud/api/package-tree.html b/javadoc/1.0.0/com/soundcloud/api/package-tree.html
index 793014a..64c7b65 100644
--- a/javadoc/1.0.0/com/soundcloud/api/package-tree.html
+++ b/javadoc/1.0.0/com/soundcloud/api/package-tree.html
@@ -2,12 +2,12 @@
 
 
 
-
+
 
 com.soundcloud.api Class Hierarchy (SoundCloud Java API Wrapper 1.0.0)
 
 
-
+
 
 
 
diff --git a/javadoc/1.0.0/constant-values.html b/javadoc/1.0.0/constant-values.html
index 277a404..fde7727 100644
--- a/javadoc/1.0.0/constant-values.html
+++ b/javadoc/1.0.0/constant-values.html
@@ -2,12 +2,12 @@
 
 
 
-
+
 
 Constant Field Values (SoundCloud Java API Wrapper 1.0.0)
 
 
-
+
 
 
 
@@ -707,6 +707,18 @@ 

 "scope"
 
 
+
+public static final java.lang.String
+SCOPE_DEFAULT
+"*"
+
+
+
+public static final java.lang.String
+SCOPE_PLAYCOUNT
+"playcount"
+
+
 
 public static final java.lang.String
 SCOPE_SIGNUP
diff --git a/javadoc/1.0.0/deprecated-list.html b/javadoc/1.0.0/deprecated-list.html
index e74a7a6..74492b1 100644
--- a/javadoc/1.0.0/deprecated-list.html
+++ b/javadoc/1.0.0/deprecated-list.html
@@ -2,12 +2,12 @@
 
 
 
-
+
 
 Deprecated List (SoundCloud Java API Wrapper 1.0.0)
 
 
-
+
 
 
 
diff --git a/javadoc/1.0.0/help-doc.html b/javadoc/1.0.0/help-doc.html
index c854a3b..0daf7df 100644
--- a/javadoc/1.0.0/help-doc.html
+++ b/javadoc/1.0.0/help-doc.html
@@ -2,12 +2,12 @@
 
 
 
-
+
 
 API Help (SoundCloud Java API Wrapper 1.0.0)
 
 
-
+
 
 
 
diff --git a/javadoc/1.0.0/index-all.html b/javadoc/1.0.0/index-all.html
index cf0c807..e797d37 100644
--- a/javadoc/1.0.0/index-all.html
+++ b/javadoc/1.0.0/index-all.html
@@ -2,12 +2,12 @@
 
 
 
-
+
 
 Index (SoundCloud Java API Wrapper 1.0.0)
 
 
-
+
 
 
 
@@ -165,10 +165,17 @@
 
clientCredentials() - 
 Method in class com.soundcloud.api.ApiWrapper
 
 
+
clientCredentials(String) - 
+Method in class com.soundcloud.api.ApiWrapper
+
 
 
clientCredentials() - 
 Method in interface com.soundcloud.api.CloudAPI
 
Request a "signup" token using 
  Client Credentials.
+
clientCredentials(String) - 
+Method in interface com.soundcloud.api.CloudAPI
+
Requests a token using 
+ Client Credentials.
 
CloudAPI - Interface in com.soundcloud.api
Interface with SoundCloud, using OAuth2.
CloudAPI.InvalidTokenException - Exception in com.soundcloud.api
Thrown when token is not valid.
CloudAPI.InvalidTokenException(int, String) - 
 Constructor for exception com.soundcloud.api.CloudAPI.InvalidTokenException
 
 
@@ -187,6 +194,9 @@
 
defaultParams() - 
 Static method in class com.soundcloud.api.Http
 
 
+
defaultScoped() - 
+Method in class com.soundcloud.api.Token
+
 
 
delete(Request) - 
 Method in class com.soundcloud.api.ApiWrapper
 
 
@@ -558,9 +568,18 @@
 
scope - 
 Variable in class com.soundcloud.api.Token
 
 
+
SCOPE_DEFAULT - 
+Static variable in class com.soundcloud.api.Token
+
 
+
SCOPE_PLAYCOUNT - 
+Static variable in class com.soundcloud.api.Token
+
 
 
SCOPE_SIGNUP - 
 Static variable in class com.soundcloud.api.Token
 
 
+
scoped(String) - 
+Method in class com.soundcloud.api.Token
+
 
 
SEND_PASSWORD - 
 Static variable in interface com.soundcloud.api.Endpoints
 
 
@@ -600,9 +619,6 @@
 
sslResourceHost - 
 Variable in enum com.soundcloud.api.Env
 
 
-
starScoped() - 
-Method in class com.soundcloud.api.Token
-
 
 
STREAMABLE - 
 Static variable in interface com.soundcloud.api.Params.Track
 
 
diff --git a/javadoc/1.0.0/index.html b/javadoc/1.0.0/index.html
index a12c57f..e00ac44 100644
--- a/javadoc/1.0.0/index.html
+++ b/javadoc/1.0.0/index.html
@@ -2,7 +2,7 @@
 
 
 
-
+
 
 SoundCloud Java API Wrapper 1.0.0
 
diff --git a/javadoc/1.0.0/overview-tree.html b/javadoc/1.0.0/overview-tree.html
index 1457da1..4d36737 100644
--- a/javadoc/1.0.0/overview-tree.html
+++ b/javadoc/1.0.0/overview-tree.html
@@ -2,12 +2,12 @@
 
 
 
-
+
 
 Class Hierarchy (SoundCloud Java API Wrapper 1.0.0)
 
 
-
+
 
 
 
diff --git a/javadoc/1.0.0/serialized-form.html b/javadoc/1.0.0/serialized-form.html
index 7ed999a..d0878d9 100644
--- a/javadoc/1.0.0/serialized-form.html
+++ b/javadoc/1.0.0/serialized-form.html
@@ -2,12 +2,12 @@
 
 
 
-
+
 
 Serialized Form (SoundCloud Java API Wrapper 1.0.0)
 
 
-
+
 
 
 

From 0ce2821090208f181b9d26174dacf45193d84269 Mon Sep 17 00:00:00 2001
From: Jan Berkel 
Date: Mon, 4 Jul 2011 19:09:51 +0200
Subject: [PATCH 4/4] javadocs for 1.0.1

---
 javadoc/1.0.1/allclasses-frame.html           |   57 +
 javadoc/1.0.1/allclasses-noframe.html         |   57 +
 .../1.0.1/com/soundcloud/api/ApiWrapper.html  | 1391 +++++++++++++++++
 .../api/CloudAPI.InvalidTokenException.html   |  248 +++
 .../api/CloudAPI.TokenListener.html           |  233 +++
 .../1.0.1/com/soundcloud/api/CloudAPI.html    |  899 +++++++++++
 .../1.0.1/com/soundcloud/api/Endpoints.html   |  728 +++++++++
 javadoc/1.0.1/com/soundcloud/api/Env.html     |  455 ++++++
 javadoc/1.0.1/com/soundcloud/api/Http.html    |  324 ++++
 .../com/soundcloud/api/Params.Comment.html    |  243 +++
 .../com/soundcloud/api/Params.Track.html      |  711 +++++++++
 .../1.0.1/com/soundcloud/api/Params.User.html |  441 ++++++
 javadoc/1.0.1/com/soundcloud/api/Params.html  |  201 +++
 .../api/Request.TransferProgressListener.html |  212 +++
 javadoc/1.0.1/com/soundcloud/api/Request.html |  749 +++++++++
 javadoc/1.0.1/com/soundcloud/api/Token.html   |  725 +++++++++
 .../com/soundcloud/api/package-frame.html     |   85 +
 .../com/soundcloud/api/package-summary.html   |  257 +++
 .../com/soundcloud/api/package-tree.html      |  171 ++
 javadoc/1.0.1/constant-values.html            |  824 ++++++++++
 javadoc/1.0.1/deprecated-list.html            |  142 ++
 javadoc/1.0.1/help-doc.html                   |  209 +++
 javadoc/1.0.1/index-all.html                  |  874 +++++++++++
 javadoc/1.0.1/index.html                      |   36 +
 javadoc/1.0.1/overview-tree.html              |  173 ++
 javadoc/1.0.1/package-list                    |    1 +
 javadoc/1.0.1/resources/inherit.gif           |  Bin 0 -> 57 bytes
 javadoc/1.0.1/serialized-form.html            |  307 ++++
 javadoc/1.0.1/stylesheet.css                  |   29 +
 29 files changed, 10782 insertions(+)
 create mode 100644 javadoc/1.0.1/allclasses-frame.html
 create mode 100644 javadoc/1.0.1/allclasses-noframe.html
 create mode 100644 javadoc/1.0.1/com/soundcloud/api/ApiWrapper.html
 create mode 100644 javadoc/1.0.1/com/soundcloud/api/CloudAPI.InvalidTokenException.html
 create mode 100644 javadoc/1.0.1/com/soundcloud/api/CloudAPI.TokenListener.html
 create mode 100644 javadoc/1.0.1/com/soundcloud/api/CloudAPI.html
 create mode 100644 javadoc/1.0.1/com/soundcloud/api/Endpoints.html
 create mode 100644 javadoc/1.0.1/com/soundcloud/api/Env.html
 create mode 100644 javadoc/1.0.1/com/soundcloud/api/Http.html
 create mode 100644 javadoc/1.0.1/com/soundcloud/api/Params.Comment.html
 create mode 100644 javadoc/1.0.1/com/soundcloud/api/Params.Track.html
 create mode 100644 javadoc/1.0.1/com/soundcloud/api/Params.User.html
 create mode 100644 javadoc/1.0.1/com/soundcloud/api/Params.html
 create mode 100644 javadoc/1.0.1/com/soundcloud/api/Request.TransferProgressListener.html
 create mode 100644 javadoc/1.0.1/com/soundcloud/api/Request.html
 create mode 100644 javadoc/1.0.1/com/soundcloud/api/Token.html
 create mode 100644 javadoc/1.0.1/com/soundcloud/api/package-frame.html
 create mode 100644 javadoc/1.0.1/com/soundcloud/api/package-summary.html
 create mode 100644 javadoc/1.0.1/com/soundcloud/api/package-tree.html
 create mode 100644 javadoc/1.0.1/constant-values.html
 create mode 100644 javadoc/1.0.1/deprecated-list.html
 create mode 100644 javadoc/1.0.1/help-doc.html
 create mode 100644 javadoc/1.0.1/index-all.html
 create mode 100644 javadoc/1.0.1/index.html
 create mode 100644 javadoc/1.0.1/overview-tree.html
 create mode 100644 javadoc/1.0.1/package-list
 create mode 100644 javadoc/1.0.1/resources/inherit.gif
 create mode 100644 javadoc/1.0.1/serialized-form.html
 create mode 100644 javadoc/1.0.1/stylesheet.css

diff --git a/javadoc/1.0.1/allclasses-frame.html b/javadoc/1.0.1/allclasses-frame.html
new file mode 100644
index 0000000..a21e367
--- /dev/null
+++ b/javadoc/1.0.1/allclasses-frame.html
@@ -0,0 +1,57 @@
+
+
+
+
+
+
+All Classes (SoundCloud Java API Wrapper 1.0.1)
+
+
+
+
+
+
+
+
+
+
+
+All Classes
+

+
+
+
+
+
+
ApiWrapper
+

+CloudAPI
+

+CloudAPI.InvalidTokenException
+

+CloudAPI.TokenListener
+

+Endpoints
+

+Env
+

+Http
+

+Params
+

+Params.Comment
+

+Params.Track
+

+Params.User
+

+Request
+

+Request.TransferProgressListener
+

+Token
+

+

+
+
+
diff --git a/javadoc/1.0.1/allclasses-noframe.html b/javadoc/1.0.1/allclasses-noframe.html
new file mode 100644
index 0000000..c84c5fb
--- /dev/null
+++ b/javadoc/1.0.1/allclasses-noframe.html
@@ -0,0 +1,57 @@
+
+
+
+
+
+
+All Classes (SoundCloud Java API Wrapper 1.0.1)
+
+
+
+
+
+
+
+
+
+
+
+All Classes
+

+
+
+
+
+
+
ApiWrapper
+

+CloudAPI
+

+CloudAPI.InvalidTokenException
+

+CloudAPI.TokenListener
+

+Endpoints
+

+Env
+

+Http
+

+Params
+

+Params.Comment
+

+Params.Track
+

+Params.User
+

+Request
+

+Request.TransferProgressListener
+

+Token
+

+

+
+
+
diff --git a/javadoc/1.0.1/com/soundcloud/api/ApiWrapper.html b/javadoc/1.0.1/com/soundcloud/api/ApiWrapper.html
new file mode 100644
index 0000000..d883a5b
--- /dev/null
+++ b/javadoc/1.0.1/com/soundcloud/api/ApiWrapper.html
@@ -0,0 +1,1391 @@
+
+
+
+
+
+
+ApiWrapper (SoundCloud Java API Wrapper 1.0.1)
+
+
+
+
+
+
+
+
+
+
+
+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+
+
+  
+  
+  
+  
+  
+  
+  
+  
+
    Package   Class     Tree     Deprecated     Index     Help 

+		
+
+

+ PREV CLASS 
+ NEXT CLASS
+  FRAMES   
+ NO FRAMES   
+ 
+
+
+
+

+  SUMMARY: NESTED | FIELD | CONSTR | METHOD
+DETAIL: FIELD | CONSTR | METHOD

+
+
+
+

+
+

+
+com.soundcloud.api
+

+Class ApiWrapper

+
+java.lang.Object
+  extended by com.soundcloud.api.ApiWrapper
+

+

+
All Implemented Interfaces: 
CloudAPI, java.io.Serializable

+

+

+

+
public class ApiWrapper
extends java.lang.Object
implements CloudAPI, java.io.Serializable

+
+ +

+Interface with SoundCloud, using OAuth2. + This API wrapper makes a few assumptions - namely: +

    +
  • Server responses are always requested in JSON format
    • +
  • Refresh-token handling is transparent to the client application (you should not need to + call refreshToken() manually) +
    • +
  • You use Apache HttpClient
    • +
+ Example usage: + + 
+ ApiWrapper wrapper = new ApiWrapper("client_id", "client_secret", null, null, Env.SANDBOX);
+ wrapper.login("login", "password");
+ HttpResponse response = wrapper.get(Request.to("/tracks"));
+
+ +

+ +

+

+
See Also:
CloudAPI, +Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.soundcloud.api.CloudAPI
CloudAPI.InvalidTokenException, CloudAPI.TokenListener
+  + + + + + + + + + + + + + + + + + + + +
+Field Summary
+ booleandebugRequests + +
+          debug request details to stderr
+static java.lang.StringDEFAULT_CONTENT_TYPE + +
+           
+ Envenv + +
+          The current environment
+  + + + + + + + +
Fields inherited from interface com.soundcloud.api.CloudAPI
AUTHORIZATION_CODE, CLIENT_CREDENTIALS, OAUTH_SCHEME, OAUTH1_TOKEN, PASSWORD, REALM, REFRESH_TOKEN, USER_AGENT, VERSION
+  + + + + + + + + + + +
+Constructor Summary
ApiWrapper(java.lang.String clientId, + java.lang.String clientSecret, + java.net.URI redirectUri, + Token token, + Env env) + +
+          Constructs a new ApiWrapper instance.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+protected  HttpRequestaddAcceptHeader(HttpRequest request) + +
+          Forces JSON
+protected  HttpRequestaddAuthHeader(HttpRequest request) + +
+          Adds an OAuth2 header to a given request
+protected  HttpRequestaddHeaders(HttpRequest req) + +
+          Adds all required headers to the request
+ TokenauthorizationCode(java.lang.String code) + +
+          Request a token using + Authorization Code, requesting a default scope.
+ TokenauthorizationCode(java.lang.String code, + java.lang.String scope) + +
+          Request a token using + Authorization Code with a specified scope.
+ java.net.URIauthorizationCodeUrl(java.lang.String... options) + +
+          Request login via authorization code + After login, control will go to the redirect URI (wrapper specific), with + one of the following query parameters appended: + + code in case of success, this will contain the code used for the + authorizationCode call to obtain the access token.
+ TokenclientCredentials() + +
+          Request a "signup" token using + Client Credentials.
+ TokenclientCredentials(java.lang.String scope) + +
+          Requests a token using + Client Credentials.
+static HeadercreateOAuthHeader(Token token) + +
+          Creates an OAuth2 header for the given token
+ HttpResponsedelete(Request request) + +
+           
+ TokenexchangeOAuth1Token(java.lang.String oauth1AccessToken) + +
+          Exchange an OAuth1 Token for new OAuth2 tokens.
+ HttpResponseexecute(HttpRequest req) + +
+          Execute an API request, adds the necessary headers.
+protected  HttpResponseexecute(Request req, + java.lang.Class<? extends org.apache.http.client.methods.HttpRequestBase> reqType) + +
+           
+static ApiWrapperfromFile(java.io.File f) + +
+          Read wrapper from a file
+ HttpResponseget(Request request) + +
+           
+ java.lang.StringgetDefaultContentType() + +
+           
+ org.apache.http.client.HttpClientgetHttpClient() + +
+           
+protected  HttpParamsgetParams() + +
+           
+protected  org.apache.http.client.RequestDirectorgetRequestDirector(HttpRequestExecutor requestExec, + org.apache.http.conn.ClientConnectionManager conman, + ConnectionReuseStrategy reustrat, + org.apache.http.conn.ConnectionKeepAliveStrategy kastrat, + org.apache.http.conn.routing.HttpRoutePlanner rouplan, + HttpProcessor httpProcessor, + org.apache.http.client.HttpRequestRetryHandler retryHandler, + org.apache.http.client.RedirectHandler redirectHandler, + org.apache.http.client.AuthenticationHandler targetAuthHandler, + org.apache.http.client.AuthenticationHandler proxyAuthHandler, + org.apache.http.client.UserTokenHandler stateHandler, + HttpParams params) + +
+          This method mainly exists to make the wrapper more testable.
+protected  org.apache.http.conn.scheme.SocketFactorygetSocketFactory() + +
+           
+protected  org.apache.http.conn.ssl.SSLSocketFactorygetSSLSocketFactory() + +
+           
+ TokengetToken() + +
+           
+ java.net.URIgetURI(Request request, + boolean api, + boolean secure) + +
+          Constructs URI path for a given resource.
+protected  java.lang.StringgetUserAgent() + +
+          User-Agent to identify ourselves with - defaults to USER_AGENT
+ TokeninvalidateToken() + +
+          This method should be called when the token was found to be invalid.
+ Tokenlogin(java.lang.String username, + java.lang.String password) + +
+          Request a token using + Resource Owner Password Credentials.
+ Tokenlogin(java.lang.String username, + java.lang.String password, + java.lang.String scope) + +
+          Request a token using + Resource Owner Password Credentials.
+ HttpResponsepost(Request request) + +
+           
+ HttpResponseput(Request request) + +
+           
+ TokenrefreshToken() + +
+          Tries to refresh the currently used access token with the refresh token.
+protected  TokenrequestToken(Request request) + +
+          Request an OAuth2 token from SoundCloud
+ longresolve(java.lang.String url) + +
+          Resolve the given SoundCloud URI
+ voidsetDefaultContentType(java.lang.String contentType) + +
+          Changes the default content type sent in the "Accept" header.
+ voidsetToken(Token newToken) + +
+           
+ voidsetTokenListener(CloudAPI.TokenListener listener) + +
+          Registers a listener.
+ voidtoFile(java.io.File f) + +
+          serialize the wrapper to a File
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+DEFAULT_CONTENT_TYPE

+
+public static final java.lang.String DEFAULT_CONTENT_TYPE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+env

+
+public final Env env
+
+
The current environment +

+

+
+
+
+ +

+debugRequests

+
+public boolean debugRequests
+
+
debug request details to stderr +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+ApiWrapper

+
+public ApiWrapper(java.lang.String clientId,
+                  java.lang.String clientSecret,
+                  java.net.URI redirectUri,
+                  Token token,
+                  Env env)
+
+
Constructs a new ApiWrapper instance. +

+

+
Parameters:
clientId - the application client id
clientSecret - the application client secret
redirectUri - the registered redirect url, or null
token - an valid token, or null if not known
env - the environment to use (LIVE/SANDBOX)
See Also:
API documentation
+
+ + + + + + + + +
+Method Detail
+ +

+login

+
+public Token login(java.lang.String username,
+                   java.lang.String password)
+            throws java.io.IOException
+
+
Description copied from interface: CloudAPI
+
Request a token using + Resource Owner Password Credentials. +

+

+
Specified by:
login in interface CloudAPI
+
+
+
Parameters:
username - SoundCloud username
password - SoundCloud password +
Returns:
a valid token +
Throws: +
CloudAPI.InvalidTokenException - invalid token +
java.io.IOException - In case of network/server errors
+
+
+
+ +

+login

+
+public Token login(java.lang.String username,
+                   java.lang.String password,
+                   java.lang.String scope)
+            throws java.io.IOException
+
+
Description copied from interface: CloudAPI
+
Request a token using + Resource Owner Password Credentials. +

+

+
Specified by:
login in interface CloudAPI
+
+
+
Parameters:
username - SoundCloud username
password - SoundCloud password
scope - the desired scope +
Returns:
a valid token +
Throws: +
CloudAPI.InvalidTokenException - invalid token +
java.io.IOException - In case of network/server errors
+
+
+
+ +

+authorizationCode

+
+public Token authorizationCode(java.lang.String code)
+                        throws java.io.IOException
+
+
Description copied from interface: CloudAPI
+
Request a token using + Authorization Code, requesting a default scope. +

+

+
Specified by:
authorizationCode in interface CloudAPI
+
+
+
Parameters:
code - the authorization code +
Returns:
a valid token +
Throws: +
CloudAPI.InvalidTokenException - invalid token +
java.io.IOException - In case of network/server errors
+
+
+
+ +

+authorizationCode

+
+public Token authorizationCode(java.lang.String code,
+                               java.lang.String scope)
+                        throws java.io.IOException
+
+
Description copied from interface: CloudAPI
+
Request a token using + Authorization Code with a specified scope. +

+

+
Specified by:
authorizationCode in interface CloudAPI
+
+
+
Parameters:
code - the authorization code
scope - the desired scope +
Returns:
a valid token +
Throws: +
CloudAPI.InvalidTokenException - invalid token +
java.io.IOException - In case of network/server errors
+
+
+
+ +

+clientCredentials

+
+public Token clientCredentials()
+                        throws java.io.IOException
+
+
Description copied from interface: CloudAPI
+
Request a "signup" token using + Client Credentials. + + Note that this token is not set as the current token in the wrapper - it should only be used + for one request (typically the signup / user creation request). + Also note that not all apps are allowed to request this token type (the wrapper throws + InvalidTokenException in this case). +

+

+
Specified by:
clientCredentials in interface CloudAPI
+
+
+ +
Returns:
a valid token +
Throws: +
java.io.IOException - IO/Error +
CloudAPI.InvalidTokenException - if requested scope is not available
+
+
+
+ +

+clientCredentials

+
+public Token clientCredentials(java.lang.String scope)
+                        throws java.io.IOException
+
+
Description copied from interface: CloudAPI
+
Requests a token using + Client Credentials. + + Note that this token is not set as the current token in the wrapper - it should only be used + for one request (typically the signup / user creation request). + Also note that not all apps are allowed to request for all scopes (the wrapper throws + InvalidTokenException in this case). +

+

+
Specified by:
clientCredentials in interface CloudAPI
+
+
+
Parameters:
scope - the requested scope +
Returns:
a valid token +
Throws: +
java.io.IOException - IO/Error +
CloudAPI.InvalidTokenException - if requested scope is not available
+
+
+
+ +

+refreshToken

+
+public Token refreshToken()
+                   throws java.io.IOException
+
+
Description copied from interface: CloudAPI
+
Tries to refresh the currently used access token with the refresh token. + If successful the API wrapper will have the new token set already. +

+

+
Specified by:
refreshToken in interface CloudAPI
+
+
+ +
Returns:
a valid token +
Throws: +
java.io.IOException - in case of network problems +
CloudAPI.InvalidTokenException - invalid token
+
+
+
+ +

+exchangeOAuth1Token

+
+public Token exchangeOAuth1Token(java.lang.String oauth1AccessToken)
+                          throws java.io.IOException
+
+
Description copied from interface: CloudAPI
+
Exchange an OAuth1 Token for new OAuth2 tokens. The old OAuth1 token will be expired if + the exchange is successful. +

+

+
Specified by:
exchangeOAuth1Token in interface CloudAPI
+
+
+
Parameters:
oauth1AccessToken - a valid OAuth1 access token, registered with the same client +
Returns:
a valid token +
Throws: +
java.io.IOException - IO/Error +
CloudAPI.InvalidTokenException - Token error
+
+
+
+ +

+invalidateToken

+
+public Token invalidateToken()
+
+
Description copied from interface: CloudAPI
+
This method should be called when the token was found to be invalid. + Also replaces the current token, if there is one available. +

+

+
Specified by:
invalidateToken in interface CloudAPI
+
+
+ +
Returns:
an alternative token, or null if none available + (which indicates that a refresh could be tried)
+
+
+
+ +

+authorizationCodeUrl

+
+public java.net.URI authorizationCodeUrl(java.lang.String... options)
+
+
Description copied from interface: CloudAPI
+
Request login via authorization code + After login, control will go to the redirect URI (wrapper specific), with + one of the following query parameters appended: +
    +
  • code in case of success, this will contain the code used for the + authorizationCode call to obtain the access token. +
  • error in case of failure, this contains an error code (most likely + access_denied). +
+

+

+
Specified by:
authorizationCodeUrl in interface CloudAPI
+
+
+
Parameters:
options - auth endpoint to use (leave out for default), requested scope (leave out for default) +
Returns:
the URI to open in a browser/WebView etc.
See Also:
CloudAPI.authorizationCode(String)
+
+
+
+ +

+getURI

+
+public java.net.URI getURI(Request request,
+                           boolean api,
+                           boolean secure)
+
+
Constructs URI path for a given resource. +

+

+
+
+
+
Parameters:
request - the resource to access
api - api or web
secure - whether to use SSL or not +
Returns:
a valid URI
+
+
+
+ +

+requestToken

+
+protected Token requestToken(Request request)
+                      throws java.io.IOException
+
+
Request an OAuth2 token from SoundCloud +

+

+
+
+
+
Parameters:
request - the token request +
Returns:
the token +
Throws: +
java.io.IOException - network error +
CloudAPI.InvalidTokenException - unauthorized
+
+
+
+ +

+getParams

+
+protected HttpParams getParams()
+
+
+
+
+
+ +
Returns:
parameters used by the underlying HttpClient
+
+
+
+ +

+getSocketFactory

+
+protected org.apache.http.conn.scheme.SocketFactory getSocketFactory()
+
+
+
+
+
+ +
Returns:
SocketFactory used by the underlying HttpClient
+
+
+
+ +

+getSSLSocketFactory

+
+protected org.apache.http.conn.ssl.SSLSocketFactory getSSLSocketFactory()
+
+
+
+
+
+ +
Returns:
SSL SocketFactory used by the underlying HttpClient
+
+
+
+ +

+getUserAgent

+
+protected java.lang.String getUserAgent()
+
+
User-Agent to identify ourselves with - defaults to USER_AGENT +

+

+
+
+
+ +
Returns:
the agent to use
See Also:
CloudAPI.USER_AGENT
+
+
+
+ +

+getHttpClient

+
+public org.apache.http.client.HttpClient getHttpClient()
+
+
+
+
+
+ +
Returns:
The HttpClient instance used to make the calls
+
+
+
+ +

+resolve

+
+public long resolve(java.lang.String url)
+             throws java.io.IOException
+
+
Description copied from interface: CloudAPI
+
Resolve the given SoundCloud URI +

+

+
Specified by:
resolve in interface CloudAPI
+
+
+
Parameters:
url - SoundCloud model URI, e.g. http://soundcloud.com/bob +
Returns:
the id or -1 if uri not found +
Throws: +
java.io.IOException - network errors
+
+
+
+ +

+get

+
+public HttpResponse get(Request request)
+                 throws java.io.IOException
+
+
+
Specified by:
get in interface CloudAPI
+
+
+
Parameters:
request - resource to GET +
Returns:
the HTTP response +
Throws: +
java.io.IOException - IO/Error
+
+
+
+ +

+put

+
+public HttpResponse put(Request request)
+                 throws java.io.IOException
+
+
+
Specified by:
put in interface CloudAPI
+
+
+
Parameters:
request - resource to PUT +
Returns:
the HTTP response +
Throws: +
java.io.IOException - IO/Error
+
+
+
+ +

+post

+
+public HttpResponse post(Request request)
+                  throws java.io.IOException
+
+
+
Specified by:
post in interface CloudAPI
+
+
+
Parameters:
request - resource to POST +
Returns:
the HTTP response +
Throws: +
java.io.IOException - IO/Error
+
+
+
+ +

+delete

+
+public HttpResponse delete(Request request)
+                    throws java.io.IOException
+
+
+
Specified by:
delete in interface CloudAPI
+
+
+
Parameters:
request - resource to DELETE +
Returns:
the HTTP response +
Throws: +
java.io.IOException - IO/Error
+
+
+
+ +

+getToken

+
+public Token getToken()
+
+
+
Specified by:
getToken in interface CloudAPI
+
+
+ +
Returns:
the current token
+
+
+
+ +

+setToken

+
+public void setToken(Token newToken)
+
+
+
Specified by:
setToken in interface CloudAPI
+
+
+
Parameters:
newToken - the token to be used
+
+
+
+ +

+setTokenListener

+
+public void setTokenListener(CloudAPI.TokenListener listener)
+
+
Description copied from interface: CloudAPI
+
Registers a listener. The listener will be informed when an access token was found + to be invalid, and when the token had to be refreshed. +

+

+
Specified by:
setTokenListener in interface CloudAPI
+
+
+
Parameters:
listener - token listener
+
+
+
+ +

+execute

+
+public HttpResponse execute(HttpRequest req)
+                     throws java.io.IOException
+
+
Execute an API request, adds the necessary headers. +

+

+
+
+
+
Parameters:
req - the HTTP request +
Returns:
the HTTP response +
Throws: +
java.io.IOException - network error etc.
+
+
+
+ +

+execute

+
+protected HttpResponse execute(Request req,
+                               java.lang.Class<? extends org.apache.http.client.methods.HttpRequestBase> reqType)
+                        throws java.io.IOException
+
+
+
+
+
+ +
Throws: +
java.io.IOException
+
+
+
+ +

+toFile

+
+public void toFile(java.io.File f)
+            throws java.io.IOException
+
+
serialize the wrapper to a File +

+

+
+
+
+
Parameters:
f - target +
Throws: +
java.io.IOException - IO problems
+
+
+
+ +

+getDefaultContentType

+
+public java.lang.String getDefaultContentType()
+
+
+
+
+
+
+
+
+
+ +

+setDefaultContentType

+
+public void setDefaultContentType(java.lang.String contentType)
+
+
Description copied from interface: CloudAPI
+
Changes the default content type sent in the "Accept" header. + If you don't set this it defaults to "application/json". +

+

+
Specified by:
setDefaultContentType in interface CloudAPI
+
+
+
Parameters:
contentType - the request mime type.
+
+
+
+ +

+fromFile

+
+public static ApiWrapper fromFile(java.io.File f)
+                           throws java.io.IOException,
+                                  java.lang.ClassNotFoundException
+
+
Read wrapper from a file +

+

+
+
+
+
Parameters:
f - the file +
Returns:
the wrapper +
Throws: +
java.io.IOException - IO problems +
java.lang.ClassNotFoundException - class not found
+
+
+
+ +

+createOAuthHeader

+
+public static Header createOAuthHeader(Token token)
+
+
Creates an OAuth2 header for the given token +

+

+
+
+
+
+
+
+
+ +

+addAuthHeader

+
+protected HttpRequest addAuthHeader(HttpRequest request)
+
+
Adds an OAuth2 header to a given request +

+

+
+
+
+
+
+
+
+ +

+addAcceptHeader

+
+protected HttpRequest addAcceptHeader(HttpRequest request)
+
+
Forces JSON +

+

+
+
+
+
+
+
+
+ +

+addHeaders

+
+protected HttpRequest addHeaders(HttpRequest req)
+
+
Adds all required headers to the request +

+

+
+
+
+
+
+
+
+ +

+getRequestDirector

+
+protected org.apache.http.client.RequestDirector getRequestDirector(HttpRequestExecutor requestExec,
+                                                                    org.apache.http.conn.ClientConnectionManager conman,
+                                                                    ConnectionReuseStrategy reustrat,
+                                                                    org.apache.http.conn.ConnectionKeepAliveStrategy kastrat,
+                                                                    org.apache.http.conn.routing.HttpRoutePlanner rouplan,
+                                                                    HttpProcessor httpProcessor,
+                                                                    org.apache.http.client.HttpRequestRetryHandler retryHandler,
+                                                                    org.apache.http.client.RedirectHandler redirectHandler,
+                                                                    org.apache.http.client.AuthenticationHandler targetAuthHandler,
+                                                                    org.apache.http.client.AuthenticationHandler proxyAuthHandler,
+                                                                    org.apache.http.client.UserTokenHandler stateHandler,
+                                                                    HttpParams params)
+
+
This method mainly exists to make the wrapper more testable. oh, apache's insanity. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/javadoc/1.0.1/com/soundcloud/api/CloudAPI.InvalidTokenException.html b/javadoc/1.0.1/com/soundcloud/api/CloudAPI.InvalidTokenException.html new file mode 100644 index 0000000..3d78a9f --- /dev/null +++ b/javadoc/1.0.1/com/soundcloud/api/CloudAPI.InvalidTokenException.html @@ -0,0 +1,248 @@ + + + + + + +CloudAPI.InvalidTokenException (SoundCloud Java API Wrapper 1.0.1) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.soundcloud.api +
+Class CloudAPI.InvalidTokenException

+
+java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by com.soundcloud.api.CloudAPI.InvalidTokenException
+
+
+
All Implemented Interfaces:
java.io.Serializable
+
+
+
Enclosing interface:
CloudAPI
+
+
+
+
public static class CloudAPI.InvalidTokenException
extends java.io.IOException
+ + +

+Thrown when token is not valid. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
CloudAPI.InvalidTokenException(int code, + java.lang.String status) + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+CloudAPI.InvalidTokenException

+
+public CloudAPI.InvalidTokenException(int code,
+                                      java.lang.String status)
+
+
+
Parameters:
code - the HTTP error code
status - the HTTP status, or other error message
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/javadoc/1.0.1/com/soundcloud/api/CloudAPI.TokenListener.html b/javadoc/1.0.1/com/soundcloud/api/CloudAPI.TokenListener.html new file mode 100644 index 0000000..4064af6 --- /dev/null +++ b/javadoc/1.0.1/com/soundcloud/api/CloudAPI.TokenListener.html @@ -0,0 +1,233 @@ + + + + + + +CloudAPI.TokenListener (SoundCloud Java API Wrapper 1.0.1) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.soundcloud.api +
+Interface CloudAPI.TokenListener

+
+
Enclosing interface:
CloudAPI
+
+
+
+
public static interface CloudAPI.TokenListener
+ + +

+Interested in changes to the current token. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + +
+Method Summary
+ TokenonTokenInvalid(Token token) + +
+          Called when token was found to be invalid
+ voidonTokenRefreshed(Token token) + +
+          Called when the token got successfully refreshed
+  +

+ + + + + + + + +
+Method Detail
+ +

+onTokenInvalid

+
+Token onTokenInvalid(Token token)
+
+
Called when token was found to be invalid +

+

+
Parameters:
token - the invalid token +
Returns:
a cached token if available, or null
+
+
+
+ +

+onTokenRefreshed

+
+void onTokenRefreshed(Token token)
+
+
Called when the token got successfully refreshed +

+

+
Parameters:
token - the refreshed token
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/javadoc/1.0.1/com/soundcloud/api/CloudAPI.html b/javadoc/1.0.1/com/soundcloud/api/CloudAPI.html new file mode 100644 index 0000000..ce4dfb4 --- /dev/null +++ b/javadoc/1.0.1/com/soundcloud/api/CloudAPI.html @@ -0,0 +1,899 @@ + + + + + + +CloudAPI (SoundCloud Java API Wrapper 1.0.1) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.soundcloud.api +
+Interface CloudAPI

+
+
All Known Implementing Classes:
ApiWrapper
+
+
+
+
public interface CloudAPI
+ + +

+Interface with SoundCloud, using OAuth2. + + This is the interface, for the implementation see ApiWrapper. +

+ +

+

+
See Also:
ApiWrapper
+
+ +

+ + + + + + + + + + + + + + + +
+Nested Class Summary
+static classCloudAPI.InvalidTokenException + +
+          Thrown when token is not valid.
+static interfaceCloudAPI.TokenListener + +
+          Interested in changes to the current token.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static java.lang.StringAUTHORIZATION_CODE + +
+           
+static java.lang.StringCLIENT_CREDENTIALS + +
+           
+static java.lang.StringOAUTH_SCHEME + +
+           
+static java.lang.StringOAUTH1_TOKEN + +
+           
+static java.lang.StringPASSWORD + +
+           
+static java.lang.StringREALM + +
+           
+static java.lang.StringREFRESH_TOKEN + +
+           
+static java.lang.StringUSER_AGENT + +
+           
+static java.lang.StringVERSION + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ TokenauthorizationCode(java.lang.String code) + +
+          Request a token using + Authorization Code, requesting a default scope.
+ TokenauthorizationCode(java.lang.String code, + java.lang.String scope) + +
+          Request a token using + Authorization Code with a specified scope.
+ java.net.URIauthorizationCodeUrl(java.lang.String... options) + +
+          Request login via authorization code + After login, control will go to the redirect URI (wrapper specific), with + one of the following query parameters appended: + + code in case of success, this will contain the code used for the + authorizationCode call to obtain the access token.
+ TokenclientCredentials() + +
+          Request a "signup" token using + Client Credentials.
+ TokenclientCredentials(java.lang.String scope) + +
+          Requests a token using + Client Credentials.
+ HttpResponsedelete(Request request) + +
+           
+ TokenexchangeOAuth1Token(java.lang.String oauth1AccessToken) + +
+          Exchange an OAuth1 Token for new OAuth2 tokens.
+ HttpResponseget(Request request) + +
+           
+ TokengetToken() + +
+           
+ TokeninvalidateToken() + +
+          This method should be called when the token was found to be invalid.
+ Tokenlogin(java.lang.String username, + java.lang.String password) + +
+          Request a token using + Resource Owner Password Credentials.
+ Tokenlogin(java.lang.String username, + java.lang.String password, + java.lang.String scope) + +
+          Request a token using + Resource Owner Password Credentials.
+ HttpResponsepost(Request request) + +
+           
+ HttpResponseput(Request request) + +
+           
+ TokenrefreshToken() + +
+          Tries to refresh the currently used access token with the refresh token.
+ longresolve(java.lang.String uri) + +
+          Resolve the given SoundCloud URI
+ voidsetDefaultContentType(java.lang.String contentType) + +
+          Changes the default content type sent in the "Accept" header.
+ voidsetToken(Token token) + +
+           
+ voidsetTokenListener(CloudAPI.TokenListener listener) + +
+          Registers a listener.
+  +

+ + + + + + + + +
+Field Detail
+ +

+PASSWORD

+
+static final java.lang.String PASSWORD
+
+
+
See Also:
Constant Field Values
+
+
+ +

+AUTHORIZATION_CODE

+
+static final java.lang.String AUTHORIZATION_CODE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+REFRESH_TOKEN

+
+static final java.lang.String REFRESH_TOKEN
+
+
+
See Also:
Constant Field Values
+
+
+ +

+OAUTH1_TOKEN

+
+static final java.lang.String OAUTH1_TOKEN
+
+
+
See Also:
Constant Field Values
+
+
+ +

+CLIENT_CREDENTIALS

+
+static final java.lang.String CLIENT_CREDENTIALS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+REALM

+
+static final java.lang.String REALM
+
+
+
See Also:
Constant Field Values
+
+
+ +

+OAUTH_SCHEME

+
+static final java.lang.String OAUTH_SCHEME
+
+
+
See Also:
Constant Field Values
+
+
+ +

+VERSION

+
+static final java.lang.String VERSION
+
+
+
See Also:
Constant Field Values
+
+
+ +

+USER_AGENT

+
+static final java.lang.String USER_AGENT
+
+
+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Method Detail
+ +

+login

+
+Token login(java.lang.String username,
+            java.lang.String password)
+            throws java.io.IOException
+
+
Request a token using + Resource Owner Password Credentials. +

+

+
Parameters:
username - SoundCloud username
password - SoundCloud password +
Returns:
a valid token +
Throws: +
CloudAPI.InvalidTokenException - invalid token +
java.io.IOException - In case of network/server errors
+
+
+
+ +

+login

+
+Token login(java.lang.String username,
+            java.lang.String password,
+            java.lang.String scope)
+            throws java.io.IOException
+
+
Request a token using + Resource Owner Password Credentials. +

+

+
Parameters:
username - SoundCloud username
password - SoundCloud password
scope - the desired scope +
Returns:
a valid token +
Throws: +
CloudAPI.InvalidTokenException - invalid token +
java.io.IOException - In case of network/server errors
+
+
+
+ +

+authorizationCode

+
+Token authorizationCode(java.lang.String code)
+                        throws java.io.IOException
+
+
Request a token using + Authorization Code, requesting a default scope. +

+

+
Parameters:
code - the authorization code +
Returns:
a valid token +
Throws: +
CloudAPI.InvalidTokenException - invalid token +
java.io.IOException - In case of network/server errors
+
+
+
+ +

+authorizationCode

+
+Token authorizationCode(java.lang.String code,
+                        java.lang.String scope)
+                        throws java.io.IOException
+
+
Request a token using + Authorization Code with a specified scope. +

+

+
Parameters:
code - the authorization code
scope - the desired scope +
Returns:
a valid token +
Throws: +
CloudAPI.InvalidTokenException - invalid token +
java.io.IOException - In case of network/server errors
+
+
+
+ +

+clientCredentials

+
+Token clientCredentials()
+                        throws java.io.IOException
+
+
Request a "signup" token using + Client Credentials. + + Note that this token is not set as the current token in the wrapper - it should only be used + for one request (typically the signup / user creation request). + Also note that not all apps are allowed to request this token type (the wrapper throws + InvalidTokenException in this case). +

+

+ +
Returns:
a valid token +
Throws: +
java.io.IOException - IO/Error +
CloudAPI.InvalidTokenException - if requested scope is not available
+
+
+
+ +

+clientCredentials

+
+Token clientCredentials(java.lang.String scope)
+                        throws java.io.IOException
+
+
Requests a token using + Client Credentials. + + Note that this token is not set as the current token in the wrapper - it should only be used + for one request (typically the signup / user creation request). + Also note that not all apps are allowed to request for all scopes (the wrapper throws + InvalidTokenException in this case). +

+

+
Parameters:
scope - the requested scope +
Returns:
a valid token +
Throws: +
java.io.IOException - IO/Error +
CloudAPI.InvalidTokenException - if requested scope is not available
+
+
+
+ +

+refreshToken

+
+Token refreshToken()
+                   throws java.io.IOException
+
+
Tries to refresh the currently used access token with the refresh token. + If successful the API wrapper will have the new token set already. +

+

+ +
Returns:
a valid token +
Throws: +
java.io.IOException - in case of network problems +
CloudAPI.InvalidTokenException - invalid token +
java.lang.IllegalStateException - if no refresh token present
+
+
+
+ +

+exchangeOAuth1Token

+
+Token exchangeOAuth1Token(java.lang.String oauth1AccessToken)
+                          throws java.io.IOException
+
+
Exchange an OAuth1 Token for new OAuth2 tokens. The old OAuth1 token will be expired if + the exchange is successful. +

+

+
Parameters:
oauth1AccessToken - a valid OAuth1 access token, registered with the same client +
Returns:
a valid token +
Throws: +
java.io.IOException - IO/Error +
CloudAPI.InvalidTokenException - Token error
+
+
+
+ +

+invalidateToken

+
+Token invalidateToken()
+
+
This method should be called when the token was found to be invalid. + Also replaces the current token, if there is one available. +

+

+ +
Returns:
an alternative token, or null if none available + (which indicates that a refresh could be tried)
+
+
+
+ +

+get

+
+HttpResponse get(Request request)
+                 throws java.io.IOException
+
+
+
Parameters:
request - resource to GET +
Returns:
the HTTP response +
Throws: +
java.io.IOException - IO/Error
+
+
+
+ +

+post

+
+HttpResponse post(Request request)
+                  throws java.io.IOException
+
+
+
Parameters:
request - resource to POST +
Returns:
the HTTP response +
Throws: +
java.io.IOException - IO/Error
+
+
+
+ +

+put

+
+HttpResponse put(Request request)
+                 throws java.io.IOException
+
+
+
Parameters:
request - resource to PUT +
Returns:
the HTTP response +
Throws: +
java.io.IOException - IO/Error
+
+
+
+ +

+delete

+
+HttpResponse delete(Request request)
+                    throws java.io.IOException
+
+
+
Parameters:
request - resource to DELETE +
Returns:
the HTTP response +
Throws: +
java.io.IOException - IO/Error
+
+
+
+ +

+resolve

+
+long resolve(java.lang.String uri)
+             throws java.io.IOException
+
+
Resolve the given SoundCloud URI +

+

+
Parameters:
uri - SoundCloud model URI, e.g. http://soundcloud.com/bob +
Returns:
the id or -1 if uri not found +
Throws: +
java.io.IOException - network errors
+
+
+
+ +

+getToken

+
+Token getToken()
+
+
+ +
Returns:
the current token
+
+
+
+ +

+setToken

+
+void setToken(Token token)
+
+
+
Parameters:
token - the token to be used
+
+
+
+ +

+setTokenListener

+
+void setTokenListener(CloudAPI.TokenListener listener)
+
+
Registers a listener. The listener will be informed when an access token was found + to be invalid, and when the token had to be refreshed. +

+

+
Parameters:
listener - token listener
+
+
+
+ +

+authorizationCodeUrl

+
+java.net.URI authorizationCodeUrl(java.lang.String... options)
+
+
Request login via authorization code + After login, control will go to the redirect URI (wrapper specific), with + one of the following query parameters appended: +
    +
  • code in case of success, this will contain the code used for the + authorizationCode call to obtain the access token. +
  • error in case of failure, this contains an error code (most likely + access_denied). +
+

+

+
Parameters:
options - auth endpoint to use (leave out for default), requested scope (leave out for default) +
Returns:
the URI to open in a browser/WebView etc.
See Also:
authorizationCode(String)
+
+
+
+ +

+setDefaultContentType

+
+void setDefaultContentType(java.lang.String contentType)
+
+
Changes the default content type sent in the "Accept" header. + If you don't set this it defaults to "application/json". +

+

+
Parameters:
contentType - the request mime type.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/javadoc/1.0.1/com/soundcloud/api/Endpoints.html b/javadoc/1.0.1/com/soundcloud/api/Endpoints.html new file mode 100644 index 0000000..724f78b --- /dev/null +++ b/javadoc/1.0.1/com/soundcloud/api/Endpoints.html @@ -0,0 +1,728 @@ + + + + + + +Endpoints (SoundCloud Java API Wrapper 1.0.1) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.soundcloud.api +
+Interface Endpoints

+
+
+
public interface Endpoints
+ + +

+Various SoundCloud API endpoints. + See the API docs for the most + recent listing. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static java.lang.StringCONNECT + +
+           
+static java.lang.StringFACEBOOK_CONNECT + +
+           
+static java.lang.StringMY_ACTIVITIES + +
+           
+static java.lang.StringMY_CONFIRMATION + +
+           
+static java.lang.StringMY_CONNECTIONS + +
+           
+static java.lang.StringMY_DETAILS + +
+           
+static java.lang.StringMY_EXCLUSIVE_TRACKS + +
+           
+static java.lang.StringMY_FAVORITE + +
+           
+static java.lang.StringMY_FAVORITES + +
+           
+static java.lang.StringMY_FOLLOWER + +
+           
+static java.lang.StringMY_FOLLOWERS + +
+           
+static java.lang.StringMY_FOLLOWING + +
+           
+static java.lang.StringMY_FOLLOWINGS + +
+           
+static java.lang.StringMY_FRIENDS + +
+           
+static java.lang.StringMY_PLAYLISTS + +
+           
+static java.lang.StringMY_TRACKS + +
+           
+static java.lang.StringRESOLVE + +
+           
+static java.lang.StringSEND_PASSWORD + +
+           
+static java.lang.StringSUGGESTED_USERS + +
+           
+static java.lang.StringTOKEN + +
+           
+static java.lang.StringTRACK_COMMENTS + +
+           
+static java.lang.StringTRACK_DETAILS + +
+           
+static java.lang.StringTRACKS + +
+           
+static java.lang.StringUSER_DETAILS + +
+           
+static java.lang.StringUSER_FAVORITES + +
+           
+static java.lang.StringUSER_FOLLOWERS + +
+           
+static java.lang.StringUSER_FOLLOWINGS + +
+           
+static java.lang.StringUSER_PLAYLISTS + +
+           
+static java.lang.StringUSER_TRACKS + +
+           
+static java.lang.StringUSERS + +
+           
+  +

+ + + + + + + + +
+Field Detail
+ +

+TOKEN

+
+static final java.lang.String TOKEN
+
+
+
See Also:
Constant Field Values
+
+
+ +

+TRACKS

+
+static final java.lang.String TRACKS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+TRACK_DETAILS

+
+static final java.lang.String TRACK_DETAILS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+TRACK_COMMENTS

+
+static final java.lang.String TRACK_COMMENTS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+USERS

+
+static final java.lang.String USERS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+USER_DETAILS

+
+static final java.lang.String USER_DETAILS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+USER_FOLLOWINGS

+
+static final java.lang.String USER_FOLLOWINGS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+USER_FOLLOWERS

+
+static final java.lang.String USER_FOLLOWERS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+USER_TRACKS

+
+static final java.lang.String USER_TRACKS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+USER_FAVORITES

+
+static final java.lang.String USER_FAVORITES
+
+
+
See Also:
Constant Field Values
+
+
+ +

+USER_PLAYLISTS

+
+static final java.lang.String USER_PLAYLISTS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+MY_DETAILS

+
+static final java.lang.String MY_DETAILS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+MY_CONNECTIONS

+
+static final java.lang.String MY_CONNECTIONS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+MY_ACTIVITIES

+
+static final java.lang.String MY_ACTIVITIES
+
+
+
See Also:
Constant Field Values
+
+
+ +

+MY_EXCLUSIVE_TRACKS

+
+static final java.lang.String MY_EXCLUSIVE_TRACKS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+MY_TRACKS

+
+static final java.lang.String MY_TRACKS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+MY_PLAYLISTS

+
+static final java.lang.String MY_PLAYLISTS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+MY_FAVORITES

+
+static final java.lang.String MY_FAVORITES
+
+
+
See Also:
Constant Field Values
+
+
+ +

+MY_FAVORITE

+
+static final java.lang.String MY_FAVORITE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+MY_FOLLOWERS

+
+static final java.lang.String MY_FOLLOWERS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+MY_FOLLOWER

+
+static final java.lang.String MY_FOLLOWER
+
+
+
See Also:
Constant Field Values
+
+
+ +

+MY_FOLLOWINGS

+
+static final java.lang.String MY_FOLLOWINGS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+MY_FOLLOWING

+
+static final java.lang.String MY_FOLLOWING
+
+
+
See Also:
Constant Field Values
+
+
+ +

+MY_CONFIRMATION

+
+static final java.lang.String MY_CONFIRMATION
+
+
+
See Also:
Constant Field Values
+
+
+ +

+MY_FRIENDS

+
+static final java.lang.String MY_FRIENDS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+SUGGESTED_USERS

+
+static final java.lang.String SUGGESTED_USERS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+RESOLVE

+
+static final java.lang.String RESOLVE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+SEND_PASSWORD

+
+static final java.lang.String SEND_PASSWORD
+
+
+
See Also:
Constant Field Values
+
+
+ +

+CONNECT

+
+static final java.lang.String CONNECT
+
+
+
See Also:
Constant Field Values
+
+
+ +

+FACEBOOK_CONNECT

+
+static final java.lang.String FACEBOOK_CONNECT
+
+
+
See Also:
Constant Field Values
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/javadoc/1.0.1/com/soundcloud/api/Env.html b/javadoc/1.0.1/com/soundcloud/api/Env.html new file mode 100644 index 0000000..18bc0c5 --- /dev/null +++ b/javadoc/1.0.1/com/soundcloud/api/Env.html @@ -0,0 +1,455 @@ + + + + + + +Env (SoundCloud Java API Wrapper 1.0.1) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ +

+ +com.soundcloud.api +
+Enum Env

+
+java.lang.Object
+  extended by java.lang.Enum<Env>
+      extended by com.soundcloud.api.Env
+
+
+
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Env>
+
+
+
+
public enum Env
extends java.lang.Enum<Env>
+ + +

+The environment to operate against. + Use SANDBOX for testing your app, and LIVE for production applications. +

+ +

+

+ +

+ + + + + + + + + + + + + +
+Enum Constant Summary
LIVE + +
+          The main production site, http://soundcloud.com
SANDBOX + +
+          For testing, http://sandbox-soundcloud.com
+  + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+ HttpHostauthResourceHost + +
+           
+ HttpHostresourceHost + +
+           
+ HttpHostsslAuthResourceHost + +
+           
+ HttpHostsslResourceHost + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ HttpHostgetAuthResourceHost(boolean secure) + +
+           
+ HttpHostgetResourceHost(boolean secure) + +
+           
+static EnvvalueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static Env[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  + + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+LIVE

+
+public static final Env LIVE
+
+
The main production site, http://soundcloud.com +

+

+
+
+
+ +

+SANDBOX

+
+public static final Env SANDBOX
+
+
For testing, http://sandbox-soundcloud.com +

+

+
+
+ + + + + + + + +
+Field Detail
+ +

+resourceHost

+
+public final HttpHost resourceHost
+
+
+
+
+
+ +

+sslResourceHost

+
+public final HttpHost sslResourceHost
+
+
+
+
+
+ +

+authResourceHost

+
+public final HttpHost authResourceHost
+
+
+
+
+
+ +

+sslAuthResourceHost

+
+public final HttpHost sslAuthResourceHost
+
+
+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static Env[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (Env c : Env.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static Env valueOf(java.lang.String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name +
java.lang.NullPointerException - if the argument is null
+
+
+
+ +

+getResourceHost

+
+public HttpHost getResourceHost(boolean secure)
+
+
+
+
+
+
+ +

+getAuthResourceHost

+
+public HttpHost getAuthResourceHost(boolean secure)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ + + diff --git a/javadoc/1.0.1/com/soundcloud/api/Http.html b/javadoc/1.0.1/com/soundcloud/api/Http.html new file mode 100644 index 0000000..80844fd --- /dev/null +++ b/javadoc/1.0.1/com/soundcloud/api/Http.html @@ -0,0 +1,324 @@ + + + + + + +Http (SoundCloud Java API Wrapper 1.0.1) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.soundcloud.api +
+Class Http

+
+java.lang.Object
+  extended by com.soundcloud.api.Http
+
+
+
+
public class Http
extends java.lang.Object
+ + +

+Helper class for various HTTP related functions. +

+ +

+

+ +

+ + + + + + + + + + + + + + + +
+Field Summary
+static intBUFFER_SIZE + +
+           
+static intTIMEOUT + +
+          Connection timeout
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static HttpParamsdefaultParams() + +
+           
+static JSONObjectgetJSON(HttpResponse response) + +
+           
+static java.lang.StringgetString(HttpResponse response) + +
+          Returns a String representation of the response
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+BUFFER_SIZE

+
+public static final int BUFFER_SIZE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+TIMEOUT

+
+public static final int TIMEOUT
+
+
Connection timeout +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Method Detail
+ +

+getString

+
+public static java.lang.String getString(HttpResponse response)
+                                  throws java.io.IOException
+
+
Returns a String representation of the response +

+

+
Parameters:
response - an HTTP response +
Returns:
the content body +
Throws: +
java.io.IOException - network error
+
+
+
+ +

+getJSON

+
+public static JSONObject getJSON(HttpResponse response)
+                          throws java.io.IOException
+
+
+ +
Throws: +
java.io.IOException
+
+
+
+ +

+defaultParams

+
+public static HttpParams defaultParams()
+
+
+ +
Returns:
the default HttpParams
See Also:
+ android.net.http.AndroidHttpClient#newInstance(String, Context)
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/javadoc/1.0.1/com/soundcloud/api/Params.Comment.html b/javadoc/1.0.1/com/soundcloud/api/Params.Comment.html new file mode 100644 index 0000000..d229cdc --- /dev/null +++ b/javadoc/1.0.1/com/soundcloud/api/Params.Comment.html @@ -0,0 +1,243 @@ + + + + + + +Params.Comment (SoundCloud Java API Wrapper 1.0.1) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.soundcloud.api +
+Interface Params.Comment

+
+
Enclosing interface:
Params
+
+
+
+
public static interface Params.Comment
+ + +

+Comments +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + +
+Field Summary
+static java.lang.StringBODY + +
+           
+static java.lang.StringREPLY_TO + +
+           
+static java.lang.StringTIMESTAMP + +
+           
+  +

+ + + + + + + + +
+Field Detail
+ +

+BODY

+
+static final java.lang.String BODY
+
+
+
See Also:
Constant Field Values
+
+
+ +

+TIMESTAMP

+
+static final java.lang.String TIMESTAMP
+
+
+
See Also:
Constant Field Values
+
+
+ +

+REPLY_TO

+
+static final java.lang.String REPLY_TO
+
+
+
See Also:
Constant Field Values
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/javadoc/1.0.1/com/soundcloud/api/Params.Track.html b/javadoc/1.0.1/com/soundcloud/api/Params.Track.html new file mode 100644 index 0000000..2fd44b0 --- /dev/null +++ b/javadoc/1.0.1/com/soundcloud/api/Params.Track.html @@ -0,0 +1,711 @@ + + + + + + +Params.Track (SoundCloud Java API Wrapper 1.0.1) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.soundcloud.api +
+Interface Params.Track

+
+
Enclosing interface:
Params
+
+
+
+
public static interface Params.Track
+ + +

+Tracks +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static java.lang.StringARTWORK_DATA + +
+           
+static java.lang.StringASSET_DATA + +
+           
+static java.lang.StringBPM + +
+           
+static java.lang.StringDESCRIPTION + +
+           
+static java.lang.StringDOWNLOADABLE + +
+           
+static java.lang.StringGENRE + +
+           
+static java.lang.StringISRC + +
+           
+static java.lang.StringKEY_SIGNATURE + +
+           
+static java.lang.StringLABEL_ID + +
+           
+static java.lang.StringLABEL_NAME + +
+           
+static java.lang.StringLICENSE + +
+           
+static java.lang.StringPERMALINK + +
+           
+static java.lang.StringPOST_TO + +
+           
+static java.lang.StringPOST_TO_EMPTY + +
+           
+static java.lang.StringPRIVATE + +
+           
+static java.lang.StringPUBLIC + +
+           
+static java.lang.StringPURCHASE_URL + +
+           
+static java.lang.StringRELEASE + +
+           
+static java.lang.StringRELEASE_DAY + +
+           
+static java.lang.StringRELEASE_MONTH + +
+           
+static java.lang.StringRELEASE_YEAR + +
+           
+static java.lang.StringSHARED_EMAILS + +
+           
+static java.lang.StringSHARING + +
+           
+static java.lang.StringSHARING_NOTE + +
+           
+static java.lang.StringSTREAMABLE + +
+           
+static java.lang.StringTAG_LIST + +
+           
+static java.lang.StringTITLE + +
+           
+static java.lang.StringTYPE + +
+           
+static java.lang.StringVIDEO_URL + +
+           
+  +

+ + + + + + + + +
+Field Detail
+ +

+TITLE

+
+static final java.lang.String TITLE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+TYPE

+
+static final java.lang.String TYPE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+DESCRIPTION

+
+static final java.lang.String DESCRIPTION
+
+
+
See Also:
Constant Field Values
+
+
+ +

+ASSET_DATA

+
+static final java.lang.String ASSET_DATA
+
+
+
See Also:
Constant Field Values
+
+
+ +

+ARTWORK_DATA

+
+static final java.lang.String ARTWORK_DATA
+
+
+
See Also:
Constant Field Values
+
+
+ +

+POST_TO

+
+static final java.lang.String POST_TO
+
+
+
See Also:
Constant Field Values
+
+
+ +

+POST_TO_EMPTY

+
+static final java.lang.String POST_TO_EMPTY
+
+
+
See Also:
Constant Field Values
+
+
+ +

+TAG_LIST

+
+static final java.lang.String TAG_LIST
+
+
+
See Also:
Constant Field Values
+
+
+ +

+PERMALINK

+
+static final java.lang.String PERMALINK
+
+
+
See Also:
Constant Field Values
+
+
+ +

+SHARING

+
+static final java.lang.String SHARING
+
+
+
See Also:
Constant Field Values
+
+
+ +

+STREAMABLE

+
+static final java.lang.String STREAMABLE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+DOWNLOADABLE

+
+static final java.lang.String DOWNLOADABLE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+GENRE

+
+static final java.lang.String GENRE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+RELEASE

+
+static final java.lang.String RELEASE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+RELEASE_DAY

+
+static final java.lang.String RELEASE_DAY
+
+
+
See Also:
Constant Field Values
+
+
+ +

+RELEASE_MONTH

+
+static final java.lang.String RELEASE_MONTH
+
+
+
See Also:
Constant Field Values
+
+
+ +

+RELEASE_YEAR

+
+static final java.lang.String RELEASE_YEAR
+
+
+
See Also:
Constant Field Values
+
+
+ +

+PURCHASE_URL

+
+static final java.lang.String PURCHASE_URL
+
+
+
See Also:
Constant Field Values
+
+
+ +

+LABEL_NAME

+
+static final java.lang.String LABEL_NAME
+
+
+
See Also:
Constant Field Values
+
+
+ +

+LABEL_ID

+
+static final java.lang.String LABEL_ID
+
+
+
See Also:
Constant Field Values
+
+
+ +

+VIDEO_URL

+
+static final java.lang.String VIDEO_URL
+
+
+
See Also:
Constant Field Values
+
+
+ +

+ISRC

+
+static final java.lang.String ISRC
+
+
+
See Also:
Constant Field Values
+
+
+ +

+KEY_SIGNATURE

+
+static final java.lang.String KEY_SIGNATURE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+BPM

+
+static final java.lang.String BPM
+
+
+
See Also:
Constant Field Values
+
+
+ +

+LICENSE

+
+static final java.lang.String LICENSE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+SHARED_EMAILS

+
+static final java.lang.String SHARED_EMAILS
+
+
+
See Also:
Constant Field Values
+
+
+ +

+SHARING_NOTE

+
+static final java.lang.String SHARING_NOTE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+PUBLIC

+
+static final java.lang.String PUBLIC
+
+
+
See Also:
Constant Field Values
+
+
+ +

+PRIVATE

+
+static final java.lang.String PRIVATE
+
+
+
See Also:
Constant Field Values
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/javadoc/1.0.1/com/soundcloud/api/Params.User.html b/javadoc/1.0.1/com/soundcloud/api/Params.User.html new file mode 100644 index 0000000..149435a --- /dev/null +++ b/javadoc/1.0.1/com/soundcloud/api/Params.User.html @@ -0,0 +1,441 @@ + + + + + + +Params.User (SoundCloud Java API Wrapper 1.0.1) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.soundcloud.api +
+Interface Params.User

+
+
Enclosing interface:
Params
+
+
+
+
public static interface Params.User
+ + +

+Users +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static java.lang.StringAVATAR + +
+           
+static java.lang.StringCITY + +
+           
+static java.lang.StringDESCRIPTION + +
+           
+static java.lang.StringDISCOGS_NAME + +
+           
+static java.lang.StringEMAIL + +
+           
+static java.lang.StringFULLNAME + +
+           
+static java.lang.StringMYSPACE_NAME + +
+           
+static java.lang.StringNAME + +
+           
+static java.lang.StringPASSWORD + +
+           
+static java.lang.StringPASSWORD_CONFIRMATION + +
+           
+static java.lang.StringPERMALINK + +
+           
+static java.lang.StringTERMS_OF_USE + +
+           
+static java.lang.StringWEBSITE + +
+           
+static java.lang.StringWEBSITE_TITLE + +
+           
+  +

+ + + + + + + + +
+Field Detail
+ +

+NAME

+
+static final java.lang.String NAME
+
+
+
See Also:
Constant Field Values
+
+
+ +

+FULLNAME

+
+static final java.lang.String FULLNAME
+
+
+
See Also:
Constant Field Values
+
+
+ +

+DESCRIPTION

+
+static final java.lang.String DESCRIPTION
+
+
+
See Also:
Constant Field Values
+
+
+ +

+CITY

+
+static final java.lang.String CITY
+
+
+
See Also:
Constant Field Values
+
+
+ +

+PERMALINK

+
+static final java.lang.String PERMALINK
+
+
+
See Also:
Constant Field Values
+
+
+ +

+DISCOGS_NAME

+
+static final java.lang.String DISCOGS_NAME
+
+
+
See Also:
Constant Field Values
+
+
+ +

+MYSPACE_NAME

+
+static final java.lang.String MYSPACE_NAME
+
+
+
See Also:
Constant Field Values
+
+
+ +

+WEBSITE

+
+static final java.lang.String WEBSITE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+WEBSITE_TITLE

+
+static final java.lang.String WEBSITE_TITLE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+EMAIL

+
+static final java.lang.String EMAIL
+
+
+
See Also:
Constant Field Values
+
+
+ +

+PASSWORD

+
+static final java.lang.String PASSWORD
+
+
+
See Also:
Constant Field Values
+
+
+ +

+PASSWORD_CONFIRMATION

+
+static final java.lang.String PASSWORD_CONFIRMATION
+
+
+
See Also:
Constant Field Values
+
+
+ +

+TERMS_OF_USE

+
+static final java.lang.String TERMS_OF_USE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+AVATAR

+
+static final java.lang.String AVATAR
+
+
+
See Also:
Constant Field Values
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/javadoc/1.0.1/com/soundcloud/api/Params.html b/javadoc/1.0.1/com/soundcloud/api/Params.html new file mode 100644 index 0000000..4b7236d --- /dev/null +++ b/javadoc/1.0.1/com/soundcloud/api/Params.html @@ -0,0 +1,201 @@ + + + + + + +Params (SoundCloud Java API Wrapper 1.0.1) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.soundcloud.api +
+Interface Params

+
+
+
public interface Params
+ + +

+Request parameters for various objects. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + +
+Nested Class Summary
+static interfaceParams.Comment + +
+          Comments
+static interfaceParams.Track + +
+          Tracks
+static interfaceParams.User + +
+          Users
+  +

+ +

+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/javadoc/1.0.1/com/soundcloud/api/Request.TransferProgressListener.html b/javadoc/1.0.1/com/soundcloud/api/Request.TransferProgressListener.html new file mode 100644 index 0000000..b3d669d --- /dev/null +++ b/javadoc/1.0.1/com/soundcloud/api/Request.TransferProgressListener.html @@ -0,0 +1,212 @@ + + + + + + +Request.TransferProgressListener (SoundCloud Java API Wrapper 1.0.1) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.soundcloud.api +
+Interface Request.TransferProgressListener

+
+
Enclosing class:
Request
+
+
+
+
public static interface Request.TransferProgressListener
+ + +

+Updates about the amount of bytes already transferred. +

+ +

+

+ +

+ + + + + + + + + + + + +
+Method Summary
+ voidtransferred(long amount) + +
+           
+  +

+ + + + + + + + +
+Method Detail
+ +

+transferred

+
+void transferred(long amount)
+                 throws java.io.IOException
+
+
+
Parameters:
amount - number of bytes already transferred. +
Throws: +
java.io.IOException - if the transfer should be cancelled
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/javadoc/1.0.1/com/soundcloud/api/Request.html b/javadoc/1.0.1/com/soundcloud/api/Request.html new file mode 100644 index 0000000..a14f9f9 --- /dev/null +++ b/javadoc/1.0.1/com/soundcloud/api/Request.html @@ -0,0 +1,749 @@ + + + + + + +Request (SoundCloud Java API Wrapper 1.0.1) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.soundcloud.api +
+Class Request

+
+java.lang.Object
+  extended by com.soundcloud.api.Request
+
+
+
All Implemented Interfaces:
java.lang.Iterable<NameValuePair>
+
+
+
+
public class Request
extends java.lang.Object
implements java.lang.Iterable<NameValuePair>
+ + +

+Convenience class for constructing HTTP requests. + + Example: + + 

+  HttpRequest request = Request.to("/tracks")
+     .with("track[user]", 1234)
+     .withFile("track[asset_data]", new File("track.mp3")
+     .buildRequest(HttpPost.class);
+
+  httpClient.execute(request);
+
+ +

+ +

+

+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static interfaceRequest.TransferProgressListener + +
+          Updates about the amount of bytes already transferred.
+  + + + + + + + + + + + + + + + + +
+Constructor Summary
Request() + +
+          Empty request
Request(Request request) + +
+           
Request(java.lang.String resource) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ Requestadd(java.lang.String name, + java.lang.Object value) + +
+          Adds a key value pair
+ + + + + +
+<T extends org.apache.http.client.methods.HttpRequestBase> +
+T
+		buildRequest(java.lang.Class<T> method) + +
+          Builds a request with the given set of parameters and files.
+ booleanisMultipart() + +
+           
+ java.util.Iterator<NameValuePair>iterator() + +
+           
+ java.lang.StringqueryString() + +
+           
+ RequestsetProgressListener(Request.TransferProgressListener listener) + +
+           
+ intsize() + +
+           
+static Requestto(java.lang.String resource, + java.lang.Object... args) + +
+           
+ java.lang.StringtoString() + +
+           
+ java.lang.StringtoUrl() + +
+           
+ java.lang.StringtoUrl(java.lang.String resource) + +
+           
+ RequestusingToken(Token token) + +
+          The request should be made with a specific token.
+ Requestwith(java.lang.Object... args) + +
+           
+ RequestwithContent(java.lang.String content, + java.lang.String contentType) + +
+          Adds string content to the request (used with POST/PUT)
+ RequestwithEntity(HttpEntity entity) + +
+          Adds an arbitrary entity to the request (used with POST/PUT)
+ RequestwithFile(java.lang.String name, + byte[] data) + +
+          Registers binary data to be uploaded with a POST or PUT request.
+ RequestwithFile(java.lang.String name, + java.nio.ByteBuffer data) + +
+          Registers binary data to be uploaded with a POST or PUT request.
+ RequestwithFile(java.lang.String name, + java.io.File file) + +
+          Registers a file to be uploaded with a POST or PUT request.
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Request

+
+public Request()
+
+
Empty request +

+

+
+ +

+Request

+
+public Request(java.lang.String resource)
+
+
+
Parameters:
resource - the base resource
+
+
+ +

+Request

+
+public Request(Request request)
+
+
+
Parameters:
request - the request to be copied
+
+ + + + + + + + +
+Method Detail
+ +

+to

+
+public static Request to(java.lang.String resource,
+                         java.lang.Object... args)
+
+
+
+
+
+
Parameters:
resource - the resource to request
args - optional string expansion arguments (passed to String#format(String, Object...) +
Returns:
the request +
Throws: +
java.util.IllegalFormatException - - If a format string contains an illegal syntax,
See Also:
String.format(String, Object...)
+
+
+
+ +

+add

+
+public Request add(java.lang.String name,
+                   java.lang.Object value)
+
+
Adds a key value pair +

+

+
+
+
+
Parameters:
name - the name
value - the value +
Returns:
this
+
+
+
+ +

+with

+
+public Request with(java.lang.Object... args)
+
+
+
+
+
+
Parameters:
args - a list of arguments +
Returns:
this
+
+
+
+ +

+usingToken

+
+public Request usingToken(Token token)
+
+
The request should be made with a specific token. +

+

+
+
+
+
Parameters:
token - the token +
Returns:
this
+
+
+
+ +

+size

+
+public int size()
+
+
+
+
+
+ +
Returns:
the size of the parameters
+
+
+
+ +

+queryString

+
+public java.lang.String queryString()
+
+
+
+
+
+ +
Returns:
a String that is suitable for use as an application/x-www-form-urlencoded + list of parameters in an HTTP PUT or HTTP POST.
+
+
+
+ +

+toUrl

+
+public java.lang.String toUrl(java.lang.String resource)
+
+
+
+
+
+
Parameters:
resource - the resource +
Returns:
an URL with the query string parameters appended
+
+
+
+ +

+toUrl

+
+public java.lang.String toUrl()
+
+
+
+
+
+
+
+
+
+ +

+withFile

+
+public Request withFile(java.lang.String name,
+                        java.io.File file)
+
+
Registers a file to be uploaded with a POST or PUT request. +

+

+
+
+
+
Parameters:
name - the name of the parameter
file - the file to be submitted +
Returns:
this
+
+
+
+ +

+withFile

+
+public Request withFile(java.lang.String name,
+                        byte[] data)
+
+
Registers binary data to be uploaded with a POST or PUT request. +

+

+
+
+
+
Parameters:
name - the name of the parameter
data - the data to be submitted +
Returns:
this
+
+
+
+ +

+withFile

+
+public Request withFile(java.lang.String name,
+                        java.nio.ByteBuffer data)
+
+
Registers binary data to be uploaded with a POST or PUT request. +

+

+
+
+
+
Parameters:
name - the name of the parameter
data - the data to be submitted +
Returns:
this
+
+
+
+ +

+withEntity

+
+public Request withEntity(HttpEntity entity)
+
+
Adds an arbitrary entity to the request (used with POST/PUT) +

+

+
+
+
+
Parameters:
entity - the entity to POST/PUT +
Returns:
this
+
+
+
+ +

+withContent

+
+public Request withContent(java.lang.String content,
+                           java.lang.String contentType)
+
+
Adds string content to the request (used with POST/PUT) +

+

+
+
+
+
Parameters:
content - the content to POST/PUT
contentType - the content type +
Returns:
this
+
+
+
+ +

+setProgressListener

+
+public Request setProgressListener(Request.TransferProgressListener listener)
+
+
+
+
+
+
Parameters:
listener - a listener for receiving notifications about transfer progress +
Returns:
this
+
+
+
+ +

+isMultipart

+
+public boolean isMultipart()
+
+
+
+
+
+
+
+
+
+ +

+buildRequest

+
+public <T extends org.apache.http.client.methods.HttpRequestBase> T buildRequest(java.lang.Class<T> method)
+
+
Builds a request with the given set of parameters and files. +

+

+
+
+
+
Type Parameters:
T - the type of request to use
Parameters:
method - the type of request to use +
Returns:
HTTP request, prepared to be executed
+
+
+
+ +

+iterator

+
+public java.util.Iterator<NameValuePair> iterator()
+
+
+
Specified by:
iterator in interface java.lang.Iterable<NameValuePair>
+
+
+
+
+
+
+ +

+toString

+
+public java.lang.String toString()
+
+
+
Overrides:
toString in class java.lang.Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/javadoc/1.0.1/com/soundcloud/api/Token.html b/javadoc/1.0.1/com/soundcloud/api/Token.html new file mode 100644 index 0000000..ba924bf --- /dev/null +++ b/javadoc/1.0.1/com/soundcloud/api/Token.html @@ -0,0 +1,725 @@ + + + + + + +Token (SoundCloud Java API Wrapper 1.0.1) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.soundcloud.api +
+Class Token

+
+java.lang.Object
+  extended by com.soundcloud.api.Token
+
+
+
All Implemented Interfaces:
java.io.Serializable
+
+
+
+
public class Token
extends java.lang.Object
implements java.io.Serializable
+ + +

+Represents an OAuth2 access/refresh token pair. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+ java.lang.Stringaccess + +
+           
+static java.lang.StringACCESS_TOKEN + +
+           
+static java.lang.StringEXPIRES_IN + +
+           
+ longexpiresIn + +
+           
+ java.lang.Stringrefresh + +
+           
+static java.lang.StringREFRESH_TOKEN + +
+           
+ java.lang.Stringscope + +
+           
+static java.lang.StringSCOPE + +
+           
+static java.lang.StringSCOPE_DEFAULT + +
+           
+static java.lang.StringSCOPE_NON_EXPIRING + +
+          Don't expire access token - returned tokens won't include a refresh token
+static java.lang.StringSCOPE_PLAYCOUNT + +
+           
+static java.lang.StringSCOPE_SIGNUP + +
+          Special scope for signup / password recovery
+  + + + + + + + + + + + + + + + + +
+Constructor Summary
Token(JSONObject json) + +
+          Construct a new token from a JSON response
Token(java.lang.String access, + java.lang.String refresh) + +
+          Constructs a new token with the given sub-tokens
Token(java.lang.String access, + java.lang.String refresh, + java.lang.String scope) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ booleandefaultScoped() + +
+           
+ booleanequals(java.lang.Object o) + +
+           
+ java.util.DategetExpiresIn() + +
+           
+ inthashCode() + +
+           
+ voidinvalidate() + +
+          Invalidates the access token
+ booleanscoped(java.lang.String scope) + +
+           
+ booleansignupScoped() + +
+           
+ java.lang.StringtoString() + +
+           
+ booleanvalid() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+ACCESS_TOKEN

+
+public static final java.lang.String ACCESS_TOKEN
+
+
+
See Also:
Constant Field Values
+
+
+ +

+REFRESH_TOKEN

+
+public static final java.lang.String REFRESH_TOKEN
+
+
+
See Also:
Constant Field Values
+
+
+ +

+SCOPE

+
+public static final java.lang.String SCOPE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+EXPIRES_IN

+
+public static final java.lang.String EXPIRES_IN
+
+
+
See Also:
Constant Field Values
+
+
+ +

+SCOPE_DEFAULT

+
+public static final java.lang.String SCOPE_DEFAULT
+
+
+
See Also:
Constant Field Values
+
+
+ +

+SCOPE_SIGNUP

+
+public static final java.lang.String SCOPE_SIGNUP
+
+
Special scope for signup / password recovery +

+

+
See Also:
Constant Field Values
+
+
+ +

+SCOPE_PLAYCOUNT

+
+public static final java.lang.String SCOPE_PLAYCOUNT
+
+
+
See Also:
Constant Field Values
+
+
+ +

+SCOPE_NON_EXPIRING

+
+public static final java.lang.String SCOPE_NON_EXPIRING
+
+
Don't expire access token - returned tokens won't include a refresh token +

+

+
See Also:
Constant Field Values
+
+
+ +

+access

+
+public java.lang.String access
+
+
+
+
+
+ +

+refresh

+
+public java.lang.String refresh
+
+
+
+
+
+ +

+scope

+
+public java.lang.String scope
+
+
+
+
+
+ +

+expiresIn

+
+public long expiresIn
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+Token

+
+public Token(java.lang.String access,
+             java.lang.String refresh)
+
+
Constructs a new token with the given sub-tokens +

+

+
Parameters:
access - A token used by the client to make authenticated requests on behalf of the resource owner.
refresh - A token used by the client to obtain a new access token without having + to involve the resource owner.
+
+
+ +

+Token

+
+public Token(java.lang.String access,
+             java.lang.String refresh,
+             java.lang.String scope)
+
+
+
+ +

+Token

+
+public Token(JSONObject json)
+      throws java.io.IOException
+
+
Construct a new token from a JSON response +

+

+
Parameters:
json - the json response +
Throws: +
java.io.IOException - JSON format error
+
+ + + + + + + + +
+Method Detail
+ +

+invalidate

+
+public void invalidate()
+
+
Invalidates the access token +

+

+
+
+
+
+
+
+
+ +

+getExpiresIn

+
+public java.util.Date getExpiresIn()
+
+
+
+
+
+ +
Returns:
null or the date of expiration of this token
+
+
+
+ +

+defaultScoped

+
+public boolean defaultScoped()
+
+
+
+
+
+
+
+
+
+ +

+signupScoped

+
+public boolean signupScoped()
+
+
+
+
+
+ +
Returns:
has token the signup scope ("signup")
+
+
+
+ +

+scoped

+
+public boolean scoped(java.lang.String scope)
+
+
+
+
+
+
+
+
+
+ +

+valid

+
+public boolean valid()
+
+
+
+
+
+ +
Returns:
is this token valid
+
+
+
+ +

+toString

+
+public java.lang.String toString()
+
+
+
Overrides:
toString in class java.lang.Object
+
+
+
+
+
+
+ +

+equals

+
+public boolean equals(java.lang.Object o)
+
+
+
Overrides:
equals in class java.lang.Object
+
+
+
+
+
+
+ +

+hashCode

+
+public int hashCode()
+
+
+
Overrides:
hashCode in class java.lang.Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/javadoc/1.0.1/com/soundcloud/api/package-frame.html b/javadoc/1.0.1/com/soundcloud/api/package-frame.html new file mode 100644 index 0000000..f1d46e7 --- /dev/null +++ b/javadoc/1.0.1/com/soundcloud/api/package-frame.html @@ -0,0 +1,85 @@ + + + + + + +com.soundcloud.api (SoundCloud Java API Wrapper 1.0.1) + + + + + + + + + + + +com.soundcloud.api + + + + +
+Interfaces  + +
+CloudAPI +
+CloudAPI.TokenListener +
+Endpoints +
+Params +
+Params.Comment +
+Params.Track +
+Params.User +
+Request.TransferProgressListener
+ + + + + + +
+Classes  + +
+ApiWrapper +
+Http +
+Request +
+Token
+ + + + + + +
+Enums  + +
+Env
+ + + + + + +
+Exceptions  + +
+CloudAPI.InvalidTokenException
+ + + + diff --git a/javadoc/1.0.1/com/soundcloud/api/package-summary.html b/javadoc/1.0.1/com/soundcloud/api/package-summary.html new file mode 100644 index 0000000..ab45a6f --- /dev/null +++ b/javadoc/1.0.1/com/soundcloud/api/package-summary.html @@ -0,0 +1,257 @@ + + + + + + +com.soundcloud.api (SoundCloud Java API Wrapper 1.0.1) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.soundcloud.api +

+Provides an API Wrapper to access the + SoundCloud API. +

+See: +
+          Description +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Interface Summary
CloudAPIInterface with SoundCloud, using OAuth2.
CloudAPI.TokenListenerInterested in changes to the current token.
EndpointsVarious SoundCloud API endpoints.
ParamsRequest parameters for various objects.
Params.CommentComments
Params.TrackTracks
Params.UserUsers
Request.TransferProgressListenerUpdates about the amount of bytes already transferred.
+  + +

+ + + + + + + + + + + + + + + + + + + + + +
+Class Summary
ApiWrapperInterface with SoundCloud, using OAuth2.
HttpHelper class for various HTTP related functions.
RequestConvenience class for constructing HTTP requests.
TokenRepresents an OAuth2 access/refresh token pair.
+  + +

+ + + + + + + + + +
+Enum Summary
EnvThe environment to operate against.
+  + +

+ + + + + + + + + +
+Exception Summary
CloudAPI.InvalidTokenExceptionThrown when token is not valid.
+  + +

+

+Package com.soundcloud.api Description +

+ +

+Provides an API Wrapper to access the + SoundCloud API. + + See the project README for more + information. +

+ +

+

+
Version:
+
1.0.1, 07/04/11
+
See Also:
ApiWrapper
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/javadoc/1.0.1/com/soundcloud/api/package-tree.html b/javadoc/1.0.1/com/soundcloud/api/package-tree.html new file mode 100644 index 0000000..081728a --- /dev/null +++ b/javadoc/1.0.1/com/soundcloud/api/package-tree.html @@ -0,0 +1,171 @@ + + + + + + +com.soundcloud.api Class Hierarchy (SoundCloud Java API Wrapper 1.0.1) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.soundcloud.api +

+
+

+Class Hierarchy +

+
    +
  • java.lang.Object
      +
    • com.soundcloud.api.ApiWrapper (implements com.soundcloud.api.CloudAPI, java.io.Serializable) +
    • com.soundcloud.api.Http
    • com.soundcloud.api.Request (implements java.lang.Iterable<T>) +
    • java.lang.Throwable (implements java.io.Serializable) + +
    • com.soundcloud.api.Token (implements java.io.Serializable) +
    +
+

+Interface Hierarchy +

+ +

+Enum Hierarchy +

+
    +
  • java.lang.Object
      +
    • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) +
        +
      • com.soundcloud.api.Env
      +
    +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/javadoc/1.0.1/constant-values.html b/javadoc/1.0.1/constant-values.html new file mode 100644 index 0000000..1d10b35 --- /dev/null +++ b/javadoc/1.0.1/constant-values.html @@ -0,0 +1,824 @@ + + + + + + +Constant Field Values (SoundCloud Java API Wrapper 1.0.1) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Constant Field Values

+
+
+Contents + + + + + + +
+com.soundcloud.*
+ +

+ + + + + + + + + + + + +
com.soundcloud.api.ApiWrapper
+public static final java.lang.StringDEFAULT_CONTENT_TYPE"application/json"
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
com.soundcloud.api.CloudAPI
+public static final java.lang.StringAUTHORIZATION_CODE"authorization_code"
+public static final java.lang.StringCLIENT_CREDENTIALS"client_credentials"
+public static final java.lang.StringOAUTH_SCHEME"oauth"
+public static final java.lang.StringOAUTH1_TOKEN"oauth1_token"
+public static final java.lang.StringPASSWORD"password"
+public static final java.lang.StringREALM"SoundCloud"
+public static final java.lang.StringREFRESH_TOKEN"refresh_token"
+public static final java.lang.StringUSER_AGENT"SoundCloud Java Wrapper (1.0.1)"
+public static final java.lang.StringVERSION"1.0.1"
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
com.soundcloud.api.Endpoints
+public static final java.lang.StringCONNECT"/connect"
+public static final java.lang.StringFACEBOOK_CONNECT"/connect/via/facebook"
+public static final java.lang.StringMY_ACTIVITIES"/me/activities/tracks"
+public static final java.lang.StringMY_CONFIRMATION"/me/email-confirmations"
+public static final java.lang.StringMY_CONNECTIONS"/me/connections"
+public static final java.lang.StringMY_DETAILS"/me"
+public static final java.lang.StringMY_EXCLUSIVE_TRACKS"/me/activities/tracks/exclusive"
+public static final java.lang.StringMY_FAVORITE"/me/favorites/%d"
+public static final java.lang.StringMY_FAVORITES"/me/favorites"
+public static final java.lang.StringMY_FOLLOWER"/me/followers/%d"
+public static final java.lang.StringMY_FOLLOWERS"/me/followers"
+public static final java.lang.StringMY_FOLLOWING"/me/followings/%d"
+public static final java.lang.StringMY_FOLLOWINGS"/me/followings"
+public static final java.lang.StringMY_FRIENDS"/me/connections/friends"
+public static final java.lang.StringMY_PLAYLISTS"/me/playlists"
+public static final java.lang.StringMY_TRACKS"/me/tracks"
+public static final java.lang.StringRESOLVE"/resolve"
+public static final java.lang.StringSEND_PASSWORD"/passwords/reset-instructions"
+public static final java.lang.StringSUGGESTED_USERS"/users/suggested"
+public static final java.lang.StringTOKEN"/oauth2/token"
+public static final java.lang.StringTRACK_COMMENTS"/tracks/%d/comments"
+public static final java.lang.StringTRACK_DETAILS"/tracks/%d"
+public static final java.lang.StringTRACKS"/tracks"
+public static final java.lang.StringUSER_DETAILS"/users/%d"
+public static final java.lang.StringUSER_FAVORITES"/users/%d/favorites"
+public static final java.lang.StringUSER_FOLLOWERS"/users/%d/followers"
+public static final java.lang.StringUSER_FOLLOWINGS"/users/%d/followings"
+public static final java.lang.StringUSER_PLAYLISTS"/users/%d/playlists"
+public static final java.lang.StringUSER_TRACKS"/users/%d/tracks"
+public static final java.lang.StringUSERS"/users"
+ +

+ +

+ + + + + + + + + + + + + + + + + +
com.soundcloud.api.Http
+public static final intBUFFER_SIZE8192
+public static final intTIMEOUT20000
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + +
com.soundcloud.api.Params.Comment
+public static final java.lang.StringBODY"comment[body]"
+public static final java.lang.StringREPLY_TO"comment[reply_to]"
+public static final java.lang.StringTIMESTAMP"comment[timestamp]"
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
com.soundcloud.api.Params.Track
+public static final java.lang.StringARTWORK_DATA"track[artwork_data]"
+public static final java.lang.StringASSET_DATA"track[asset_data]"
+public static final java.lang.StringBPM"track[bpm]"
+public static final java.lang.StringDESCRIPTION"track[description]"
+public static final java.lang.StringDOWNLOADABLE"track[downloadable]"
+public static final java.lang.StringGENRE"track[genre]"
+public static final java.lang.StringISRC"track[isrc]"
+public static final java.lang.StringKEY_SIGNATURE"track[key_signature]"
+public static final java.lang.StringLABEL_ID"track[label_id]"
+public static final java.lang.StringLABEL_NAME"track[label_name]"
+public static final java.lang.StringLICENSE"track[license]"
+public static final java.lang.StringPERMALINK"track[permalink]"
+public static final java.lang.StringPOST_TO"track[post_to][][id]"
+public static final java.lang.StringPOST_TO_EMPTY"track[post_to][]"
+public static final java.lang.StringPRIVATE"private"
+public static final java.lang.StringPUBLIC"public"
+public static final java.lang.StringPURCHASE_URL"track[purchase_url]"
+public static final java.lang.StringRELEASE"track[release]"
+public static final java.lang.StringRELEASE_DAY"track[release_day]"
+public static final java.lang.StringRELEASE_MONTH"track[release_month]"
+public static final java.lang.StringRELEASE_YEAR"track[release_year]"
+public static final java.lang.StringSHARED_EMAILS"track[shared_to][emails][][address]"
+public static final java.lang.StringSHARING"track[sharing]"
+public static final java.lang.StringSHARING_NOTE"track[sharing_note]"
+public static final java.lang.StringSTREAMABLE"track[streamable]"
+public static final java.lang.StringTAG_LIST"track[tag_list]"
+public static final java.lang.StringTITLE"track[title]"
+public static final java.lang.StringTYPE"track[track_type]"
+public static final java.lang.StringVIDEO_URL"track[video_url]"
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
com.soundcloud.api.Params.User
+public static final java.lang.StringAVATAR"user[avatar_data]"
+public static final java.lang.StringCITY"user[city]"
+public static final java.lang.StringDESCRIPTION"user[description]"
+public static final java.lang.StringDISCOGS_NAME"user[discogs_name]"
+public static final java.lang.StringEMAIL"user[email]"
+public static final java.lang.StringFULLNAME"user[full_name]"
+public static final java.lang.StringMYSPACE_NAME"user[myspace_name]"
+public static final java.lang.StringNAME"user[username]"
+public static final java.lang.StringPASSWORD"user[password]"
+public static final java.lang.StringPASSWORD_CONFIRMATION"user[password_confirmation]"
+public static final java.lang.StringPERMALINK"user[permalink]"
+public static final java.lang.StringTERMS_OF_USE"user[terms_of_use]"
+public static final java.lang.StringWEBSITE"user[website]"
+public static final java.lang.StringWEBSITE_TITLE"user[website_title]"
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
com.soundcloud.api.Token
+public static final java.lang.StringACCESS_TOKEN"access_token"
+public static final java.lang.StringEXPIRES_IN"expires_in"
+public static final java.lang.StringREFRESH_TOKEN"refresh_token"
+public static final java.lang.StringSCOPE"scope"
+public static final java.lang.StringSCOPE_DEFAULT"*"
+public static final java.lang.StringSCOPE_NON_EXPIRING"non-expiring"
+public static final java.lang.StringSCOPE_PLAYCOUNT"playcount"
+public static final java.lang.StringSCOPE_SIGNUP"signup"
+ +

+ +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/javadoc/1.0.1/deprecated-list.html b/javadoc/1.0.1/deprecated-list.html new file mode 100644 index 0000000..9531bca --- /dev/null +++ b/javadoc/1.0.1/deprecated-list.html @@ -0,0 +1,142 @@ + + + + + + +Deprecated List (SoundCloud Java API Wrapper 1.0.1) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree   Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Deprecated API

+
+
+Contents
    +
+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree   Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/javadoc/1.0.1/help-doc.html b/javadoc/1.0.1/help-doc.html new file mode 100644 index 0000000..05cc41b --- /dev/null +++ b/javadoc/1.0.1/help-doc.html @@ -0,0 +1,209 @@ + + + + + + +API Help (SoundCloud Java API Wrapper 1.0.1) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree  Deprecated  Index   Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+How This API Document Is Organized

+
+This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

+Package

+
+ +

+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

    +
  • Interfaces (italic)
  • Classes
  • Enums
  • Exceptions
  • Errors
  • Annotation Types
+
+

+Class/Interface

+
+ +

+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

    +
  • Class inheritance diagram
  • Direct Subclasses
  • All Known Subinterfaces
  • All Known Implementing Classes
  • Class/interface declaration
  • Class/interface description +

    +

  • Nested Class Summary
  • Field Summary
  • Constructor Summary
  • Method Summary +

    +

  • Field Detail
  • Constructor Detail
  • Method Detail
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+ +

+Annotation Type

+
+ +

+Each annotation type has its own separate page with the following sections:

    +
  • Annotation Type declaration
  • Annotation Type description
  • Required Element Summary
  • Optional Element Summary
  • Element Detail
+
+ +

+Enum

+
+ +

+Each enum has its own separate page with the following sections:

    +
  • Enum declaration
  • Enum description
  • Enum Constant Summary
  • Enum Constant Detail
+
+

+Tree (Class Hierarchy)

+
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
    +
  • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
  • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
+
+

+Deprecated API

+
+The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+

+Index

+
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+

+Prev/Next

+These links take you to the next or previous class, interface, package, or related page.

+Frames/No Frames

+These links show and hide the HTML frames. All pages are available with or without frames. +

+

+Serialized Form

+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

+

+Constant Field Values

+The Constant Field Values page lists the static final fields and their values. +

+ + +This help file applies to API documentation generated using the standard doclet. + +
+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree  Deprecated  Index   Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/javadoc/1.0.1/index-all.html b/javadoc/1.0.1/index-all.html new file mode 100644 index 0000000..2efdcd2 --- /dev/null +++ b/javadoc/1.0.1/index-all.html @@ -0,0 +1,874 @@ + + + + + + +Index (SoundCloud Java API Wrapper 1.0.1) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree  Deprecated   Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I K L M N O P Q R S T U V W
+

+A

+
+
access - +Variable in class com.soundcloud.api.Token +
  +
ACCESS_TOKEN - +Static variable in class com.soundcloud.api.Token +
  +
add(String, Object) - +Method in class com.soundcloud.api.Request +
Adds a key value pair +
addAcceptHeader(HttpRequest) - +Method in class com.soundcloud.api.ApiWrapper +
Forces JSON +
addAuthHeader(HttpRequest) - +Method in class com.soundcloud.api.ApiWrapper +
Adds an OAuth2 header to a given request +
addHeaders(HttpRequest) - +Method in class com.soundcloud.api.ApiWrapper +
Adds all required headers to the request +
ApiWrapper - Class in com.soundcloud.api
Interface with SoundCloud, using OAuth2.
ApiWrapper(String, String, URI, Token, Env) - +Constructor for class com.soundcloud.api.ApiWrapper +
Constructs a new ApiWrapper instance. +
ARTWORK_DATA - +Static variable in interface com.soundcloud.api.Params.Track +
  +
ASSET_DATA - +Static variable in interface com.soundcloud.api.Params.Track +
  +
AUTHORIZATION_CODE - +Static variable in interface com.soundcloud.api.CloudAPI +
  +
authorizationCode(String) - +Method in class com.soundcloud.api.ApiWrapper +
  +
authorizationCode(String, String) - +Method in class com.soundcloud.api.ApiWrapper +
  +
authorizationCode(String) - +Method in interface com.soundcloud.api.CloudAPI +
Request a token using + Authorization Code, requesting a default scope. +
authorizationCode(String, String) - +Method in interface com.soundcloud.api.CloudAPI +
Request a token using + Authorization Code with a specified scope. +
authorizationCodeUrl(String...) - +Method in class com.soundcloud.api.ApiWrapper +
  +
authorizationCodeUrl(String...) - +Method in interface com.soundcloud.api.CloudAPI +
Request login via authorization code + After login, control will go to the redirect URI (wrapper specific), with + one of the following query parameters appended: + + code in case of success, this will contain the code used for the + authorizationCode call to obtain the access token. +
authResourceHost - +Variable in enum com.soundcloud.api.Env +
  +
AVATAR - +Static variable in interface com.soundcloud.api.Params.User +
  +
+
+

+B

+
+
BODY - +Static variable in interface com.soundcloud.api.Params.Comment +
  +
BPM - +Static variable in interface com.soundcloud.api.Params.Track +
  +
BUFFER_SIZE - +Static variable in class com.soundcloud.api.Http +
  +
buildRequest(Class<T>) - +Method in class com.soundcloud.api.Request +
Builds a request with the given set of parameters and files. +
+
+

+C

+
+
CITY - +Static variable in interface com.soundcloud.api.Params.User +
  +
CLIENT_CREDENTIALS - +Static variable in interface com.soundcloud.api.CloudAPI +
  +
clientCredentials() - +Method in class com.soundcloud.api.ApiWrapper +
  +
clientCredentials(String) - +Method in class com.soundcloud.api.ApiWrapper +
  +
clientCredentials() - +Method in interface com.soundcloud.api.CloudAPI +
Request a "signup" token using + Client Credentials. +
clientCredentials(String) - +Method in interface com.soundcloud.api.CloudAPI +
Requests a token using + Client Credentials. +
CloudAPI - Interface in com.soundcloud.api
Interface with SoundCloud, using OAuth2.
CloudAPI.InvalidTokenException - Exception in com.soundcloud.api
Thrown when token is not valid.
CloudAPI.InvalidTokenException(int, String) - +Constructor for exception com.soundcloud.api.CloudAPI.InvalidTokenException +
  +
CloudAPI.TokenListener - Interface in com.soundcloud.api
Interested in changes to the current token.
com.soundcloud.api - package com.soundcloud.api
Provides an API Wrapper to access the + SoundCloud API.
CONNECT - +Static variable in interface com.soundcloud.api.Endpoints +
  +
createOAuthHeader(Token) - +Static method in class com.soundcloud.api.ApiWrapper +
Creates an OAuth2 header for the given token +
+
+

+D

+
+
debugRequests - +Variable in class com.soundcloud.api.ApiWrapper +
debug request details to stderr +
DEFAULT_CONTENT_TYPE - +Static variable in class com.soundcloud.api.ApiWrapper +
  +
defaultParams() - +Static method in class com.soundcloud.api.Http +
  +
defaultScoped() - +Method in class com.soundcloud.api.Token +
  +
delete(Request) - +Method in class com.soundcloud.api.ApiWrapper +
  +
delete(Request) - +Method in interface com.soundcloud.api.CloudAPI +
  +
DESCRIPTION - +Static variable in interface com.soundcloud.api.Params.Track +
  +
DESCRIPTION - +Static variable in interface com.soundcloud.api.Params.User +
  +
DISCOGS_NAME - +Static variable in interface com.soundcloud.api.Params.User +
  +
DOWNLOADABLE - +Static variable in interface com.soundcloud.api.Params.Track +
  +
+
+

+E

+
+
EMAIL - +Static variable in interface com.soundcloud.api.Params.User +
  +
Endpoints - Interface in com.soundcloud.api
Various SoundCloud API endpoints.
env - +Variable in class com.soundcloud.api.ApiWrapper +
The current environment +
Env - Enum in com.soundcloud.api
The environment to operate against.
equals(Object) - +Method in class com.soundcloud.api.Token +
  +
exchangeOAuth1Token(String) - +Method in class com.soundcloud.api.ApiWrapper +
  +
exchangeOAuth1Token(String) - +Method in interface com.soundcloud.api.CloudAPI +
Exchange an OAuth1 Token for new OAuth2 tokens. +
execute(HttpRequest) - +Method in class com.soundcloud.api.ApiWrapper +
Execute an API request, adds the necessary headers. +
execute(Request, Class<? extends HttpRequestBase>) - +Method in class com.soundcloud.api.ApiWrapper +
  +
EXPIRES_IN - +Static variable in class com.soundcloud.api.Token +
  +
expiresIn - +Variable in class com.soundcloud.api.Token +
  +
+
+

+F

+
+
FACEBOOK_CONNECT - +Static variable in interface com.soundcloud.api.Endpoints +
  +
fromFile(File) - +Static method in class com.soundcloud.api.ApiWrapper +
Read wrapper from a file +
FULLNAME - +Static variable in interface com.soundcloud.api.Params.User +
  +
+
+

+G

+
+
GENRE - +Static variable in interface com.soundcloud.api.Params.Track +
  +
get(Request) - +Method in class com.soundcloud.api.ApiWrapper +
  +
get(Request) - +Method in interface com.soundcloud.api.CloudAPI +
  +
getAuthResourceHost(boolean) - +Method in enum com.soundcloud.api.Env +
  +
getDefaultContentType() - +Method in class com.soundcloud.api.ApiWrapper +
  +
getExpiresIn() - +Method in class com.soundcloud.api.Token +
  +
getHttpClient() - +Method in class com.soundcloud.api.ApiWrapper +
  +
getJSON(HttpResponse) - +Static method in class com.soundcloud.api.Http +
  +
getParams() - +Method in class com.soundcloud.api.ApiWrapper +
  +
getRequestDirector(HttpRequestExecutor, ClientConnectionManager, ConnectionReuseStrategy, ConnectionKeepAliveStrategy, HttpRoutePlanner, HttpProcessor, HttpRequestRetryHandler, RedirectHandler, AuthenticationHandler, AuthenticationHandler, UserTokenHandler, HttpParams) - +Method in class com.soundcloud.api.ApiWrapper +
This method mainly exists to make the wrapper more testable. +
getResourceHost(boolean) - +Method in enum com.soundcloud.api.Env +
  +
getSocketFactory() - +Method in class com.soundcloud.api.ApiWrapper +
  +
getSSLSocketFactory() - +Method in class com.soundcloud.api.ApiWrapper +
  +
getString(HttpResponse) - +Static method in class com.soundcloud.api.Http +
Returns a String representation of the response +
getToken() - +Method in class com.soundcloud.api.ApiWrapper +
  +
getToken() - +Method in interface com.soundcloud.api.CloudAPI +
  +
getURI(Request, boolean, boolean) - +Method in class com.soundcloud.api.ApiWrapper +
Constructs URI path for a given resource. +
getUserAgent() - +Method in class com.soundcloud.api.ApiWrapper +
User-Agent to identify ourselves with - defaults to USER_AGENT +
+
+

+H

+
+
hashCode() - +Method in class com.soundcloud.api.Token +
  +
Http - Class in com.soundcloud.api
Helper class for various HTTP related functions.
+
+

+I

+
+
invalidate() - +Method in class com.soundcloud.api.Token +
Invalidates the access token +
invalidateToken() - +Method in class com.soundcloud.api.ApiWrapper +
  +
invalidateToken() - +Method in interface com.soundcloud.api.CloudAPI +
This method should be called when the token was found to be invalid. +
isMultipart() - +Method in class com.soundcloud.api.Request +
  +
ISRC - +Static variable in interface com.soundcloud.api.Params.Track +
  +
iterator() - +Method in class com.soundcloud.api.Request +
  +
+
+

+K

+
+
KEY_SIGNATURE - +Static variable in interface com.soundcloud.api.Params.Track +
  +
+
+

+L

+
+
LABEL_ID - +Static variable in interface com.soundcloud.api.Params.Track +
  +
LABEL_NAME - +Static variable in interface com.soundcloud.api.Params.Track +
  +
LICENSE - +Static variable in interface com.soundcloud.api.Params.Track +
  +
login(String, String) - +Method in class com.soundcloud.api.ApiWrapper +
  +
login(String, String, String) - +Method in class com.soundcloud.api.ApiWrapper +
  +
login(String, String) - +Method in interface com.soundcloud.api.CloudAPI +
Request a token using + Resource Owner Password Credentials. +
login(String, String, String) - +Method in interface com.soundcloud.api.CloudAPI +
Request a token using + Resource Owner Password Credentials. +
+
+

+M

+
+
MY_ACTIVITIES - +Static variable in interface com.soundcloud.api.Endpoints +
  +
MY_CONFIRMATION - +Static variable in interface com.soundcloud.api.Endpoints +
  +
MY_CONNECTIONS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
MY_DETAILS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
MY_EXCLUSIVE_TRACKS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
MY_FAVORITE - +Static variable in interface com.soundcloud.api.Endpoints +
  +
MY_FAVORITES - +Static variable in interface com.soundcloud.api.Endpoints +
  +
MY_FOLLOWER - +Static variable in interface com.soundcloud.api.Endpoints +
  +
MY_FOLLOWERS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
MY_FOLLOWING - +Static variable in interface com.soundcloud.api.Endpoints +
  +
MY_FOLLOWINGS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
MY_FRIENDS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
MY_PLAYLISTS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
MY_TRACKS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
MYSPACE_NAME - +Static variable in interface com.soundcloud.api.Params.User +
  +
+
+

+N

+
+
NAME - +Static variable in interface com.soundcloud.api.Params.User +
  +
+
+

+O

+
+
OAUTH1_TOKEN - +Static variable in interface com.soundcloud.api.CloudAPI +
  +
OAUTH_SCHEME - +Static variable in interface com.soundcloud.api.CloudAPI +
  +
onTokenInvalid(Token) - +Method in interface com.soundcloud.api.CloudAPI.TokenListener +
Called when token was found to be invalid +
onTokenRefreshed(Token) - +Method in interface com.soundcloud.api.CloudAPI.TokenListener +
Called when the token got successfully refreshed +
+
+

+P

+
+
Params - Interface in com.soundcloud.api
Request parameters for various objects.
Params.Comment - Interface in com.soundcloud.api
Comments
Params.Track - Interface in com.soundcloud.api
Tracks
Params.User - Interface in com.soundcloud.api
Users
PASSWORD - +Static variable in interface com.soundcloud.api.CloudAPI +
  +
PASSWORD - +Static variable in interface com.soundcloud.api.Params.User +
  +
PASSWORD_CONFIRMATION - +Static variable in interface com.soundcloud.api.Params.User +
  +
PERMALINK - +Static variable in interface com.soundcloud.api.Params.Track +
  +
PERMALINK - +Static variable in interface com.soundcloud.api.Params.User +
  +
post(Request) - +Method in class com.soundcloud.api.ApiWrapper +
  +
post(Request) - +Method in interface com.soundcloud.api.CloudAPI +
  +
POST_TO - +Static variable in interface com.soundcloud.api.Params.Track +
  +
POST_TO_EMPTY - +Static variable in interface com.soundcloud.api.Params.Track +
  +
PRIVATE - +Static variable in interface com.soundcloud.api.Params.Track +
  +
PUBLIC - +Static variable in interface com.soundcloud.api.Params.Track +
  +
PURCHASE_URL - +Static variable in interface com.soundcloud.api.Params.Track +
  +
put(Request) - +Method in class com.soundcloud.api.ApiWrapper +
  +
put(Request) - +Method in interface com.soundcloud.api.CloudAPI +
  +
+
+

+Q

+
+
queryString() - +Method in class com.soundcloud.api.Request +
  +
+
+

+R

+
+
REALM - +Static variable in interface com.soundcloud.api.CloudAPI +
  +
refresh - +Variable in class com.soundcloud.api.Token +
  +
REFRESH_TOKEN - +Static variable in interface com.soundcloud.api.CloudAPI +
  +
REFRESH_TOKEN - +Static variable in class com.soundcloud.api.Token +
  +
refreshToken() - +Method in class com.soundcloud.api.ApiWrapper +
  +
refreshToken() - +Method in interface com.soundcloud.api.CloudAPI +
Tries to refresh the currently used access token with the refresh token. +
RELEASE - +Static variable in interface com.soundcloud.api.Params.Track +
  +
RELEASE_DAY - +Static variable in interface com.soundcloud.api.Params.Track +
  +
RELEASE_MONTH - +Static variable in interface com.soundcloud.api.Params.Track +
  +
RELEASE_YEAR - +Static variable in interface com.soundcloud.api.Params.Track +
  +
REPLY_TO - +Static variable in interface com.soundcloud.api.Params.Comment +
  +
Request - Class in com.soundcloud.api
Convenience class for constructing HTTP requests.
Request() - +Constructor for class com.soundcloud.api.Request +
Empty request +
Request(String) - +Constructor for class com.soundcloud.api.Request +
  +
Request(Request) - +Constructor for class com.soundcloud.api.Request +
  +
Request.TransferProgressListener - Interface in com.soundcloud.api
Updates about the amount of bytes already transferred.
requestToken(Request) - +Method in class com.soundcloud.api.ApiWrapper +
Request an OAuth2 token from SoundCloud +
resolve(String) - +Method in class com.soundcloud.api.ApiWrapper +
  +
resolve(String) - +Method in interface com.soundcloud.api.CloudAPI +
Resolve the given SoundCloud URI +
RESOLVE - +Static variable in interface com.soundcloud.api.Endpoints +
  +
resourceHost - +Variable in enum com.soundcloud.api.Env +
  +
+
+

+S

+
+
SCOPE - +Static variable in class com.soundcloud.api.Token +
  +
scope - +Variable in class com.soundcloud.api.Token +
  +
SCOPE_DEFAULT - +Static variable in class com.soundcloud.api.Token +
  +
SCOPE_NON_EXPIRING - +Static variable in class com.soundcloud.api.Token +
Don't expire access token - returned tokens won't include a refresh token +
SCOPE_PLAYCOUNT - +Static variable in class com.soundcloud.api.Token +
  +
SCOPE_SIGNUP - +Static variable in class com.soundcloud.api.Token +
Special scope for signup / password recovery +
scoped(String) - +Method in class com.soundcloud.api.Token +
  +
SEND_PASSWORD - +Static variable in interface com.soundcloud.api.Endpoints +
  +
setDefaultContentType(String) - +Method in class com.soundcloud.api.ApiWrapper +
  +
setDefaultContentType(String) - +Method in interface com.soundcloud.api.CloudAPI +
Changes the default content type sent in the "Accept" header. +
setProgressListener(Request.TransferProgressListener) - +Method in class com.soundcloud.api.Request +
  +
setToken(Token) - +Method in class com.soundcloud.api.ApiWrapper +
  +
setToken(Token) - +Method in interface com.soundcloud.api.CloudAPI +
  +
setTokenListener(CloudAPI.TokenListener) - +Method in class com.soundcloud.api.ApiWrapper +
  +
setTokenListener(CloudAPI.TokenListener) - +Method in interface com.soundcloud.api.CloudAPI +
Registers a listener. +
SHARED_EMAILS - +Static variable in interface com.soundcloud.api.Params.Track +
  +
SHARING - +Static variable in interface com.soundcloud.api.Params.Track +
  +
SHARING_NOTE - +Static variable in interface com.soundcloud.api.Params.Track +
  +
signupScoped() - +Method in class com.soundcloud.api.Token +
  +
size() - +Method in class com.soundcloud.api.Request +
  +
sslAuthResourceHost - +Variable in enum com.soundcloud.api.Env +
  +
sslResourceHost - +Variable in enum com.soundcloud.api.Env +
  +
STREAMABLE - +Static variable in interface com.soundcloud.api.Params.Track +
  +
SUGGESTED_USERS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
+
+

+T

+
+
TAG_LIST - +Static variable in interface com.soundcloud.api.Params.Track +
  +
TERMS_OF_USE - +Static variable in interface com.soundcloud.api.Params.User +
  +
TIMEOUT - +Static variable in class com.soundcloud.api.Http +
Connection timeout +
TIMESTAMP - +Static variable in interface com.soundcloud.api.Params.Comment +
  +
TITLE - +Static variable in interface com.soundcloud.api.Params.Track +
  +
to(String, Object...) - +Static method in class com.soundcloud.api.Request +
  +
toFile(File) - +Method in class com.soundcloud.api.ApiWrapper +
serialize the wrapper to a File +
TOKEN - +Static variable in interface com.soundcloud.api.Endpoints +
  +
Token - Class in com.soundcloud.api
Represents an OAuth2 access/refresh token pair.
Token(String, String) - +Constructor for class com.soundcloud.api.Token +
Constructs a new token with the given sub-tokens +
Token(String, String, String) - +Constructor for class com.soundcloud.api.Token +
  +
Token(JSONObject) - +Constructor for class com.soundcloud.api.Token +
Construct a new token from a JSON response +
toString() - +Method in class com.soundcloud.api.Request +
  +
toString() - +Method in class com.soundcloud.api.Token +
  +
toUrl(String) - +Method in class com.soundcloud.api.Request +
  +
toUrl() - +Method in class com.soundcloud.api.Request +
  +
TRACK_COMMENTS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
TRACK_DETAILS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
TRACKS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
transferred(long) - +Method in interface com.soundcloud.api.Request.TransferProgressListener +
  +
TYPE - +Static variable in interface com.soundcloud.api.Params.Track +
  +
+
+

+U

+
+
USER_AGENT - +Static variable in interface com.soundcloud.api.CloudAPI +
  +
USER_DETAILS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
USER_FAVORITES - +Static variable in interface com.soundcloud.api.Endpoints +
  +
USER_FOLLOWERS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
USER_FOLLOWINGS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
USER_PLAYLISTS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
USER_TRACKS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
USERS - +Static variable in interface com.soundcloud.api.Endpoints +
  +
usingToken(Token) - +Method in class com.soundcloud.api.Request +
The request should be made with a specific token. +
+
+

+V

+
+
valid() - +Method in class com.soundcloud.api.Token +
  +
valueOf(String) - +Static method in enum com.soundcloud.api.Env +
Returns the enum constant of this type with the specified name. +
values() - +Static method in enum com.soundcloud.api.Env +
Returns an array containing the constants of this enum type, in +the order they are declared. +
VERSION - +Static variable in interface com.soundcloud.api.CloudAPI +
  +
VIDEO_URL - +Static variable in interface com.soundcloud.api.Params.Track +
  +
+
+

+W

+
+
WEBSITE - +Static variable in interface com.soundcloud.api.Params.User +
  +
WEBSITE_TITLE - +Static variable in interface com.soundcloud.api.Params.User +
  +
with(Object...) - +Method in class com.soundcloud.api.Request +
  +
withContent(String, String) - +Method in class com.soundcloud.api.Request +
Adds string content to the request (used with POST/PUT) +
withEntity(HttpEntity) - +Method in class com.soundcloud.api.Request +
Adds an arbitrary entity to the request (used with POST/PUT) +
withFile(String, File) - +Method in class com.soundcloud.api.Request +
Registers a file to be uploaded with a POST or PUT request. +
withFile(String, byte[]) - +Method in class com.soundcloud.api.Request +
Registers binary data to be uploaded with a POST or PUT request. +
withFile(String, ByteBuffer) - +Method in class com.soundcloud.api.Request +
Registers binary data to be uploaded with a POST or PUT request. +
+
+A B C D E F G H I K L M N O P Q R S T U V W + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree  Deprecated   Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/javadoc/1.0.1/index.html b/javadoc/1.0.1/index.html new file mode 100644 index 0000000..ab8928e --- /dev/null +++ b/javadoc/1.0.1/index.html @@ -0,0 +1,36 @@ + + + + + + +SoundCloud Java API Wrapper 1.0.1 + + + + + + + + +<H2> +Frame Alert</H2> + +<P> +This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +<BR> +Link to<A HREF="com/soundcloud/api/package-summary.html">Non-frame version.</A> + + + diff --git a/javadoc/1.0.1/overview-tree.html b/javadoc/1.0.1/overview-tree.html new file mode 100644 index 0000000..adfe160 --- /dev/null +++ b/javadoc/1.0.1/overview-tree.html @@ -0,0 +1,173 @@ + + + + + + +Class Hierarchy (SoundCloud Java API Wrapper 1.0.1) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For All Packages

+
+
+
Package Hierarchies:
com.soundcloud.api
+
+

+Class Hierarchy +

+
    +
  • java.lang.Object
      +
    • com.soundcloud.api.ApiWrapper (implements com.soundcloud.api.CloudAPI, java.io.Serializable) +
    • com.soundcloud.api.Http
    • com.soundcloud.api.Request (implements java.lang.Iterable<T>) +
    • java.lang.Throwable (implements java.io.Serializable) + +
    • com.soundcloud.api.Token (implements java.io.Serializable) +
    +
+

+Interface Hierarchy +

+ +

+Enum Hierarchy +

+
    +
  • java.lang.Object
      +
    • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) +
        +
      • com.soundcloud.api.Env
      +
    +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/javadoc/1.0.1/package-list b/javadoc/1.0.1/package-list new file mode 100644 index 0000000..149e54d --- /dev/null +++ b/javadoc/1.0.1/package-list @@ -0,0 +1 @@ +com.soundcloud.api diff --git a/javadoc/1.0.1/resources/inherit.gif b/javadoc/1.0.1/resources/inherit.gif new file mode 100644 index 0000000000000000000000000000000000000000..c814867a13deb0ca7ea2156c6ca1d5a03372af7e GIT binary patch literal 57 zcmZ?wbhEHbIIT!9-C*e{wE9>Kx3D)-;0v)C; KYxQGgum%9JOA&7X literal 0 HcmV?d00001 diff --git a/javadoc/1.0.1/serialized-form.html b/javadoc/1.0.1/serialized-form.html new file mode 100644 index 0000000..3dc4a05 --- /dev/null +++ b/javadoc/1.0.1/serialized-form.html @@ -0,0 +1,307 @@ + + + + + + +Serialized Form (SoundCloud Java API Wrapper 1.0.1) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Serialized Form

+
+
+ + + + + +
+Package com.soundcloud.api
+ +

+ + + + + +
+Class com.soundcloud.api.ApiWrapper extends java.lang.Object implements Serializable
+ +

+serialVersionUID: 3662083416905771921L + +

+ + + + + +
+Serialized Fields
+ +

+env

+
+Env env
+
+
The current environment +

+

+
+
+
+

+mToken

+
+Token mToken
+
+
+
+
+
+

+mClientId

+
+java.lang.String mClientId
+
+
+
+
+
+

+mClientSecret

+
+java.lang.String mClientSecret
+
+
+
+
+
+

+mRedirectUri

+
+java.net.URI mRedirectUri
+
+
+
+
+
+

+debugRequests

+
+boolean debugRequests
+
+
debug request details to stderr +

+

+
+
+
+

+mDefaultContentType

+
+java.lang.String mDefaultContentType
+
+
+
+
+ +

+ + + + + +
+Class com.soundcloud.api.CloudAPI.InvalidTokenException extends java.io.IOException implements Serializable
+ +

+serialVersionUID: 1954919760451539868L + +

+ +

+ + + + + +
+Class com.soundcloud.api.Token extends java.lang.Object implements Serializable
+ +

+serialVersionUID: 766168501082045382L + +

+ + + + + +
+Serialized Fields
+ +

+access

+
+java.lang.String access
+
+
+
+
+
+

+refresh

+
+java.lang.String refresh
+
+
+
+
+
+

+scope

+
+java.lang.String scope
+
+
+
+
+
+

+expiresIn

+
+long expiresIn
+
+
+
+
+ +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/javadoc/1.0.1/stylesheet.css b/javadoc/1.0.1/stylesheet.css new file mode 100644 index 0000000..6ea9e51 --- /dev/null +++ b/javadoc/1.0.1/stylesheet.css @@ -0,0 +1,29 @@ +/* Javadoc style sheet */ + +/* Define colors, fonts and other style attributes here to override the defaults */ + +/* Page background color */ +body { background-color: #FFFFFF; color:#000000 } + +/* Headings */ +h1 { font-size: 145% } + +/* Table colors */ +.TableHeadingColor { background: #CCCCFF; color:#000000 } /* Dark mauve */ +.TableSubHeadingColor { background: #EEEEFF; color:#000000 } /* Light mauve */ +.TableRowColor { background: #FFFFFF; color:#000000 } /* White */ + +/* Font used in left-hand frame lists */ +.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } + +/* Navigation bar fonts and colors */ +.NavBarCell1 { background-color:#EEEEFF; color:#000000} /* Light mauve */ +.NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */ +.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;} +.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;} + +.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +