AboutContactLogin

Index

LoadPhotoSet

The LoadPhotoSet method obtains a snapshot of the specified photoset (gallery or collection).

PhotoSet LoadPhotoSet(
    long photosetId,
    InformationLevel level,    // new in version 1.4
    bool includePhotos         // new in version 1.4
    )

Parameters

photosetId
64-bit identifier of the photoset to load
level
Specifies which PhotoSet snapshot fields to return. This parameter is new in API version 1.4.
includePhotos
Specifies whether to return photoset photos. This parameter is new in API version 1.4.

Returns

Photoset snapshot

Remarks

The set of fields returned in the PhotoSet snapshot depends on the value of the level parameter. If the level parameter is set to Level1, the following fields are returned: Id, GroupIndex, Title, AccessDescriptor, Owner, CreatedOn, ModifiedOn, Type, FeaturedIndex, TitlePhoto, PhotoCount, Views, UploadUrl, PageUrl, MailboxId, TextCn, VideoUploadUrl, RawUploadUrl.

If the level parameter is set to Level2, the method returns all the Level1 fields as well as the following fields: Caption, Keywords, Categories, IsRandomTitlePhoto, FileCount.

If the level parameter is set to Full, the method returns all PhotoSet snapshot fields except the Photos array. Whether the Photos array is returned is controlled by the includePhotos parameter (see below).

The includePhotos parameter controls whether the Photos array is returned. If this parameter is set to true, the Photos array is filled with snapshots of photos contained in the photoset. Photo snapshots returned in this array have Level1 fields only regardless of the level parameter value.

The information returned by this method is subject to access control. Certain fields of the Photo and PhotoSet snapshots may not be returned if prohibited by the access control settings of the photoset. In addition, the Photos field of the returned snapshot only contains photos accessible to the current user.

See Also