@ProviderType public interface PayloadInfo
InboxItem
's payload. The most
needed information is represented as first class properties. Any other information needed can be added to the
custom properties Map.Modifier and Type | Interface and Description |
---|---|
static class |
PayloadInfo.PAYLOAD_TYPE
Known Payload types
|
Modifier and Type | Method and Description |
---|---|
PayloadInfo |
addCustomProperty(String key,
Object value)
Add a property to the custom property
getCustomProperties() |
String |
getAssetFolderPath()
Return the path to the asset folder associated with the payload.
|
String |
getBrowserPath()
Return the path to be opened in a browser to load the representation of the payload.
|
Calendar |
getCreated()
Return the date and time when the payload was created.
|
String |
getCreatedBy()
Returns the ID of the user who created the payload
|
Map<String,Object> |
getCustomProperties()
Return the custom property Map.
|
Object |
getCustomProperty(String key)
Return a custom property from the custom property
getCustomProperties() . |
String |
getDescription()
Return the description of the payload.
|
Calendar |
getLastModified()
Return the date and time when the payload was last modified
|
String |
getLastModifiedBy()
Returns the ID of the user who last modified the payload.
|
String |
getLockedBy()
Returns the ID of the user who locked the payload.
|
long |
getMonthlyHits()
Return the number of monthly hits the payload has received.
|
Calendar |
getOffTime()
Return the date and time that the payload will be turned off.
|
Calendar |
getOnTime()
Return the date and time that the payload will be turned on.
|
String |
getPath()
Return the path of the payload content.
|
String |
getPayloadType()
Return the type of the payload
|
String |
getThumbnailPath()
Return the path to the thumbnail that represents the payload
|
long |
getTimeUntilValid()
Return the amount of time in ms until the payload is considered valid.
|
String |
getTitle()
Return the title associated with the payload.
|
boolean |
isActive()
Return whether or not the payload is active.
|
boolean |
isLocked()
Return whether or not the payload is locked.
|
PayloadInfo |
setAssetFolderPath(String assetFolderPath)
Set the path to the asset folder associated with the payload.
|
PayloadInfo |
setBrowserPath(String browserPath)
Set the path to be opened in a browser to load the representation of the payload.
|
PayloadInfo |
setCreated(Calendar created)
Set the date and time when the payload was created.
|
PayloadInfo |
setCreatedBy(String createdBy)
Set the ID of the user who created the payload.
|
PayloadInfo |
setCustomProperties(Map<String,Object> customProperties)
Set the custom property Map.
|
PayloadInfo |
setDescription(String description)
Set the description of the payload.
|
PayloadInfo |
setIsActive(boolean isActive)
Set whether or not the payload is active.
|
PayloadInfo |
setIsLocked(boolean isLocked)
Set whether or not the payload is locked.
|
PayloadInfo |
setLastModified(Calendar lastModified)
Set the date and time when the payload was last modified
|
PayloadInfo |
setLastModifiedBy(String lastModifiedBy)
Set the ID of the user who last modified the payload.
|
PayloadInfo |
setLockedBy(String lockedBy)
Set the ID of the user who locked the payload.
|
PayloadInfo |
setMonthlyHits(long monthlyHits)
Set the number of monthly hits the payload has received.
|
PayloadInfo |
setOffTime(Calendar offTime)
Set the date and time that the payload will be turned off.
|
PayloadInfo |
setOnTime(Calendar onTime)
Set the date and time that the payload will be turned on.
|
PayloadInfo |
setPath(String path)
Set the path of the payload content.
|
PayloadInfo |
setPayloadType(String payloadType)
Set the type of the payload
|
PayloadInfo |
setThumbnailPath(String thumbnailPath)
Set the path to the thumbnail that represents the payload
|
PayloadInfo |
setTimeUntilValid(long timeUntilValid)
Set the amount of time in ms until the payload is considered valid.
|
PayloadInfo |
setTitle(String title)
Set the title associated with the payload.
|
String getPath()
InboxItem.getContentPath()
PayloadInfo setPath(String path)
path
- the path to the payload contentInboxItem.getContentPath()
String getBrowserPath()
PayloadInfo setBrowserPath(String browserPath)
browserPath
- the path to the payload to be opened in a browserString getTitle()
PayloadInfo setTitle(String title)
title
- the payload's titleString getThumbnailPath()
PayloadInfo setThumbnailPath(String thumbnailPath)
thumbnailPath
- the payload's thumbnail pathString getPayloadType()
PayloadInfo.PAYLOAD_TYPE
PayloadInfo setPayloadType(String payloadType)
payloadType
- the payload's typePayloadInfo.PAYLOAD_TYPE
Calendar getCreated()
Calendar
representing when the payload was createdPayloadInfo setCreated(Calendar created)
created
- the Calendar
representing when the payload was createdString getCreatedBy()
PayloadInfo setCreatedBy(String createdBy)
createdBy
- the ID of the user who created the payloadCalendar getLastModified()
Calendar
representing when the payload was last modifiedPayloadInfo setLastModified(Calendar lastModified)
lastModified
- the Calendar
representing when the payload was last modifiedString getLastModifiedBy()
PayloadInfo setLastModifiedBy(String lastModifiedBy)
lastModifiedBy
- the ID of the user who last modified the payloadboolean isLocked()
PayloadInfo setIsLocked(boolean isLocked)
isLocked
- whether or not the payload is lockedString getLockedBy()
PayloadInfo setLockedBy(String lockedBy)
lockedBy
- the ID of the user who locked the payloadCalendar getOnTime()
PayloadInfo.PAYLOAD_TYPE.PAGE
.Calendar
representing the date and time that the payload will be turned onPayloadInfo setOnTime(Calendar onTime)
PayloadInfo.PAYLOAD_TYPE.PAGE
.onTime
- the Calendar
representing the date and time that the payload will be turned onCalendar getOffTime()
PayloadInfo.PAYLOAD_TYPE.PAGE
.Calendar
representing the date and time that the payload will be turned offPayloadInfo setOffTime(Calendar offTime)
PayloadInfo.PAYLOAD_TYPE.PAGE
.offTime
- the Calendar
representing the date and time that the payload will be turned offlong getTimeUntilValid()
PayloadInfo.PAYLOAD_TYPE.PAGE
.PayloadInfo setTimeUntilValid(long timeUntilValid)
PayloadInfo.PAYLOAD_TYPE.PAGE
timeUntilValid
- the amount of time in ms until the payload is considered validlong getMonthlyHits()
PayloadInfo.PAYLOAD_TYPE.PAGE
.PayloadInfo setMonthlyHits(long monthlyHits)
PayloadInfo.PAYLOAD_TYPE.PAGE
.monthlyHits
- the number of monthly hits the payload has receivedString getDescription()
PayloadInfo setDescription(String description)
description
- the description of the payloadString getAssetFolderPath()
PayloadInfo.PAYLOAD_TYPE.PROJECT
.PayloadInfo setAssetFolderPath(String assetFolderPath)
PayloadInfo.PAYLOAD_TYPE.PAGE
.assetFolderPath
- the path to the asset folder associated with the payloadboolean isActive()
PayloadInfo.PAYLOAD_TYPE.PAGE
.PayloadInfo setIsActive(boolean isActive)
PayloadInfo.PAYLOAD_TYPE.PAGE
.isActive
- whether or not the paylaod is activeMap<String,Object> getCustomProperties()
PayloadInfo setCustomProperties(Map<String,Object> customProperties)
customProperties
- the custom property getCustomProperties()
PayloadInfo addCustomProperty(String key, Object value)
getCustomProperties()
key
- the property's keyvalue
- the property's valueObject getCustomProperty(String key)
getCustomProperties()
.key
- the key to look up in the custom property MapCopyright © 2010 - 2020 Adobe. All Rights Reserved