Package com.docusign.esign.model
Class Comment
- java.lang.Object
-
- com.docusign.esign.model.Comment
-
- All Implemented Interfaces:
Serializable
public class Comment extends Object implements Serializable
Comment.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description Comment()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CommentaddMentionsItem(String mentionsItem)addMentionsItem.CommentaddVisibleToItem(String visibleToItem)addVisibleToItem.CommentenvelopeId(String envelopeId)envelopeId.booleanequals(Object o)Compares objects.StringgetEnvelopeId()The envelope ID of the envelope status that failed to post..StringgetHmac().StringgetId().List<String>getMentions().StringgetSentByEmail().StringgetSentByFullName().StringgetSentByImageId().StringgetSentByInitials().StringgetSentByRecipientId().StringgetSentByUserId().StringgetSigningGroupId()When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once)..StringgetSigningGroupName()The display name for the signing group.StringgetSubject().StringgetTabId()The unique identifier for the tab.StringgetText().StringgetThreadId().StringgetThreadOriginatorId().StringgetTimestamp().StringgetTimeStampFormatted().List<String>getVisibleTo().inthashCode()Returns the HashCode.Commenthmac(String hmac)hmac.Commentid(String id)id.BooleanisRead().Commentmentions(List<String> mentions)mentions.Commentread(Boolean read)read.CommentsentByEmail(String sentByEmail)sentByEmail.CommentsentByFullName(String sentByFullName)sentByFullName.CommentsentByImageId(String sentByImageId)sentByImageId.CommentsentByInitials(String sentByInitials)sentByInitials.CommentsentByRecipientId(String sentByRecipientId)sentByRecipientId.CommentsentByUserId(String sentByUserId)sentByUserId.voidsetEnvelopeId(String envelopeId)setEnvelopeId.voidsetHmac(String hmac)setHmac.voidsetId(String id)setId.voidsetMentions(List<String> mentions)setMentions.voidsetRead(Boolean read)setRead.voidsetSentByEmail(String sentByEmail)setSentByEmail.voidsetSentByFullName(String sentByFullName)setSentByFullName.voidsetSentByImageId(String sentByImageId)setSentByImageId.voidsetSentByInitials(String sentByInitials)setSentByInitials.voidsetSentByRecipientId(String sentByRecipientId)setSentByRecipientId.voidsetSentByUserId(String sentByUserId)setSentByUserId.voidsetSigningGroupId(String signingGroupId)setSigningGroupId.voidsetSigningGroupName(String signingGroupName)setSigningGroupName.voidsetSubject(String subject)setSubject.voidsetTabId(String tabId)setTabId.voidsetText(String text)setText.voidsetThreadId(String threadId)setThreadId.voidsetThreadOriginatorId(String threadOriginatorId)setThreadOriginatorId.voidsetTimestamp(String timestamp)setTimestamp.voidsetTimeStampFormatted(String timeStampFormatted)setTimeStampFormatted.voidsetVisibleTo(List<String> visibleTo)setVisibleTo.CommentsigningGroupId(String signingGroupId)signingGroupId.CommentsigningGroupName(String signingGroupName)signingGroupName.Commentsubject(String subject)subject.CommenttabId(String tabId)tabId.Commenttext(String text)text.CommentthreadId(String threadId)threadId.CommentthreadOriginatorId(String threadOriginatorId)threadOriginatorId.Commenttimestamp(String timestamp)timestamp.CommenttimeStampFormatted(String timeStampFormatted)timeStampFormatted.StringtoString()Converts the given object to string.CommentvisibleTo(List<String> visibleTo)visibleTo.
-
-
-
Method Detail
-
getEnvelopeId
public String getEnvelopeId()
The envelope ID of the envelope status that failed to post..- Returns:
- envelopeId
-
setEnvelopeId
public void setEnvelopeId(String envelopeId)
setEnvelopeId.
-
getHmac
public String getHmac()
.- Returns:
- hmac
-
setHmac
public void setHmac(String hmac)
setHmac.
-
getId
public String getId()
.- Returns:
- id
-
setId
public void setId(String id)
setId.
-
addMentionsItem
public Comment addMentionsItem(String mentionsItem)
addMentionsItem.- Returns:
- Comment
-
isRead
public Boolean isRead()
.- Returns:
- read
-
setRead
public void setRead(Boolean read)
setRead.
-
getSentByEmail
public String getSentByEmail()
.- Returns:
- sentByEmail
-
setSentByEmail
public void setSentByEmail(String sentByEmail)
setSentByEmail.
-
sentByFullName
public Comment sentByFullName(String sentByFullName)
sentByFullName.- Returns:
- Comment
-
getSentByFullName
public String getSentByFullName()
.- Returns:
- sentByFullName
-
setSentByFullName
public void setSentByFullName(String sentByFullName)
setSentByFullName.
-
getSentByImageId
public String getSentByImageId()
.- Returns:
- sentByImageId
-
setSentByImageId
public void setSentByImageId(String sentByImageId)
setSentByImageId.
-
sentByInitials
public Comment sentByInitials(String sentByInitials)
sentByInitials.- Returns:
- Comment
-
getSentByInitials
public String getSentByInitials()
.- Returns:
- sentByInitials
-
setSentByInitials
public void setSentByInitials(String sentByInitials)
setSentByInitials.
-
sentByRecipientId
public Comment sentByRecipientId(String sentByRecipientId)
sentByRecipientId.- Returns:
- Comment
-
getSentByRecipientId
public String getSentByRecipientId()
.- Returns:
- sentByRecipientId
-
setSentByRecipientId
public void setSentByRecipientId(String sentByRecipientId)
setSentByRecipientId.
-
getSentByUserId
public String getSentByUserId()
.- Returns:
- sentByUserId
-
setSentByUserId
public void setSentByUserId(String sentByUserId)
setSentByUserId.
-
signingGroupId
public Comment signingGroupId(String signingGroupId)
signingGroupId.- Returns:
- Comment
-
getSigningGroupId
public String getSigningGroupId()
When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once)..- Returns:
- signingGroupId
-
setSigningGroupId
public void setSigningGroupId(String signingGroupId)
setSigningGroupId.
-
signingGroupName
public Comment signingGroupName(String signingGroupName)
signingGroupName.- Returns:
- Comment
-
getSigningGroupName
public String getSigningGroupName()
The display name for the signing group. Maximum Length: 100 characters. .- Returns:
- signingGroupName
-
setSigningGroupName
public void setSigningGroupName(String signingGroupName)
setSigningGroupName.
-
getSubject
public String getSubject()
.- Returns:
- subject
-
setSubject
public void setSubject(String subject)
setSubject.
-
getTabId
public String getTabId()
The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. .- Returns:
- tabId
-
setTabId
public void setTabId(String tabId)
setTabId.
-
getText
public String getText()
.- Returns:
- text
-
setText
public void setText(String text)
setText.
-
getThreadId
public String getThreadId()
.- Returns:
- threadId
-
setThreadId
public void setThreadId(String threadId)
setThreadId.
-
threadOriginatorId
public Comment threadOriginatorId(String threadOriginatorId)
threadOriginatorId.- Returns:
- Comment
-
getThreadOriginatorId
public String getThreadOriginatorId()
.- Returns:
- threadOriginatorId
-
setThreadOriginatorId
public void setThreadOriginatorId(String threadOriginatorId)
setThreadOriginatorId.
-
getTimestamp
public String getTimestamp()
.- Returns:
- timestamp
-
setTimestamp
public void setTimestamp(String timestamp)
setTimestamp.
-
timeStampFormatted
public Comment timeStampFormatted(String timeStampFormatted)
timeStampFormatted.- Returns:
- Comment
-
getTimeStampFormatted
public String getTimeStampFormatted()
.- Returns:
- timeStampFormatted
-
setTimeStampFormatted
public void setTimeStampFormatted(String timeStampFormatted)
setTimeStampFormatted.
-
addVisibleToItem
public Comment addVisibleToItem(String visibleToItem)
addVisibleToItem.- Returns:
- Comment
-
equals
public boolean equals(Object o)
Compares objects.
-
-