Class LrPublishedPhoto

An object of this class represents the publishing information associated with a photo that is part of a published collection.

Access the functions and properties from the object. Retrieve the objects for all the published photos in a collection by calling LrPublishedCollection:getPublishedPhotos().

Summary

publishedPhoto:getEditedFlag()
Reports whether the associated photo has been edited since last published.
publishedPhoto:getPhoto()
Retrieves the photo associated with this publishing data.
publishedPhoto:getPublishCount()
Reports the number of times the associated photo has been published by a publish service.
publishedPhoto:getRemoteId()
Retrieves the unique identifier for the associated photo, as assigned by the remote service.
publishedPhoto:getRemoteUrl()
Retrieves the URL for the associated photo, assigned by the remote service.
publishedPhoto:setEditedFlag( edited )
Marks the associated photo as edited since last published, or unchanged since publishing.
publishedPhoto:setRemoteId( remoteID )
Updates the remote service's unique identifier associated with the published photo.
publishedPhoto:setRemoteUrl( url )
Updates the URL for the associated photo.
publishedPhoto:type()
Reports the type of this object.
publishedPhoto.catalog
(LrCatalog) The catalog object that contains this publishing-data object and the associated photo.

Functions

publishedPhoto:getEditedFlag()
Reports whether the associated photo has been edited since last published.

First supported in version 3.0 of the Lightroom SDK.

Return value

(Boolean) True if edited since last published.
publishedPhoto:getPhoto()
Retrieves the photo associated with this publishing data.

First supported in version 3.0 of the Lightroom SDK.

Return value

(LrPhoto) The photo object.
publishedPhoto:getPublishCount()
Reports the number of times the associated photo has been published by a publish service.

First supported in version 3.0 of the Lightroom SDK.

Return value

(number) The publish count.
publishedPhoto:getRemoteId()
Retrieves the unique identifier for the associated photo, as assigned by the remote service.

First supported in version 3.0 of the Lightroom SDK.

Return value

(string or number) The remote ID.
publishedPhoto:getRemoteUrl()
Retrieves the URL for the associated photo, assigned by the remote service.

First supported in version 3.0 of the Lightroom SDK.

Return value

(string) The URL.
publishedPhoto:setEditedFlag( edited )
Marks the associated photo as edited since last published, or unchanged since publishing.

Must be called from within one of the catalog:with___WriteAccessDo gates (including withPrivateWriteAccessDo).

First supported in version 3.0 of the Lightroom SDK.

Parameters

1. edited
(Boolean) True if the photo has been edited, false to mark as unchanged.
publishedPhoto:setRemoteId( remoteID )
Updates the remote service's unique identifier associated with the published photo.

Must be called from within one of the catalog:with___WriteAccessDo gates (including withPrivateWriteAccessDo).

First supported in version 3.0 of the Lightroom SDK.

Parameters

1. remoteID
(string or number) The new ID assigned by the remote service.
publishedPhoto:setRemoteUrl( url )
Updates the URL for the associated photo.

Must be called from within one of the catalog:with___WriteAccessDo gates (including withPrivateWriteAccessDo).

First supported in version 3.0 of the Lightroom SDK.

Parameters

1. url
(string) The new URL assigned by the remote service.
publishedPhoto:type()
Reports the type of this object.

First supported in version 4.1 of the Lightroom SDK.

Return value

(string) 'LrPublishedPhoto'.

Properties

publishedPhoto.catalog : (Read-Only)
(LrCatalog) The catalog object that contains this publishing-data object and the associated photo.

First supported in version 3.0 of the Lightroom SDK.

See also: LrCatalog