smugmug.albums.changeSettings
Version 7,
changed by devbobo@gmail.com.
10/30/2007.
Show version history
API Method: smugmug.albums.changeSettings
This method will change the settings on an album specified by AlbumID. The session must be established with a valid login. All settings are optional, if omitted, the current value for that setting is preserved.
Arguments:
- String SessionID
- int AlbumID
- struct: [optional, any or none of these can be present]
- int "CategoryID"
- Which Category does this Album belong to?
- Default: 0
- int "SubCategoryID"
- Does this album belong to a SubCategory?
- Default: 0
- int "CommunityID"
- Is this album a part of a community?
- Default: 0
- int "HighlightID"
- The ImageID of the photo to be highlighted
- Default: 0
- String "Description"
- Text description of the contents of the album
- String "Keywords"
- Any keywords used to search or describe the album
- String "Password"
- Optional password to protect this album
- String "PasswordHint"
- optional, gives your visitors a hint
- int "Position"
- The album's position within it's Category/SubCategory, starting with 1 at the top
- Default: 1
- String "SortMethod"
- The method by which to sort the photos when displaying them.
- Default: "Position"
- Valid values:
- "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 correctly set.
- "DateTimeOriginal": Sorts by the date taken, as told by EXIF data. Many cameras don't report this properly.
- boolean "SortDirection"
- Which direction to order the SortMethod
- Default: 0 (Ascending)
- Valid values:
- 0: Ascending (1-99, A-Z, 1980-2004, etc)
- 1: Descending (99-1, Z-A, 2004-1980, etc)
- boolean "Public"
- is this album public?
- Default: 1
- boolean "Filenames"
- show filenames if no caption?
- Default: 0
- boolean "Comments"
- allow comments?
- Default: 1
- boolean "External"
- allow external linking?
- Default: 1
- boolean "EXIF"
- Display extended camera information?
- Default: 1
- boolean "Share"
- Enable 'easy sharing' button and features?
- Default: 1
- boolean "Printable"
- Allow prints to be purchased?
- Default: 1
- boolean "Originals"
- Allow Original photos to be seen?
- Default: 1
- boolean "FamilyEdit"
- Allow Family to edit captions & keywords?
- Default: 0
- boolean "FriendEdit"
- Allow Friends to edit captions & keywords?
- Default: 0
- boolean "HideOwner"
- Mask the URL & name of the owner?
- Default: 0
- boolean "Header"
- Display custom header, if any?
- POWER+PRO ONLY!
- Default: 0
- int "TemplateID"
- Force a display style?
- POWER+PRO ONLY!
- Possible values:
- Viewer Choice (Recommended!): 0
- Elegant: 3
- Traditional: 4
- All Thumbs: 7
- Slideshow: 8
- Journal: 9
- Default: 0
- boolean "Larges"
- Allow Large photos to be seen?
- PRO ONLY!
- Default: 1
- boolean "XLarges"
- Allow XLarge photos to be seen?
- PRO ONLY!
- Default: 1
- boolean "X2Larges"
- Allow X2Large photos to be seen?
- Default: 1
- boolean "X3Larges"
- Allow X3Large photos to be seen?
- Default: 1
- boolean "DefaultColor"
- In the cart, default to True or AutoColor?
- PRO ONLY!
- Default: 1
- boolean "Clean"
- Display album in Clean style?
- PRO ONLY!
- Default: 0
- boolean "Protected"
- Enable heavy image protection?
- PRO ONLY!
- Default: 0
- boolean "Watermarking"
- Enabled watermarking of photos?
- PRO ONLY!
- Default: 0
- int "ProofDays"
- delay printing for up to 7 business days?
- string "Backprinting"
- want something printed on the backs of prints?
- PRO ONLY!
- boolean "SmugSearchable"
- want your gallery searchable by other SmugMuggers?
- boolean "WorldSearchable"
- want your gallery searchable via search engines?
- float "UnsharpAmount"
- PRO+POWER ONLY!
- Default: 0.200
- float "UnsharpRadius"
- PRO+POWER ONLY!
- Default: 1.000
- float "UnsharpThreshold"
- PRO+POWER ONLY!
- Default: 0.050
- float "UnsharpSIgma"
- PRO+POWER ONLY!
- Default: 1.000
Result:
Fault Codes:
- 10 - "invalid title"
- 3 - "invalid session"
- 5 - "system error"
Hide quick tip X
Quick Tip: Link to Other Wiki Pages
Use the Link function to link to an existing wiki page, a new wiki page, a document, or a URL.
| |
File |
By |
Size |
Attached |
Ver. |
|