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

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

All Implemented Interfaces:

Method

Direct Known Subclasses:

Get

public class Get
extends AbstractMethod

This method will fetch all the ImageIDs for the album specified by AlbumID.

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.

Version:

1.2.0

Author:

Riyad Kalla

See Also:

smugmug.images.get API Doc

Nested Class Summary

class

Get.GetResponse Class used to represent the response for the smugmug.images.get 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

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

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

Method Summary

Get.GetResponse	execute(String url, String[] argumentValues) Used to execute the smugmug.images.get method, returning a list of image IDs for the given album.
Get.GetResponse	execute(String url, String apiKey, String sessionID, Integer albumID, String albumKey) Convenience method used to execute the smugmug.images.get method.
Get.GetResponse	execute(String url, String apiKey, String sessionID, Integer albumID, String albumKey, Boolean heavy) Convenience method used to execute the smugmug.images.get method.
Get.GetResponse	execute(String url, String apiKey, String sessionID, Integer albumID, String albumKey, Boolean heavy, String password, String sitePassword) Convenience method used to execute the smugmug.images.get 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", "AlbumID", "AlbumKey", "Heavy", "Password", "SitePassword"

Constructor Detail

Get

public Get()

Construct a new method instance that can be executed.

Get

public Get(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 Get.GetResponse execute(String url,
                               String[] argumentValues)

Used to execute the smugmug.images.get method, returning a list of image IDs for the given album.

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 image IDs for the given album.

execute

public Get.GetResponse execute(String url,
                               String apiKey,
                               String sessionID,
                               Integer albumID,
                               String albumKey)

Convenience method used to execute the smugmug.images.get 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.

albumID - The ID of the album whose image IDs will be returned.

albumKey - The security key for the album.

Returns:

the response that includes a list of the image IDs for the given album.

See Also:

execute(String, String[])

execute

public Get.GetResponse execute(String url,
                               String apiKey,
                               String sessionID,
                               Integer albumID,
                               String albumKey,
                               Boolean heavy)

Convenience method used to execute the smugmug.images.get 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.

albumID - The ID of the album whose image IDs will be returned.

albumKey - The security key for the album.

heavy - A boolean argument (0 or 1) indicating if you would like heavy results returned. Heavy results include much more detail about each image and take longer to process when requested.

Returns:

the response that includes a list of the image IDs for the given album.

See Also:

execute(String, String[])

execute

public Get.GetResponse execute(String url,
                               String apiKey,
                               String sessionID,
                               Integer albumID,
                               String albumKey,
                               Boolean heavy,
                               String password,
                               String sitePassword)

Convenience method used to execute the smugmug.images.get 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.

albumID - The ID of the album whose image IDs will be returned.

albumKey - The security key for the album.

heavy - A boolean argument (0 or 1) indicating if you would like heavy results returned. Heavy results include much more detail about each image and take longer to process when requested.

password - A password for the album if it is password protected.

sitePassword - A site password for the SmugMug site if it is password protected.

Returns:

the response that includes a list of the image IDs for the given album.

See Also:

execute(String, String[])