|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.kallasoft.smugmug.api.json.entity.Album
public class Album
Class used to define an album and all the properties it may or may not contain.
This class also defines all the argument value constants for
TemplateID, SortMethod,
SortDirection and DefaultColor that can be
passed or returned to or from an Album or AlbumTemplate.
NOTE: Boolean values of 0 and 1
are represented by Strings because the SmugMug API only
accepts the numerical values for false and true
respectively and cannot accept textual representations (e.g. "True", "Yes",
"false", "no", etc.) which is what Boolean.toString() returns when
invoked. So the literal values of 0 and 1 are
represented by Strings to control that.
| Field Summary | |
|---|---|
static String |
DEFAULT_COLOR_AUTO_COLOR
Used to define the Default Color value of "Auto Color". |
static String |
DEFAULT_COLOR_TRUE_COLOR
Used to define the Default Color value of "True Color". |
static String |
SORT_DIRECTION_ASCENDING
Used to define the Ascending (0) sort direction. |
static String |
SORT_DIRECTION_DESCENDING
Used to define the Descending (1) sort direction. |
static String |
SORT_METHOD_CAPTION
Used to define the "Caption" sort method. |
static String |
SORT_METHOD_DATE
Used to define the "Date" sort method. |
static String |
SORT_METHOD_DATE_TIME
Used to define the "DateTime" sort method. |
static String |
SORT_METHOD_DATE_TIME_ORIGINAL
Used to define the "DateTimeOriginal" sort method. |
static String |
SORT_METHOD_FILE_NAME
Used to define the "FileName" sort method. |
static String |
SORT_METHOD_POSITION
Used to define the "Position" sort method. |
static Integer |
TEMPLATE_ID_ALL_THUMBS
Used to define the All Thumbs (7) template ID. |
static Integer |
TEMPLATE_ID_FILMSTRIP
Used to define the Filmstrip (11) template ID. |
static Integer |
TEMPLATE_ID_JOURNAL
Used to define the Journal (9) template ID. |
static Integer |
TEMPLATE_ID_SLIDESHOW
Used to define the Slideshow (8) template ID. |
static Integer |
TEMPLATE_ID_SMUG_MUG
Used to define the SmugMug (3) template ID. |
static Integer |
TEMPLATE_ID_SMUG_MUG_SMALL
Used to define the SmugMug Small (10) template ID. |
static Integer |
TEMPLATE_ID_TRADITIONAL
Used to define the Traditional (4) template ID. |
static Integer |
TEMPLATE_ID_VIEWER_CHOICE
Used to define the Viewer Choice (0) template ID. |
| Constructor Summary | |
|---|---|
Album(Integer id,
String albumKey,
String title,
String description,
String keywords,
Category category,
Category subCategory,
Boolean geography,
Integer albumTemplateID,
Boolean exif,
Boolean clean,
Boolean header,
Boolean filenames,
Integer templateID,
String sortMethod,
Boolean sortDirection,
Integer position,
Integer imageCount,
Image highlight,
Boolean squareThumbs,
String password,
String passwordHint,
Boolean passworded,
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,
String lastUpdated)
Construct a new album with all the given property values. |
|
Album(org.json.JSONObject albumObject)
Construct a new album by safely parsing all known album values out of the given JSONObject. |
|
| Method Summary | |
|---|---|
Boolean |
canRank()
Used to determine if the album can be ranked. |
String |
getAlbumKey()
Used to get the security key for the album. |
Integer |
getAlbumTemplateID()
Used to get the ID of the album template used to configure this album. |
String |
getBackprinting()
Used to get the optional text that can be printed on the backs of the prints. |
Category |
getCategory()
Used to get the category that this album belongs to. |
Integer |
getCommunityID()
Used to get the ID of the community that this album belongs to. |
String |
getDescription()
Used to get a description of the album. |
Image |
getHighlight()
Used to get the Image (must have ID and ImageKey set) that will
be highlighted for this album. |
Integer |
getID()
Used to get the ID of the album. |
Integer |
getImageCount()
Used to get the number of images contained in the album. |
String |
getKeywords()
Used to get the keywords associated with the album. |
String |
getLastUpdated()
Used to get the date the album was last updated. |
String |
getPassword()
Used to get the password used to password-protect the album if it is password protected. |
String |
getPasswordHint()
Used to get the password hint for the password if there is one. |
Integer |
getPosition()
Used to get the position of the album within it's category (starting with 1). |
Integer |
getProofDays()
Used to get the number of days to delay printing for this album. |
Boolean |
getSortDirection()
Used to determine the direction (ascending [false] or descending [true]) that images are sorted in this album. |
String |
getSortMethod()
The sort method used for the images in this album. |
Category |
getSubCategory()
Used to get the subcategory that this album belongs to. |
Integer |
getTemplateID()
Used to get the ID of the template that will be used to display the album. |
String |
getTitle()
Used to get the title of the album. |
Float |
getUnsharpAmount()
Used to get the unsharp mask value. |
Float |
getUnsharpRadius()
Used to get the unsharp radius value. |
Float |
getUnsharpSigma()
Used to get the unsharp sigma value. |
Float |
getUnsharpThreshold()
Used to get the unsharp threshold value. |
Integer |
getWatermarkID()
Used to get the ID of the watermark that will be used on the images. |
Boolean |
isClean()
Used to determine if the album should display using the "clean" style. |
Boolean |
isComments()
Used to determine if the album allows comments. |
Boolean |
isDefaultColor()
Used to determine if the album defaults to using "True" or "AutoColor" when it's in the cart. |
Boolean |
isExif()
Used to determine if the album allows accessing the EXIF image data. |
Boolean |
isExternal()
Used to determine if the album allows external linking. |
Boolean |
isFamilyEdit()
Used to determine if the album allows captions and keywords to be edited by "family". |
Boolean |
isFilenames()
Used to determine if filenames will be shown when there is no caption for an image in this album. |
Boolean |
isFriendEdit()
Used to determine if the album allows captions and keywords to be edited by "friends". |
Boolean |
isGeography()
Used to determine if the album allows the use of geo-tagging images (location). |
Boolean |
isHeader()
Used to determine if the album will display a custom header. |
Boolean |
isHideOwner()
Used to determine if the album should mask the URL and name of the image owner. |
Boolean |
isLarges()
Used to determine if the album allows viewing of large-size images. |
Boolean |
isOriginals()
Used to determine if the image's originals can be seen. |
Boolean |
isPassworded()
Used to determine if the album is password protected. |
Boolean |
isPrintable()
Used to determine if prints can be purchased for the images in this album. |
Boolean |
isProtected()
Used to determine if the album is using heavy image protection. |
Boolean |
isPublic()
Used to determine if the album is publicly accessible. |
Boolean |
isShare()
Used to determine if the album enables the "Easy Sharing" button and features. |
Boolean |
isSmugSearchable()
Used to determine if the album is SmugMug-searchable. |
Boolean |
isSquareThumbs()
Used to determine if the album should generate thumbnails (Tiny and Thumbnail sizes) in a square aspect ratio or using the original aspect ratio. |
Boolean |
isWatermarking()
Used to determine if the album uses watermarking. |
Boolean |
isWorldSearchable()
Used to determine if the album is world-searchable (e.g. |
Boolean |
isX2Larges()
Used to determine if the album allows viewing of xxlarge-size images. |
Boolean |
isX3Larges()
Used to determine if the album allows viewing of xxxlarge-size images. |
Boolean |
isXLarges()
Used to determine if the album allows viewing of xlarge-size images. |
String |
toString()
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final Integer TEMPLATE_ID_VIEWER_CHOICE
public static final Integer TEMPLATE_ID_SMUG_MUG
public static final Integer TEMPLATE_ID_TRADITIONAL
public static final Integer TEMPLATE_ID_ALL_THUMBS
public static final Integer TEMPLATE_ID_SLIDESHOW
public static final Integer TEMPLATE_ID_JOURNAL
public static final Integer TEMPLATE_ID_SMUG_MUG_SMALL
public static final Integer TEMPLATE_ID_FILMSTRIP
public static final String SORT_METHOD_POSITION
public static final String SORT_METHOD_CAPTION
public static final String SORT_METHOD_FILE_NAME
public static final String SORT_METHOD_DATE
public static final String SORT_METHOD_DATE_TIME
public static final String SORT_METHOD_DATE_TIME_ORIGINAL
public static final String SORT_DIRECTION_ASCENDING
public static final String SORT_DIRECTION_DESCENDING
public static final String DEFAULT_COLOR_TRUE_COLOR
public static final String DEFAULT_COLOR_AUTO_COLOR
| Constructor Detail |
|---|
public Album(org.json.JSONObject albumObject)
throws org.json.JSONException
JSONObject.
If a property is not available from the JSONObject, it's value
is simply set to null and parsing continues.
albumObject - The JSONObject that will be queried for all the known
properties for this album.
org.json.JSONException - if any JSONObject-related exception occurs.
public Album(Integer id,
String albumKey,
String title,
String description,
String keywords,
Category category,
Category subCategory,
Boolean geography,
Integer albumTemplateID,
Boolean exif,
Boolean clean,
Boolean header,
Boolean filenames,
Integer templateID,
String sortMethod,
Boolean sortDirection,
Integer position,
Integer imageCount,
Image highlight,
Boolean squareThumbs,
String password,
String passwordHint,
Boolean passworded,
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,
String lastUpdated)
id - The ID of the album.albumKey - The security key for the album.title - The title of the album.description - A description of the album.keywords - The keywords associated with the album.category - The category that this album belongs to.subCategory - The subcategory that this album belongs to.geography - true if the album allows the use of geo-tagging
images (location), otherwise false.albumTemplateID - The ID of the album template used to configure this album.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:
sortMethod - The sort method used for the images in this album.
This can be:
sortDirection - false (0) for ascending and true
(1) for descending.position - The position of the album within it's category (starting with
1).imageCount - The number of images contained in the album.highlight - The Image (must have ID and ImageKey set) that will be
highlighted for this album.squareThumbs - true if thumbnails (Tiny and Thumbnail sizes)
are generated in a square aspect ratio, false
in order to generate them using the original aspect ratio.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.passworded - true if the album is password protected ,
otherwise false.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)lastUpdated - The date when the album was last updated.| Method Detail |
|---|
public String toString()
toString in class Objectpublic Integer getID()
public String getAlbumKey()
public String getTitle()
public String getDescription()
public String getKeywords()
public Category getCategory()
public Category getSubCategory()
public Boolean isGeography()
true if the album allows the use of geo-tagging
images (location), otherwise false.public Integer getAlbumTemplateID()
public Boolean isExif()
true if the album allows accessing the EXIF image
data, otherwise false.public Boolean isClean()
true if the album should display using the "clean"
style, otherwise false.public Boolean isHeader()
true if the album will display a custom header,
otherwise false.public Boolean isFilenames()
true if filenames will be shown when there is no
caption for an image in this album, otherwise false.public Integer getTemplateID()
This can be:
public String getSortMethod()
This can be:
public Boolean getSortDirection()
false (0) for ascending and true
(1) for descending.public Integer getPosition()
public Integer getImageCount()
public Image getHighlight()
Image (must have ID and ImageKey set) that will
be highlighted for this album.
Image (must have ID and ImageKey set) that will be
highlighted for this album.public Boolean isSquareThumbs()
true if thumbnails (Tiny and Thumbnail sizes) are
generated in a square aspect ratio, false in order
to generate them using the original aspect ratio.public String getPassword()
public String getPasswordHint()
public Boolean isPassworded()
This is available with 1.2.1+ only.
true if the album is password protected, otherwise
returns false.public Boolean isProtected()
true if the album is using heavy image protection,
otherwise false.public Boolean isPublic()
true if the album is publicly accessible,
otherwise returns false.public Boolean isHideOwner()
true if the album should mask the URL and name of
the image owner, otherwise false.public Boolean isExternal()
true if the album allows external linking,
otherwise false.public Boolean isSmugSearchable()
true if the album is SmugMug-searchable, otherwise
false.public Boolean isWorldSearchable()
true if the album is world-searchable (e.g.
Google, Yahoo, etc.), otherwise false.public Boolean isLarges()
true if the album allows viewing of large-size
images, otherwise false.public Boolean isXLarges()
true if the album allows viewing of xlarge-size
images, otherwise false.public Boolean isX2Larges()
true if the album allows viewing of xxlarge-size
images, otherwise false.public Boolean isX3Larges()
true if the album allows viewing of xxxlarge-size
images, otherwise false.public Boolean isOriginals()
true if the image's originals can be seen,
otherwise false.public Boolean isWatermarking()
true if the album uses watermarking, otherwise
false.public Integer getWatermarkID()
public Boolean isShare()
true if the album enables the "Easy Sharing"
button and features, otherwise false.public Boolean canRank()
true if the album can be ranked, otherwise
false.public Boolean isComments()
true if the album allows comments, otherwise
false.public Boolean isFamilyEdit()
true if the album allows captions and keywords to
be edited by "family", otherwise false.public Boolean isFriendEdit()
true if the album allows captions and keywords to
be edited by "friends", otherwise false.public Integer getCommunityID()
public Boolean isPrintable()
true if prints can be purchased for the images in
this album, otherwise false.public Integer getProofDays()
public String getBackprinting()
public Boolean isDefaultColor()
true if the album defaults to using "True" or
"AutoColor" when it's in the cart, otherwise false.public Float getUnsharpAmount()
This value controls how sharp of a mask is being applied to resized versions of the original image (e.g. Large, XLarge, etc.).
public Float getUnsharpRadius()
This value controls how large of a radius the sharpening effect has when applied to resized versions of the original image (e.g. Large, XLarge, etc.). Larger values effect more of the image.
public Float getUnsharpThreshold()
This value controls how many adjacent pixels are considered as an edge when the sharpening effect is applied to resized versions of the original image (e.g. Large, XLarge, etc.). Larger values effect more of the image.
public Float getUnsharpSigma()
public String getLastUpdated()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||