com.kallasoft.smugmug.api.json.v1_2_1.albumtemplates
Class Delete

java.lang.Object
  com.kallasoft.smugmug.api.json.AbstractMethod
      com.kallasoft.smugmug.api.json.v1_2_1.albumtemplates.Delete

All Implemented Interfaces:

Method

public class Delete
extends AbstractMethod

This method deletes the specified Album template.

Version:

1.2.1

Author:

Riyad Kalla

See Also:

smugmug.albumtemplates.delete API Doc

Nested Class Summary

class

Delete.DeleteResponse Class used to represent the response for the smugmug.albumtemplates.delete 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

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

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

Method Summary

Delete.DeleteResponse	execute(String url, String[] argumentValues) Used to execute the smugmug.albumtemplates.delete method, returning a status of the delete operation.
Delete.DeleteResponse	execute(String url, String apiKey, String sessionID, Integer albumTemplateID) Convenience method used to execute the smugmug.albumtemplates.delete 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", "AlbumTemplateID"

Constructor Detail

Delete

public Delete()

Construct a new method instance that can be executed.

Delete

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

Used to execute the smugmug.albumtemplates.delete method, returning a status of the delete operation.

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 status of the delete operation.

execute

public Delete.DeleteResponse execute(String url,
                                     String apiKey,
                                     String sessionID,
                                     Integer albumTemplateID)

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

albumTemplateID - The ID of the album template that will be deleted.

Returns:

the response that includes a status of the delete operation.

See Also:

execute(String, String[])