com.evernote.edam.type
Class NoteAttributes

java.lang.Object
  com.evernote.edam.type.NoteAttributes

All Implemented Interfaces:

com.evernote.thrift.TBase<NoteAttributes>, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<NoteAttributes>

public class NoteAttributes
extends java.lang.Object
implements com.evernote.thrift.TBase<NoteAttributes>, java.io.Serializable, java.lang.Cloneable

The list of optional attributes that can be stored on a note.

subjectDate

time that the note refers to

latitude

the latitude where the note was taken

longitude

the longitude where the note was taken

altitude

the altitude where the note was taken

author

the author of the content of the note
Length: EDAM_ATTRIBUTE_LEN_MIN - EDAM_ATTRIBUTE_LEN_MAX

source

the method that the note was added to the account, if the note wasn't directly authored in an Evernote desktop client.
Length: EDAM_ATTRIBUTE_LEN_MIN - EDAM_ATTRIBUTE_LEN_MAX

sourceURL

the original location where the resource was hosted. For web clips, this will be the URL of the page that was clipped.
Length: EDAM_ATTRIBUTE_LEN_MIN - EDAM_ATTRIBUTE_LEN_MAX

sourceApplication

an identifying string for the application that created this note. This string does not have a guaranteed syntax or structure -- it is intended for human inspection and tracking.
Length: EDAM_ATTRIBUTE_LEN_MIN - EDAM_ATTRIBUTE_LEN_MAX

shareDate

The date and time when this note was directly shared via its own URL. This is only set on notes that were individually shared - it is independent of any notebook-level sharing of the containing notebook. This field is treated as "read-only" for clients; the server will ignore changes to this field from an external client.

reminderOrder

The set of notes with this parameter set are considered "reminders" and are to be treated specially by clients to give them higher UI prominence within a notebook. The value is used to sort the reminder notes within the notebook with higher values representing greater prominence. Outside of the context of a notebook, the value of this parameter is undefined. The value is not intended to be compared to the values of reminder notes in other notebooks. In order to allow clients to place a note at a higher precedence than other notes, you should never set a value greater than the current time (as defined for a Timetstamp). To place a note at higher precedence than existing notes, set the value to the current time as defined for a timestamp (milliseconds since the epoch). Synchronizing clients must remember the time when the update was performed, using the local clock on the client, and use that value when they later upload the note to the service. Clients must not set the reminderOrder to the reminderTime as the reminderTime could be in the future. Those two fields are never intended to be related. The correct value for reminderOrder field for new notes is the "current" time when the user indicated that the note is a reminder. Clients may implement a separate "sort by date" feature to show notes ordered by reminderTime. Whenever a reminderDoneTime or reminderTime is set but a reminderOrder is not set, the server will fill in the current server time for the reminderOrder field.

reminderDoneTime

The date and time when a user dismissed/"marked done" the reminder on the note. Users typically do not manually set this value directly as it is set to the time when the user dismissed/"marked done" the reminder.

reminderTime

The date and time a user has selected to be reminded of the note. A note with this value set is known as a "reminder" and the user can be reminded, via e-mail or client-specific notifications, of the note when the time is reached or about to be reached. When a user sets a reminder time on a note that has a reminder done time, and that reminder time is in the future, then the reminder done time should be cleared. This should happen regardless of any existing reminder time that may have previously existed on the note.

placeName

Allows the user to assign a human-readable location name associated with a note. Users may assign values like 'Home' and 'Work'. Place names may also be populated with values from geonames database (e.g., a restaurant name). Applications are encouraged to normalize values so that grouping values by place name provides a useful result. Applications MUST NOT automatically add place name values based on geolocation without confirmation from the user; that is, the value in this field should be more useful than a simple automated lookup based on the note's latitude and longitude.

contentClass

The class (or type) of note. This field is used to indicate to clients that special structured information is represented within the note such that special rules apply when making modifications. If contentClass is set and the client application does not specifically support the specified class, the client MUST treat the note as read-only. In this case, the client MAY modify the note's notebook and tags via the Note.notebookGuid and Note.tagGuids fields. The client MAY also modify the reminderOrder field as well as the reminderTime and reminderDoneTime fields.

