com.kallasoft.smugmug.api.json.v1_2_0.images
Class GetURLs

java.lang.Object
  com.kallasoft.smugmug.api.json.AbstractMethod
      com.kallasoft.smugmug.api.json.v1_2_0.images.GetURLs

All Implemented Interfaces:

Method

Direct Known Subclasses:

GetURLs

public class GetURLs
extends AbstractMethod

This method will return all the URLs for the various sizes of the image specified by ImageID.

The album must be owned by the session holder, or else be public (if password-protected, a password must be provided) to return results, otherwise an "invalid user" faultCode will result.

Additionally, obvious restrictions on Originals and (extra)Larges apply if so set by the owner. They will return as empty strings for those URLs if they're unavailable.

Version:

1.2.0

Author:

Riyad Kalla

See Also:

smugmug.images.getURLs API Doc

Nested Class Summary

class

GetURLs.GetURLsResponse Class used to represent the response for the smugmug.images.getURLs method call.

Field Summary

static String[]	ARGUMENTS Defines all the arguments this method takes.
static String	METHOD_NAME Defines the SmugMug JSON API method name that will be called.

Constructor Summary

GetURLs()
Construct a new method instance that can be executed.

GetURLs(String methodName, String[] arguments)
Construct a new method instance that can be executed with the given arguments.

Method Summary

GetURLs.GetURLsResponse	execute(String url, String[] argumentValues) Used to execute the smugmug.images.getURLs method, returning a list of the URLs for the different sizes of the given image.
GetURLs.GetURLsResponse	execute(String url, String apiKey, String sessionID, Integer imageID, String imageKey) Convenience method used to execute the smugmug.images.getURLs method.
GetURLs.GetURLsResponse	execute(String url, String apiKey, String sessionID, Integer imageID, String imageKey, Integer templateID) Convenience method used to execute the smugmug.images.getURLs method.
GetURLs.GetURLsResponse	execute(String url, String apiKey, String sessionID, Integer imageID, String imageKey, Integer templateID, String password, String sitePassword) Convenience method used to execute the smugmug.images.getURLs method.

Methods inherited from class com.kallasoft.smugmug.api.json.AbstractMethod

executeImpl, getArguments, getMethodName, setupPostParameters

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

METHOD_NAME

public static final String METHOD_NAME

Defines the SmugMug JSON API method name that will be called.

See Also:

Constant Field Values

ARGUMENTS

public static final String[] ARGUMENTS

Defines all the arguments this method takes.

Values are: "APIKey", "SessionID", "ImageID", "ImageKey", "TemplateID", "Password", "SitePassword"

Constructor Detail

GetURLs

public GetURLs()

Construct a new method instance that can be executed.

GetURLs

public GetURLs(String methodName,
               String[] arguments)

Construct a new method instance that can be executed with the given arguments.

Parameters:

methodName - The name of the SmugMug JSON API method that this Method represents.

arguments - The names of the arguments that this method accepts.

Method Detail

execute

public GetURLs.GetURLsResponse execute(String url,
                                       String[] argumentValues)

Used to execute the smugmug.images.getURLs method, returning a list of the URLs for the different sizes of the given image.

Parameters:

url - The URL of the SmugMug server to communicate with.

argumentValues - The argument values to pass to this method.

Returns:

the response that includes a list of the URLs for the different sizes of the given image.

execute

public GetURLs.GetURLsResponse execute(String url,
                                       String apiKey,
                                       String sessionID,
                                       Integer imageID,
                                       String imageKey)

Convenience method used to execute the smugmug.images.getURLs method.

This method performs necessary conversions on all the argument values before calling execute(String, String[]).

Parameters:

url - The URL of the SmugMug server to communicate with.

apiKey - The API Key to use. API keys are issued by SmugMug.

sessionID - The logged in SessionID that represents the user's session.

imageID - The ID of the image whose URLs will be returned.

imageKey - The security key for the image.

Returns:

the response that includes a list of the URLs for the different sizes of the given image.

See Also:

execute(String, String[])

execute

public GetURLs.GetURLsResponse execute(String url,
                                       String apiKey,
                                       String sessionID,
                                       Integer imageID,
                                       String imageKey,
                                       Integer templateID)

Convenience method used to execute the smugmug.images.getURLs method.

This method performs necessary conversions on all the argument values before calling execute(String, String[]).

Parameters:

url - The URL of the SmugMug server to communicate with.

apiKey - The API Key to use. API keys are issued by SmugMug.

sessionID - The logged in SessionID that represents the user's session.

imageID - The ID of the image whose URLs will be returned.

imageKey - The security key for the image.

templateID - The ID of the template used to build the URLs.

Returns:

the response that includes a list of the URLs for the different sizes of the given image.

See Also:

execute(String, String[])

execute

public GetURLs.GetURLsResponse execute(String url,
                                       String apiKey,
                                       String sessionID,
                                       Integer imageID,
                                       String imageKey,
                                       Integer templateID,
                                       String password,
                                       String sitePassword)

Convenience method used to execute the smugmug.images.getURLs method.

This method performs necessary conversions on all the argument values before calling execute(String, String[]).

Parameters:

url - The URL of the SmugMug server to communicate with.

apiKey - The API Key to use. API keys are issued by SmugMug.

sessionID - The logged in SessionID that represents the user's session.

imageID - The ID of the image whose URLs will be returned.

imageKey - The security key for the image.

templateID - The ID of the template used to build the URLs.

password - The password to the containing album if necessary.

sitePassword - The site password if necessary.

Returns:

the response that includes a list of the URLs for the different sizes of the given image.

See Also:

execute(String, String[])