com.kallasoft.smugmug.api.json.v1_2_1.albums
Class Get

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

All Implemented Interfaces:

Method

public class Get
extends Get

This class is a convenience class extending the base Get implementation.

Version:

1.2.1

Author:

Riyad Kalla

See Also:

Get

Nested Class Summary

class

Get.GetResponse This class is a convenience class extending the base Get.GetResponse implementation.

Field Summary

static String[]

ARGUMENTS Defines all the arguments this method takes.

Fields inherited from class com.kallasoft.smugmug.api.json.v1_2_0.albums.Get

METHOD_NAME

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.albums.get method, returning a list of albums for the user identified by the Session ID or the given Nick Name.
Get.GetResponse	execute(String url, String apiKey, String sessionID, Boolean heavy) Convenience method used to execute the smugmug.albums.get method.
Get.GetResponse	execute(String url, String apiKey, String sessionID, String nickName, Boolean heavy, String sitePassword) Convenience method used to execute the smugmug.albums.get method.
Get.GetResponse	execute(String url, String apiKey, String sessionID, String nickName, Boolean heavy, String sitePassword, String shareGroupTag) Convenience method used to execute the smugmug.albums.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

ARGUMENTS

public static final String[] ARGUMENTS

Defines all the arguments this method takes.

Values are: "APIKey", "SessionID", "NickName", "Heavy", "SitePassword", "ShareGroup"

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)

Description copied from class: Get

Used to execute the smugmug.albums.get method, returning a list of albums for the user identified by the Session ID or the given Nick Name.

Specified by:

execute in interface Method

Overrides:

execute in class Get

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 albums for the user identified by the given Session ID or Nick Name.

execute

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

Description copied from class: Get

Convenience method used to execute the smugmug.albums.get method.

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

Overrides:

execute in class Get

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.

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

Returns:

the response that includes a list of the albums for the user identified by the given Session ID.

See Also:

Get.execute(String, String[])

execute

public Get.GetResponse execute(String url,
                               String apiKey,
                               String sessionID,
                               String nickName,
                               Boolean heavy,
                               String sitePassword)

Description copied from class: Get

Convenience method used to execute the smugmug.albums.get method.

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

Overrides:

execute in class Get

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.

nickName - A nick name for a user that you wish to load the album list for. If the album list for the given nick name is not public, a sitePassword must be provided.

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

sitePassword - The password for a given password-protected account identified by nickName.

Returns:

the response that includes a list of the albums for the user identified by the given Session ID or Nick Name.

See Also:

Get.execute(String, String[])

execute

public Get.GetResponse execute(String url,
                               String apiKey,
                               String sessionID,
                               String nickName,
                               Boolean heavy,
                               String sitePassword,
                               String shareGroupTag)

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

nickName - A nick name for a user that you wish to load the album list for. If the album list for the given nick name is not public, a sitePassword must be provided.

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

sitePassword - The password for a given password-protected account identified by nickName.

shareGroupTag - The tag of the ShareGroup to expose private albums for.

Returns:

the response that includes a list of the albums for the user identified by the given Session ID or Nick Name.

See Also:

execute(String, String[])