Applications should set contentClass only when they are creating notes that contain structured information that needs to be maintained in order for the user to be able to use the note within that application. Setting contentClass makes a note read-only in other applications, so there is a trade-off when an application chooses to use contentClass. Applications that set contentClass when creating notes must use a contentClass string of the form CompanyName.ApplicationName to ensure uniqueness.

Length restrictions: EDAM_NOTE_CONTENT_CLASS_LEN_MIN, EDAM_NOTE_CONTENT_CLASS_LEN_MAX
Regex: EDAM_NOTE_CONTENT_CLASS_REGEX

applicationData

Provides a location for applications to store a relatively small (4kb) blob of data that is not meant to be visible to the user and that is opaque to the Evernote service. A single application may use at most one entry in this map, using its API consumer key as the map key. See the documentation for LazyMap for a description of when the actual map values are returned by the service.

To safely add or modify your application's entry in the map, use NoteStore.setNoteApplicationDataEntry. To safely remove your application's entry from the map, use NoteStore.unsetNoteApplicationDataEntry.

Minimum length of a name (key): EDAM_APPLICATIONDATA_NAME_LEN_MIN
Sum max size of key and value: EDAM_APPLICATIONDATA_ENTRY_LEN_MAX
Syntax regex for name (key): EDAM_APPLICATIONDATA_NAME_REGEX

creatorId

The numeric user ID of the user who originally created the note.

lastEditedBy

An indication of who made the last change to the note. If you are accessing the note via a shared notebook to which you have modification rights, or if you are the owner of the notebook to which the note belongs, then you have access to the value. In this case, the value will be unset if the owner of the notebook containing the note was the last to make the modification, else it will be a string describing the guest who made the last edit. If you do not have access to this value, it will be left unset. This field is read-only by clients. The server will ignore all values set by clients into this field.

lastEditorId

The numeric user ID of the user described in lastEditedBy.

classifications

A map of classifications applied to the note by clients or by the Evernote service. The key is the string name of the classification type, and the value is a constant that begins with CLASSIFICATION_.

See Also:

Serialized Form

Constructor Summary

NoteAttributes()

NoteAttributes(NoteAttributes other)
Performs a deep copy on other.

Method Summary

