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

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

All Implemented Interfaces:

Method

public class ChangeSettings
extends AbstractMethod

This method will change the settings on an album template specified by AlbumTemplateID.

The valid values for SortMethod and TemplateID can be found defined as constants in the Album class.

Version:

1.2.1

Author:

Riyad Kalla

See Also:

smugmug.albumtemplatess.changeSettings API Doc

Nested Class Summary

class

ChangeSettings.ChangeSettingsResponse Class used to represent the response for the smugmug.albumtemplates.changeSettings 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

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.albumtemplates.changeSettings method, changing any settings specified and leaving any settings not specified as they are.

ChangeSettings.ChangeSettingsResponse

execute(String url, String apiKey, String sessionID, Integer albumTemplateID, String albumTemplateName, Boolean geography, Boolean exif, Boolean clean, Boolean header, Boolean filenames, Integer templateID, String sortMethod, Boolean sortDirection, Integer position, String password, String passwordHint, Boolean isProtected, Boolean isPublic, Boolean hideOwner, Boolean external, Boolean smugSearchable, Boolean worldSearchable, Boolean larges, Boolean xLarges, Boolean x2Larges, Boolean x3Larges, Boolean originals, Boolean watermarking, Integer watermarkID, Boolean share, Boolean canRank, Boolean comments, Boolean familyEdit, Boolean friendEdit, Integer communityID, Boolean printable, Integer proofDays, String backprinting, Boolean defaultColor, Float unsharpAmount, Float unsharpRadius, Float unsharpThreshold, Float unsharpSigma) Convenience method used to execute the smugmug.albumtemplates.changeSettings 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", "AlbumTemplateName", "Geography", "EXIF", "Clean", "Header", "Filenames", "TemplateID", "SortMethod", "SortDirection", "Password", "PasswordHint", "Protected", "Public", "HideOwner", "External", "SmugSearchable", "WorldSearchable", "Larges", "XLarges", "X2Larges", "X3Larges", "Originals", "Watermarking", "WatermarkID", "Share", "CanRank", "Comments", "FamilyEdit", "FriendEdit", "CommunityID", "Printable", "ProofDays", "Backprinting", "DefaultColor", "UnsharpAmount", "UnsharpRadius", "UnsharpThreshold", "UnsharpSigma"

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)

Used to execute the smugmug.albumtemplates.changeSettings method, changing any settings specified and leaving any settings not specified as they are.

Parameters:

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

argumentValues - The argument values to pass to this method.

Returns:

the response returned after the settings have changed.

execute

public ChangeSettings.ChangeSettingsResponse execute(String url,
                                                     String apiKey,
                                                     String sessionID,
                                                     Integer albumTemplateID,
                                                     String albumTemplateName,
                                                     Boolean geography,
                                                     Boolean exif,
                                                     Boolean clean,
                                                     Boolean header,
                                                     Boolean filenames,
                                                     Integer templateID,
                                                     String sortMethod,
                                                     Boolean sortDirection,
                                                     Integer position,
                                                     String password,
                                                     String passwordHint,
                                                     Boolean isProtected,
                                                     Boolean isPublic,
                                                     Boolean hideOwner,
                                                     Boolean external,
                                                     Boolean smugSearchable,
                                                     Boolean worldSearchable,
                                                     Boolean larges,
                                                     Boolean xLarges,
                                                     Boolean x2Larges,
                                                     Boolean x3Larges,
                                                     Boolean originals,
                                                     Boolean watermarking,
                                                     Integer watermarkID,
                                                     Boolean share,
                                                     Boolean canRank,
                                                     Boolean comments,
                                                     Boolean familyEdit,
                                                     Boolean friendEdit,
                                                     Integer communityID,
                                                     Boolean printable,
                                                     Integer proofDays,
                                                     String backprinting,
                                                     Boolean defaultColor,
                                                     Float unsharpAmount,
                                                     Float unsharpRadius,
                                                     Float unsharpThreshold,
                                                     Float unsharpSigma)

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

albumTemplateName - The name of the album template.

geography - true if the album allows the use of geo-tagging images (location), otherwise false.

exif - true if the album allows accessing the EXIF image data, otherwise false.

clean - true if the album should display using the "clean" style, otherwise false.

header - true if the album will display a custom header, otherwise false.

filenames - true if the album allows filenames to be shown if there is no caption, otherwise false.

templateID - The ID of the template that will be used to display the album.

This can be:

• Viewer Choice (Recommended!): 0
• SmugMug: 3
• Traditional: 4
• All Thumbs: 7
• Slideshow: 8
• Journal: 9
• SmugMug Small: 10
• Filmstrip: 11

sortMethod - The sort method used for the images in this album.

This can be:

• "Position" (Sorts by user-specified position)
• "Caption" (Sorts by the image captions)
• "FileName" (Sorts by the filename of each photo)
• "Date" (Sorts by the date uploaded to SmugMug)
• "DateTime" (Sorts by the date last modified, as told by EXIF data - Many files don't have this field set correctly)
• "DateTimeOriginal" (Sorts by the date taken, as told by EXIF data - Many cameras don't report this properly)

sortDirection - false (0) for ascending and true (1) for descending.

position - The position of the album within it's category (starting with 1).

password - The password used to password-protect the album if it is password protected.

passwordHint - The password hint for the password if there is one.

isProtected - true if the album is using heavy image protection, otherwise false.

isPublic - true if the album is publicly accessible, otherwise false.

hideOwner - true if the album should mask the URL and name of the image owner, otherwise false.

external - true if the album allows external linking, otherwise false.

smugSearchable - true if the album is SmugMug-searchable, otherwise false.

worldSearchable - true if the album is world-searchable (e.g. Google, Yahoo, etc.), otherwise false.

larges - true if the album allows viewing of large-size images, otherwise false.

xLarges - true if the album allows viewing of xlarge-size images, otherwise false.

x2Larges - true if the album allows viewing of xxlarge-size images, otherwise false.

x3Larges - true if the album allows viewing of xxxlarge-size images, otherwise false.

originals - true if the album allows the image's originals to be seen, otherwise false.

watermarking - true if the album uses watermarking, otherwise false.

watermarkID - The ID of the watermark that will be used on the images.

share - true if the album enables the "Easy Sharing" button and features, otherwise false.

canRank - true if the album can be ranked, otherwise false.

comments - true if the album allows comments, otherwise false.

familyEdit - true if the album allows captions and keywords to be edited by "family", otherwise false.

friendEdit - true if the album allows captions and keywords to be edited by "friends", otherwise false.

communityID - The ID of the community that this album belongs to.

printable - true if the album allows prints to be purchased, otherwise false.

proofDays - The number of days to delay printing for this album.

backprinting - The optional text that can be printed on the backs of the prints.

defaultColor - true if the album defaults to using "True" or "AutoColor" when it's in the cart, otherwise false.

unsharpAmount - How weak or strong the sharpness mask will be. A higher value will result in a more stark sharpness (Default 0.200). This only applies to resized versions of the original image (Large, XLarge, etc.) See http://smugmug.com/help/display-quality for more information.

unsharpRadius - The radius on the sharpening effect. Larger values lead to more defined sharpening (Default 1.000). This only applies to resized versions of the original image (Large, XLarge, etc.) See http://smugmug.com/help/display-quality for more information.

unsharpThreshold - The number of adjacent pixels that are considered an "edge" before performing a sharpen (Default 0.050). This only applies to resized versions of the original image (Large, XLarge, etc.) See http://smugmug.com/help/display-quality for more information.

unsharpSigma - (Default 1.000)

Returns:

the response returned after the settings have changed.

See Also:

execute(String, String[])