com.kallasoft.smugmug.api.json.v1_2_1.images
Class ChangeSettings

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

All Implemented Interfaces:

Method

public class ChangeSettings
extends ChangeSettings

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

Version:

1.2.1

Author:

Riyad Kalla

See Also:

ChangeSettings

Nested Class Summary

class

ChangeSettings.ChangeSettingsResponse This class is a convenience class extending the base ChangeSettings.ChangeSettingsResponse 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.images.ChangeSettings

METHOD_NAME

Constructor Summary

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

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

Method Summary

ChangeSettings.ChangeSettingsResponse	execute(String url, String[] argumentValues) Used to execute the smugmug.images.changeSettings method.
ChangeSettings.ChangeSettingsResponse	execute(String url, String apiKey, String sessionID, Integer imageID, Integer albumID) Convenience method used to execute the smugmug.images.changeSettings method.
ChangeSettings.ChangeSettingsResponse	execute(String url, String apiKey, String sessionID, Integer imageID, String caption, String keywords, Boolean hidden) Convenience method used to execute the smugmug.images.changeSettings method.
ChangeSettings.ChangeSettingsResponse	execute(String url, String apiKey, String sessionID, Integer imageID, String caption, String keywords, Boolean hidden, Double latitude, Double longitude, Integer altitude)

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.

In version 1.2.1 support for the Latitude, Longitude and Altitude arguments was added.

Values are: "APIKey", "SessionID", "ImageID", "AlbumID", "Caption", "Keywords", "Hidden", "Latitude", "Longitude", "Altitude"

Constructor Detail

ChangeSettings

public ChangeSettings()

Construct a new method instance that can be executed.

ChangeSettings

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

Description copied from class: ChangeSettings

Used to execute the smugmug.images.changeSettings method.

Specified by:

execute in interface Method

Overrides:

execute in class ChangeSettings

Parameters:

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

argumentValues - The argument values to pass to this method.

Returns:

the response that indicates if the operation was successful or not.

execute

public ChangeSettings.ChangeSettingsResponse execute(String url,
                                                     String apiKey,
                                                     String sessionID,
                                                     Integer imageID,
                                                     Integer albumID)

Description copied from class: ChangeSettings

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

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

Overrides:

execute in class ChangeSettings

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 who will have the change operation executed on.

albumID - The ID of the album that this image will be moved to.

Returns:

the response that indicates if the operation was successful or not.

See Also:

ChangeSettings.execute(String, String[])

execute

public ChangeSettings.ChangeSettingsResponse execute(String url,
                                                     String apiKey,
                                                     String sessionID,
                                                     Integer imageID,
                                                     String caption,
                                                     String keywords,
                                                     Boolean hidden)

Description copied from class: ChangeSettings

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

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

Overrides:

execute in class ChangeSettings

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 who will have the change operation executed on.

caption - A caption to assign to the given image.

keywords - The keywords to assign to the given image.

hidden - Set to true to hide the image or false to leave it unhidden. Default is false.

Returns:

the response that indicates if the operation was successful or not.

See Also:

ChangeSettings.execute(String, String[])

execute

public ChangeSettings.ChangeSettingsResponse execute(String url,
                                                     String apiKey,
                                                     String sessionID,
                                                     Integer imageID,
                                                     String caption,
                                                     String keywords,
                                                     Boolean hidden,
                                                     Double latitude,
                                                     Double longitude,
                                                     Integer altitude)