void	clear() Return to the state of having just been initialized, as though you had just called the default constructor.
int	compareTo(NoteAttributes other)
NoteAttributes	deepCopy() Creates a deep copy of the object.
boolean	equals(NoteAttributes that)
boolean	equals(java.lang.Object that)
double	getAltitude()
LazyMap	getApplicationData()
java.lang.String	getAuthor()
java.util.Map<java.lang.String,java.lang.String>	getClassifications()
int	getClassificationsSize()
java.lang.String	getContentClass()
int	getCreatorId()
java.lang.String	getLastEditedBy()
int	getLastEditorId()
double	getLatitude()
double	getLongitude()
java.lang.String	getPlaceName()
long	getReminderDoneTime()
long	getReminderOrder()
long	getReminderTime()
long	getShareDate()
java.lang.String	getSource()
java.lang.String	getSourceApplication()
java.lang.String	getSourceURL()
long	getSubjectDate()
int	hashCode()
boolean	isSetAltitude() Returns true if field altitude is set (has been asigned a value) and false otherwise
boolean	isSetApplicationData() Returns true if field applicationData is set (has been asigned a value) and false otherwise
boolean	isSetAuthor() Returns true if field author is set (has been asigned a value) and false otherwise
boolean	isSetClassifications() Returns true if field classifications is set (has been asigned a value) and false otherwise
boolean	isSetContentClass() Returns true if field contentClass is set (has been asigned a value) and false otherwise
boolean	isSetCreatorId() Returns true if field creatorId is set (has been asigned a value) and false otherwise
boolean	isSetLastEditedBy() Returns true if field lastEditedBy is set (has been asigned a value) and false otherwise
boolean	isSetLastEditorId() Returns true if field lastEditorId is set (has been asigned a value) and false otherwise
boolean	isSetLatitude() Returns true if field latitude is set (has been asigned a value) and false otherwise
boolean	isSetLongitude() Returns true if field longitude is set (has been asigned a value) and false otherwise
boolean	isSetPlaceName() Returns true if field placeName is set (has been asigned a value) and false otherwise
boolean	isSetReminderDoneTime() Returns true if field reminderDoneTime is set (has been asigned a value) and false otherwise
boolean	isSetReminderOrder() Returns true if field reminderOrder is set (has been asigned a value) and false otherwise
boolean	isSetReminderTime() Returns true if field reminderTime is set (has been asigned a value) and false otherwise
boolean	isSetShareDate() Returns true if field shareDate is set (has been asigned a value) and false otherwise
boolean	isSetSource() Returns true if field source is set (has been asigned a value) and false otherwise
boolean	isSetSourceApplication() Returns true if field sourceApplication is set (has been asigned a value) and false otherwise
boolean	isSetSourceURL() Returns true if field sourceURL is set (has been asigned a value) and false otherwise
boolean	isSetSubjectDate() Returns true if field subjectDate is set (has been asigned a value) and false otherwise
void	putToClassifications(java.lang.String key, java.lang.String val)
void	read(com.evernote.thrift.protocol.TProtocol iprot) Reads an instance of the object from the given protocol.
void	setAltitude(double altitude)
void	setAltitudeIsSet(boolean value)
void	setApplicationData(LazyMap applicationData)
void	setApplicationDataIsSet(boolean value)
void	setAuthor(java.lang.String author)
void	setAuthorIsSet(boolean value)
void	setClassifications(java.util.Map<java.lang.String,java.lang.String> classifications)
void	setClassificationsIsSet(boolean value)
void	setContentClass(java.lang.String contentClass)
void	setContentClassIsSet(boolean value)
void	setCreatorId(int creatorId)
void	setCreatorIdIsSet(boolean value)
void	setLastEditedBy(java.lang.String lastEditedBy)
void	setLastEditedByIsSet(boolean value)
void	setLastEditorId(int lastEditorId)
void	setLastEditorIdIsSet(boolean value)
void	setLatitude(double latitude)
void	setLatitudeIsSet(boolean value)
void	setLongitude(double longitude)
void	setLongitudeIsSet(boolean value)
void	setPlaceName(java.lang.String placeName)
void	setPlaceNameIsSet(boolean value)
void	setReminderDoneTime(long reminderDoneTime)
void	setReminderDoneTimeIsSet(boolean value)
void	setReminderOrder(long reminderOrder)
void	setReminderOrderIsSet(boolean value)
void	setReminderTime(long reminderTime)
void	setReminderTimeIsSet(boolean value)
void	setShareDate(long shareDate)
void	setShareDateIsSet(boolean value)
void	setSource(java.lang.String source)
void	setSourceApplication(java.lang.String sourceApplication)
void	setSourceApplicationIsSet(boolean value)
void	setSourceIsSet(boolean value)
void	setSourceURL(java.lang.String sourceURL)
void	setSourceURLIsSet(boolean value)
void	setSubjectDate(long subjectDate)
void	setSubjectDateIsSet(boolean value)
java.lang.String	toString()
void	unsetAltitude()
void	unsetApplicationData()
void	unsetAuthor()
void	unsetClassifications()
void	unsetContentClass()
void	unsetCreatorId()
void	unsetLastEditedBy()
void	unsetLastEditorId()
void	unsetLatitude()
void	unsetLongitude()
void	unsetPlaceName()
void	unsetReminderDoneTime()
void	unsetReminderOrder()
void	unsetReminderTime()
void	unsetShareDate()
void	unsetSource()
void	unsetSourceApplication()
void	unsetSourceURL()
void	unsetSubjectDate()
void	validate()
void	write(com.evernote.thrift.protocol.TProtocol oprot) Writes the object to the given protocol.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NoteAttributes

public NoteAttributes()

NoteAttributes

public NoteAttributes(NoteAttributes other)

Performs a deep copy on other.

Method Detail

deepCopy

public NoteAttributes deepCopy()

Description copied from interface: com.evernote.thrift.TBase

Creates a deep copy of the object.

Specified by:

deepCopy in interface com.evernote.thrift.TBase<NoteAttributes>

clear

public void clear()

Description copied from interface: com.evernote.thrift.TBase

Return to the state of having just been initialized, as though you had just called the default constructor.

Specified by:

clear in interface com.evernote.thrift.TBase<NoteAttributes>

