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

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

All Implemented Interfaces:

Method

Direct Known Subclasses:

Get

public class Get
extends AbstractMethod

This method returns all of the album templates for the logged in user (via SessionID). Templates are only available to Power and Pro users.

Version:

1.2.0

Author:

Riyad Kalla

See Also:

smugmug.albumtemplates.get API Doc

Nested Class Summary

class

Get.GetResponse Class used to represent the response for the smugmug.albumtemplates.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.albumtemplates.get method, returning a list of the album templates for this user (only available to Power and Pro users).
Get.GetResponse	execute(String url, String apiKey, String sessionID) Convenience method used to execute the smugmug.albumtemplates.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"

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.albumtemplates.get method, returning a list of the album templates for this user (only available to Power and Pro users).

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 album templates for this user (only available to Power and Pro users).

execute

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

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

Returns:

the response that includes a list of the album templates for this user (only available to Power and Pro users).

See Also:

execute(String, String[])