AboutContactLogin

Index

AccessMask

The AccessMask enumeration lists flags which can be used in the access mask assigned to a Zenfolio object.

flags AccessMask
{
    None,

    HideDateCreated,
    HideDateModified,
    HideDateTaken,
    HideMetaData,
    HideUserStats,
    HideVisits,

    NoCollections,
    NoPrivateSearch,
    NoPublicSearch,
    NoRecentList,

    ProtectExif,
    ProtectXXLarge,             // new in version 1.3
    ProtectExtraLarge,
    ProtectLarge,
    ProtectMedium,
    ProtectOriginals,

    ProtectGuestbook,             // new in version 1.1
    NoPublicGuestbookPosts,       // new in version 1.1
    NoPrivateGuestbookPosts,      // new in version 1.1
    NoAnonymousGuestbookPosts,    // new in version 1.1

    ProtectComments,              // new in version 1.1
    NoPublicComments,             // new in version 1.1
    NoPrivateComments,            // new in version 1.1
    NoAnonymousComments,          // new in version 1.1

    PasswordProtectOriginals,     // new in version 1.2

    UnprotectCover,               // new in version 1.6

    IncludeRawFilesWithOriginals, // new in version 1.8

    ProtectAll

}

Values

None
No access mask flags are set

HideDateCreated
For photos, do not show the date uploaded. For photosets and groups do not show the date created.
HideDateModified
For photosets and groups do not show the last modified date.
HideDateTaken
For photos do not show the date when the photo was taken.
HideMetaData
For photos, do not show date uploaded, date taken, and EXIF information. For photosets and groups, do not show date created and date modified.
HideUserStats
When set on a user's root group, hides user-level statistics: total number of photos, galleries, and collections; the date user joined Zenfolio; the date user made the most recent update.
HideVisits
Do not show the number of visitors. When set on a user's root photoset group, hides the total number of visitors for this user.

NoCollections
Do not allow adding photos to collections by other users
NoPrivateSearch
Do not return this object in private search scope
NoPublicSearch
Do not return this object in public search results
NoRecentList
Do not return this object in Recently Added

ProtectExif
Do not include EXIF into the generated images
ProtectXXLarge
Do not allow downloading of the XX-Large image size. This flag is new in API version 1.3.
ProtectExtraLarge
Do not allow downloading of the X-Large image size
ProtectLarge
Do not allow downloading of the Large image size
ProtectMedium
Do not allow downloading of the Medium image size
ProtectOriginals
Do not allow downloading of the original full size file

ProtectGuestbook
Do not allow reading guestbook entries. This flag is new in API version 1.1.
NoPublicGuestbookPosts
Do not allow adding new public guestbook posts. This flag is new in API version 1.1.
NoPrivateGuestbookPosts
Do not allow adding new private guestbook posts. This flag is new in API version 1.1.
NoAnonymousGuestbookPosts
Do not allow adding new guesbook posts by unregistered users. This flag is new in API version 1.1.

ProtectComments
Do not allow reading comments. This flag is new in API version 1.1.
NoPublicComments
Do not allow adding new public comments. This flag is new in API version 1.1.
NoPrivateComments
Do not allow adding new private comments. This flag is new in API version 1.1.
NoAnonymousComments
Do not allow adding new comments by unregistered users. This flag is new in API version 1.1.

PasswordProtectOriginals
Indicates that the original high-resolution image is protected with a password. This flag is new in API version 1.2.

UnprotectCover
When applied to a group, gallery, or collection, indicates that the cover photo image will be visible even if the cover photo object is not accessible to the visitor. This flag is new in API version 1.6.

IncludeRawFilesWithOriginals

Indicates that Raw files should be made available for download by visitors along with the original files. The Raw files will be downloadable whenever the original files are downloadable.

ProtectAll
This value is a combination of all the above flags

Remarks

Regardless of the access mask assigned to an object, the owner of the object always has full access to the object and its properties.

ProtectOriginals and PasswordProtectOriginals cannot both be set. If ProtectOriginals is set, the original image cannot be downloaded by anyone but the owner. If PasswordProtectOriginals is set, the original image can be downloaded by those who have been granted access to the photo and provided the correct original image password. If neither flag is set, the original image can be downloaded by anyone who has been granted access to the photo.

See Also