getSubjectDate

public long getSubjectDate()

setSubjectDate

public void setSubjectDate(long subjectDate)

unsetSubjectDate

public void unsetSubjectDate()

isSetSubjectDate

public boolean isSetSubjectDate()

Returns true if field subjectDate is set (has been asigned a value) and false otherwise

setSubjectDateIsSet

public void setSubjectDateIsSet(boolean value)

getLatitude

public double getLatitude()

setLatitude

public void setLatitude(double latitude)

unsetLatitude

public void unsetLatitude()

isSetLatitude

public boolean isSetLatitude()

Returns true if field latitude is set (has been asigned a value) and false otherwise

setLatitudeIsSet

public void setLatitudeIsSet(boolean value)

getLongitude

public double getLongitude()

setLongitude

public void setLongitude(double longitude)

unsetLongitude

public void unsetLongitude()

isSetLongitude

public boolean isSetLongitude()

Returns true if field longitude is set (has been asigned a value) and false otherwise

setLongitudeIsSet

public void setLongitudeIsSet(boolean value)

getAltitude

public double getAltitude()

setAltitude

public void setAltitude(double altitude)

unsetAltitude

public void unsetAltitude()

isSetAltitude

public boolean isSetAltitude()

Returns true if field altitude is set (has been asigned a value) and false otherwise

setAltitudeIsSet

public void setAltitudeIsSet(boolean value)

getAuthor

public java.lang.String getAuthor()

setAuthor

public void setAuthor(java.lang.String author)

unsetAuthor

public void unsetAuthor()

isSetAuthor

public boolean isSetAuthor()

Returns true if field author is set (has been asigned a value) and false otherwise

setAuthorIsSet

public void setAuthorIsSet(boolean value)

getSource

public java.lang.String getSource()

setSource

public void setSource(java.lang.String source)

unsetSource

public void unsetSource()

isSetSource

public boolean isSetSource()

Returns true if field source is set (has been asigned a value) and false otherwise

setSourceIsSet

public void setSourceIsSet(boolean value)

getSourceURL

public java.lang.String getSourceURL()

setSourceURL

public void setSourceURL(java.lang.String sourceURL)

unsetSourceURL

public void unsetSourceURL()

isSetSourceURL

public boolean isSetSourceURL()

Returns true if field sourceURL is set (has been asigned a value) and false otherwise

setSourceURLIsSet

public void setSourceURLIsSet(boolean value)

getSourceApplication

public java.lang.String getSourceApplication()

setSourceApplication

public void setSourceApplication(java.lang.String sourceApplication)

unsetSourceApplication

public void unsetSourceApplication()

isSetSourceApplication

public boolean isSetSourceApplication()

Returns true if field sourceApplication is set (has been asigned a value) and false otherwise

setSourceApplicationIsSet

public void setSourceApplicationIsSet(boolean value)

getShareDate

public long getShareDate()

setShareDate

public void setShareDate(long shareDate)

unsetShareDate

public void unsetShareDate()

isSetShareDate

public boolean isSetShareDate()

Returns true if field shareDate is set (has been asigned a value) and false otherwise

setShareDateIsSet

public void setShareDateIsSet(boolean value)

getReminderOrder

public long getReminderOrder()

setReminderOrder

public void setReminderOrder(long reminderOrder)

unsetReminderOrder

public void unsetReminderOrder()

isSetReminderOrder

public boolean isSetReminderOrder()

Returns true if field reminderOrder is set (has been asigned a value) and false otherwise

setReminderOrderIsSet

public void setReminderOrderIsSet(boolean value)

getReminderDoneTime

public long getReminderDoneTime()

setReminderDoneTime

public void setReminderDoneTime(long reminderDoneTime)

unsetReminderDoneTime

public void unsetReminderDoneTime()

isSetReminderDoneTime

public boolean isSetReminderDoneTime()

Returns true if field reminderDoneTime is set (has been asigned a value) and false otherwise

setReminderDoneTimeIsSet

public void setReminderDoneTimeIsSet(boolean value)

getReminderTime

public long getReminderTime()

setReminderTime

public void setReminderTime(long reminderTime)

unsetReminderTime

public void unsetReminderTime()

isSetReminderTime

