Package com.docusign.esign.model
Class Comment
- java.lang.Object
-
- com.docusign.esign.model.Comment
-
public class Comment extends java.lang.ObjectComment.
-
-
Constructor Summary
Constructors Constructor Description Comment()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CommentaddMentionsItem(java.lang.String mentionsItem)addMentionsItem.CommentaddVisibleToItem(java.lang.String visibleToItem)addVisibleToItem.CommentenvelopeId(java.lang.String envelopeId)envelopeId.booleanequals(java.lang.Object o)Compares objects.java.lang.StringgetEnvelopeId()The envelope ID of the envelope status that failed to post..java.lang.StringgetHmac().java.lang.StringgetId().java.util.List<java.lang.String>getMentions().java.lang.StringgetSentByEmail().java.lang.StringgetSentByFullName().java.lang.StringgetSentByImageId().java.lang.StringgetSentByInitials().java.lang.StringgetSentByRecipientId().java.lang.StringgetSentByUserId().java.lang.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)..java.lang.StringgetSigningGroupName()The display name for the signing group.java.lang.StringgetSubject().java.lang.StringgetTabId()The unique identifier for the tab.java.lang.StringgetText().java.lang.StringgetThreadId().java.lang.StringgetThreadOriginatorId().java.lang.StringgetTimestamp().java.lang.StringgetTimeStampFormatted().java.util.List<java.lang.String>getVisibleTo().inthashCode()Returns the HashCode.Commenthmac(java.lang.String hmac)hmac.Commentid(java.lang.String id)id.java.lang.BooleanisRead().Commentmentions(java.util.List<java.lang.String> mentions)mentions.Commentread(java.lang.Boolean read)read.CommentsentByEmail(java.lang.String sentByEmail)sentByEmail.CommentsentByFullName(java.lang.String sentByFullName)sentByFullName.CommentsentByImageId(java.lang.String sentByImageId)sentByImageId.CommentsentByInitials(java.lang.String sentByInitials)sentByInitials.CommentsentByRecipientId(java.lang.String sentByRecipientId)sentByRecipientId.CommentsentByUserId(java.lang.String sentByUserId)sentByUserId.voidsetEnvelopeId(java.lang.String envelopeId)setEnvelopeId.voidsetHmac(java.lang.String hmac)setHmac.voidsetId(java.lang.String id)setId.voidsetMentions(java.util.List<java.lang.String> mentions)setMentions.voidsetRead(java.lang.Boolean read)setRead.voidsetSentByEmail(java.lang.String sentByEmail)setSentByEmail.voidsetSentByFullName(java.lang.String sentByFullName)setSentByFullName.voidsetSentByImageId(java.lang.String sentByImageId)setSentByImageId.voidsetSentByInitials(java.lang.String sentByInitials)setSentByInitials.voidsetSentByRecipientId(java.lang.String sentByRecipientId)setSentByRecipientId.voidsetSentByUserId(java.lang.String sentByUserId)setSentByUserId.voidsetSigningGroupId(java.lang.String signingGroupId)setSigningGroupId.voidsetSigningGroupName(java.lang.String signingGroupName)setSigningGroupName.voidsetSubject(java.lang.String subject)setSubject.voidsetTabId(java.lang.String tabId)setTabId.voidsetText(java.lang.String text)setText.voidsetThreadId(java.lang.String threadId)setThreadId.voidsetThreadOriginatorId(java.lang.String threadOriginatorId)setThreadOriginatorId.voidsetTimestamp(java.lang.String timestamp)setTimestamp.voidsetTimeStampFormatted(java.lang.String timeStampFormatted)setTimeStampFormatted.voidsetVisibleTo(java.util.List<java.lang.String> visibleTo)setVisibleTo.CommentsigningGroupId(java.lang.String signingGroupId)signingGroupId.CommentsigningGroupName(java.lang.String signingGroupName)signingGroupName.Commentsubject(java.lang.String subject)subject.CommenttabId(java.lang.String tabId)tabId.Commenttext(java.lang.String text)text.CommentthreadId(java.lang.String threadId)threadId.CommentthreadOriginatorId(java.lang.String threadOriginatorId)threadOriginatorId.Commenttimestamp(java.lang.String timestamp)timestamp.CommenttimeStampFormatted(java.lang.String timeStampFormatted)timeStampFormatted.java.lang.StringtoString()Converts the given object to string.CommentvisibleTo(java.util.List<java.lang.String> visibleTo)visibleTo.
-
-
-
Method Detail
-
envelopeId
public Comment envelopeId(java.lang.String envelopeId)
envelopeId.- Returns:
- Comment
-
getEnvelopeId
public java.lang.String getEnvelopeId()
The envelope ID of the envelope status that failed to post..- Returns:
- envelopeId
-
setEnvelopeId
public void setEnvelopeId(java.lang.String envelopeId)
setEnvelopeId.
-
hmac
public Comment hmac(java.lang.String hmac)
hmac.- Returns:
- Comment
-
getHmac
public java.lang.String getHmac()
.- Returns:
- hmac
-
setHmac
public void setHmac(java.lang.String hmac)
setHmac.
-
id
public Comment id(java.lang.String id)
id.- Returns:
- Comment
-
getId
public java.lang.String getId()
.- Returns:
- id
-
setId
public void setId(java.lang.String id)
setId.
-
mentions
public Comment mentions(java.util.List<java.lang.String> mentions)
mentions.- Returns:
- Comment
-
addMentionsItem
public Comment addMentionsItem(java.lang.String mentionsItem)
addMentionsItem.- Returns:
- Comment
-
getMentions
public java.util.List<java.lang.String> getMentions()
.- Returns:
- mentions
-
setMentions
public void setMentions(java.util.List<java.lang.String> mentions)
setMentions.
-
read
public Comment read(java.lang.Boolean read)
read.- Returns:
- Comment
-
isRead
public java.lang.Boolean isRead()
.- Returns:
- read
-
setRead
public void setRead(java.lang.Boolean read)
setRead.
-
sentByEmail
public Comment sentByEmail(java.lang.String sentByEmail)
sentByEmail.- Returns:
- Comment
-
getSentByEmail
public java.lang.String getSentByEmail()
.- Returns:
- sentByEmail
-
setSentByEmail
public void setSentByEmail(java.lang.String sentByEmail)
setSentByEmail.
-
sentByFullName
public Comment sentByFullName(java.lang.String sentByFullName)
sentByFullName.- Returns:
- Comment
-
getSentByFullName
public java.lang.String getSentByFullName()
.- Returns:
- sentByFullName
-
setSentByFullName
public void setSentByFullName(java.lang.String sentByFullName)
setSentByFullName.
-
sentByImageId
public Comment sentByImageId(java.lang.String sentByImageId)
sentByImageId.- Returns:
- Comment
-
getSentByImageId
public java.lang.String getSentByImageId()
.- Returns:
- sentByImageId
-
setSentByImageId
public void setSentByImageId(java.lang.String sentByImageId)
setSentByImageId.
-
sentByInitials
public Comment sentByInitials(java.lang.String sentByInitials)
sentByInitials.- Returns:
- Comment
-
getSentByInitials
public java.lang.String getSentByInitials()
.- Returns:
- sentByInitials
-
setSentByInitials
public void setSentByInitials(java.lang.String sentByInitials)
setSentByInitials.
-
sentByRecipientId
public Comment sentByRecipientId(java.lang.String sentByRecipientId)
sentByRecipientId.- Returns:
- Comment
-
getSentByRecipientId
public java.lang.String getSentByRecipientId()
.- Returns:
- sentByRecipientId
-
setSentByRecipientId
public void setSentByRecipientId(java.lang.String sentByRecipientId)
setSentByRecipientId.
-
sentByUserId
public Comment sentByUserId(java.lang.String sentByUserId)
sentByUserId.- Returns:
- Comment
-
getSentByUserId
public java.lang.String getSentByUserId()
.- Returns:
- sentByUserId
-
setSentByUserId
public void setSentByUserId(java.lang.String sentByUserId)
setSentByUserId.
-
signingGroupId
public Comment signingGroupId(java.lang.String signingGroupId)
signingGroupId.- Returns:
- Comment
-
getSigningGroupId
public java.lang.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(java.lang.String signingGroupId)
setSigningGroupId.
-
signingGroupName
public Comment signingGroupName(java.lang.String signingGroupName)
signingGroupName.- Returns:
- Comment
-
getSigningGroupName
public java.lang.String getSigningGroupName()
The display name for the signing group. Maximum Length: 100 characters. .- Returns:
- signingGroupName
-
setSigningGroupName
public void setSigningGroupName(java.lang.String signingGroupName)
setSigningGroupName.
-
subject
public Comment subject(java.lang.String subject)
subject.- Returns:
- Comment
-
getSubject
public java.lang.String getSubject()
.- Returns:
- subject
-
setSubject
public void setSubject(java.lang.String subject)
setSubject.
-
tabId
public Comment tabId(java.lang.String tabId)
tabId.- Returns:
- Comment
-
getTabId
public java.lang.String getTabId()
The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. .- Returns:
- tabId
-
setTabId
public void setTabId(java.lang.String tabId)
setTabId.
-
text
public Comment text(java.lang.String text)
text.- Returns:
- Comment
-
getText
public java.lang.String getText()
.- Returns:
- text
-
setText
public void setText(java.lang.String text)
setText.
-
threadId
public Comment threadId(java.lang.String threadId)
threadId.- Returns:
- Comment
-
getThreadId
public java.lang.String getThreadId()
.- Returns:
- threadId
-
setThreadId
public void setThreadId(java.lang.String threadId)
setThreadId.
-
threadOriginatorId
public Comment threadOriginatorId(java.lang.String threadOriginatorId)
threadOriginatorId.- Returns:
- Comment
-
getThreadOriginatorId
public java.lang.String getThreadOriginatorId()
.- Returns:
- threadOriginatorId
-
setThreadOriginatorId
public void setThreadOriginatorId(java.lang.String threadOriginatorId)
setThreadOriginatorId.
-
timestamp
public Comment timestamp(java.lang.String timestamp)
timestamp.- Returns:
- Comment
-
getTimestamp
public java.lang.String getTimestamp()
.- Returns:
- timestamp
-
setTimestamp
public void setTimestamp(java.lang.String timestamp)
setTimestamp.
-
timeStampFormatted
public Comment timeStampFormatted(java.lang.String timeStampFormatted)
timeStampFormatted.- Returns:
- Comment
-
getTimeStampFormatted
public java.lang.String getTimeStampFormatted()
.- Returns:
- timeStampFormatted
-
setTimeStampFormatted
public void setTimeStampFormatted(java.lang.String timeStampFormatted)
setTimeStampFormatted.
-
visibleTo
public Comment visibleTo(java.util.List<java.lang.String> visibleTo)
visibleTo.- Returns:
- Comment
-
addVisibleToItem
public Comment addVisibleToItem(java.lang.String visibleToItem)
addVisibleToItem.- Returns:
- Comment
-
getVisibleTo
public java.util.List<java.lang.String> getVisibleTo()
.- Returns:
- visibleTo
-
setVisibleTo
public void setVisibleTo(java.util.List<java.lang.String> visibleTo)
setVisibleTo.
-
equals
public boolean equals(java.lang.Object o)
Compares objects.- Overrides:
equalsin classjava.lang.Object- Returns:
- true or false depending on comparison result.
-
hashCode
public int hashCode()
Returns the HashCode.- Overrides:
hashCodein classjava.lang.Object
-
toString
public java.lang.String toString()
Converts the given object to string.- Overrides:
toStringin classjava.lang.Object
-
-