public boolean isSetReminderTime()

Returns true if field reminderTime is set (has been asigned a value) and false otherwise

setReminderTimeIsSet

public void setReminderTimeIsSet(boolean value)

getPlaceName

public java.lang.String getPlaceName()

setPlaceName

public void setPlaceName(java.lang.String placeName)

unsetPlaceName

public void unsetPlaceName()

isSetPlaceName

public boolean isSetPlaceName()

Returns true if field placeName is set (has been asigned a value) and false otherwise

setPlaceNameIsSet

public void setPlaceNameIsSet(boolean value)

getContentClass

public java.lang.String getContentClass()

setContentClass

public void setContentClass(java.lang.String contentClass)

unsetContentClass

public void unsetContentClass()

isSetContentClass

public boolean isSetContentClass()

Returns true if field contentClass is set (has been asigned a value) and false otherwise

setContentClassIsSet

public void setContentClassIsSet(boolean value)

getApplicationData

public LazyMap getApplicationData()

setApplicationData

public void setApplicationData(LazyMap applicationData)

unsetApplicationData

public void unsetApplicationData()

isSetApplicationData

public boolean isSetApplicationData()

Returns true if field applicationData is set (has been asigned a value) and false otherwise

setApplicationDataIsSet

public void setApplicationDataIsSet(boolean value)

getLastEditedBy

public java.lang.String getLastEditedBy()

setLastEditedBy

public void setLastEditedBy(java.lang.String lastEditedBy)

unsetLastEditedBy

public void unsetLastEditedBy()

isSetLastEditedBy

public boolean isSetLastEditedBy()

Returns true if field lastEditedBy is set (has been asigned a value) and false otherwise

setLastEditedByIsSet

public void setLastEditedByIsSet(boolean value)

getClassificationsSize

public int getClassificationsSize()

putToClassifications

public void putToClassifications(java.lang.String key,
                                 java.lang.String val)

getClassifications

public java.util.Map<java.lang.String,java.lang.String> getClassifications()

setClassifications

public void setClassifications(java.util.Map<java.lang.String,java.lang.String> classifications)

unsetClassifications

public void unsetClassifications()

isSetClassifications

public boolean isSetClassifications()

Returns true if field classifications is set (has been asigned a value) and false otherwise

setClassificationsIsSet

public void setClassificationsIsSet(boolean value)

getCreatorId

public int getCreatorId()

setCreatorId

public void setCreatorId(int creatorId)

unsetCreatorId

public void unsetCreatorId()

isSetCreatorId

public boolean isSetCreatorId()

Returns true if field creatorId is set (has been asigned a value) and false otherwise

setCreatorIdIsSet

public void setCreatorIdIsSet(boolean value)

getLastEditorId

public int getLastEditorId()

setLastEditorId

public void setLastEditorId(int lastEditorId)

unsetLastEditorId

public void unsetLastEditorId()

isSetLastEditorId

public boolean isSetLastEditorId()

Returns true if field lastEditorId is set (has been asigned a value) and false otherwise

setLastEditorIdIsSet

public void setLastEditorIdIsSet(boolean value)

equals

public boolean equals(java.lang.Object that)

Overrides:

equals in class java.lang.Object

equals

public boolean equals(NoteAttributes that)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(NoteAttributes other)

Specified by:

compareTo in interface java.lang.Comparable<NoteAttributes>

read

public void read(com.evernote.thrift.protocol.TProtocol iprot)
          throws com.evernote.thrift.TException

Description copied from interface: com.evernote.thrift.TBase

Reads an instance of the object from the given protocol.

Specified by:

read in interface com.evernote.thrift.TBase<NoteAttributes>

Parameters:

iprot - Input protocol

Throws:

com.evernote.thrift.TException

write

public void write(com.evernote.thrift.protocol.TProtocol oprot)
           throws com.evernote.thrift.TException

Description copied from interface: com.evernote.thrift.TBase

Writes the object to the given protocol.

Specified by:

write in interface com.evernote.thrift.TBase<NoteAttributes>

Parameters:

oprot - Output protocol

Throws:

com.evernote.thrift.TException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

validate

public void validate()
              throws com.evernote.thrift.TException

Throws:

com.evernote.thrift.TException