CalendarEntry

```
public interface CalendarEntry
```
CalendarEntry is a BBj Interface that contains information for a BBjCalendarWidget's entry (event, appointment, etc.). Note: The values for date/time parameters should be in ISO 8601 format as in:
- YYYY-MM-DD, e.g. "1997-07-16" for dates.
- YYYY-MM-DDThh:mm:ss, e.g. "1997-07-16T19:20:00" for dates and times.
- YYYY-MM-DDThh:mm:ssZ, e.g. "1997-07-16T19:20:00-06:00" for dates and times with timezone information.
Note: All ending date/time parameters are exclusive. For example, an event with the end of 2018-09-03 will appear to span through 2018-09-02 but end before the start of 2018-09-03.
Since:

BBj 21.00

See Also:

Date and Time Formats for information on ISO 8601 date/time formats.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addClassName(BBjString className!)` Adds the provided class name string (or CSS style) such as `"myclass1"` to the entry's vector of class names.
`void`	`addExtendedProperty(BBjString key!, BBjString value!)` Adds the provided extended property to the entry's HashMap of extended properties given the property key and value.
`void`	`addTag(BBjString tag!)` Adds the provided tag to the entry's vector of tags.
`static BBjString`	`CALENDAR_ENTRY_DISPLAY_AUTO()` When in daygrid view, it renders the entry as a solid rectangle if it is all-day or multi-day.
`static BBjString`	`CALENDAR_ENTRY_DISPLAY_BACKGROUND()` This modifies the background of the entry's date/time frame in the calendar.
`static BBjString`	`CALENDAR_ENTRY_DISPLAY_BLOCK()` When in daygrid view, it renders the entry as a solid rectangle.
`static BBjString`	`CALENDAR_ENTRY_DISPLAY_INVERSE_BACKGROUND()` This inversely modifies the background of the entry's date/time frame in the calendar.
`static BBjString`	`CALENDAR_ENTRY_DISPLAY_LIST_ITEM()` When in daygrid view, it renders the entry as a colored dot.
`static BBjString`	`CALENDAR_ENTRY_DISPLAY_NONE()` This hides the entry on the calendar.
`BBjNumber`	`containsAllTags(BBjString tags!)` Returns whether a `CalendarEntry` contains all the provided tags in comma-delimted string in the entry's vector of tags.
`BBjNumber`	`containsAllTags(BBjVector tags!)` Returns whether an entry contains all the provided tags in the entry's vector of tags.
`BBjNumber`	`containsAnyTag(BBjString tags!)` Returns whether an entry contains any of the provided tags in the entry's vector of tags.
`BBjNumber`	`containsAnyTag(BBjVector tags!)` Returns whether an entry contains any of the provided tags in the entry's vector of tags.
`BBjNumber`	`containsExtendedPropertyKey(BBjString key!)` Returns whether the provided extended property key exists the entry's HashMap of extended properties.
`BBjNumber`	`containsTag(BBjString tag!)` Returns whether the provided tag exists the entry's vector of tags.
`BBjNumber`	`getAllDay()` Returns an entry's all-day status that determines if the entry is shown in the "all-day" section of the view, if applicable.
`BBjString`	`getAsFormattedString()` Returns a formatted, i.e.
`JsonObject`	`getAsJsonObject()` Returns a JsonObject representation of the `CalendarEntry` object.
`BBjString`	`getAsString()` Returns a stringified JsonObject representation of the `CalendarEntry` object.
`BBjString`	`getBackgroundColor()` Returns an entry's background color.
`BBjString`	`getBorderColor()` Returns an entry's border color.
`BBjString`	`getClassName()` Deprecated. Deprecated in BBj 21.12 because this only supports a single class name and the class has methods that support mutliple class names. Please use the `getClassNames()` method instead.
`BBjVector`	`getClassNames()` Returns an entry's class names (or CSS styles) in a vector of strings.
`BBjString`	`getColor()` Returns an entry's combined background and border color, or null if the `CalendarEvent` object was provided by the FullCalendar.
`BBjString`	`getDescription()` Returns an entry's extended information that can be used to further describe the entry beyond the title text.
`BBjString`	`getDisplay()` Returns an entry's display style.
`BBjNumber`	`getEnableDurationEditable()` Returns the entry's duration editable status that determines if the entry's duration can be modified by the user by dragging (resizing).
`BBjNumber`	`getEnableEditable()` Returns the entry's editable status that determines if the entry can be modified by the user.
`BBjNumber`	`getEnableEntryOverlap()` Returns an entry's overlap status that determines if the entries may be dragged/resized over one another.
`BBjNumber`	`getEnableStartEditable()` Returns the entry's start time editable status that determines if the entry's start time can be modified by the user by dragging (resizing).
`BBjString`	`getEnd()` Returns an entry's exclusive ending date/time.
`HashMap`	`getExtendedProperties()` Returns an entry's custom key/value string pairs that define the entry's custom properties
`BBjString`	`getExtendedPropertyValue(BBjString key!)` Returns the value of the provided extended property if the key exists in the entry's HashMap of extended properties.
`BBjString`	`getGroupId()` Returns an entry's group ID.
`BBjString`	`getId()` Returns an entry's unique ID if it has previously been set.
`BBjString`	`getLocation()` Returns an entry's extended information that can be used to further describe the entry beyond the title text.
`BBjString`	`getStart()` Returns an entry's starting date/time.
`BBjVector`	`getTags()` Returns an entry's tags in a vector of strings.
`BBjString`	`getTextColor()` Returns an entry's text color.
`BBjString`	`getTitle()` Returns an entry's optional unique ID if it has previously been set.
`BBjString`	`getUrl()` Returns an entry's associated URL that may be visited when this entry is clicked by the user.
`BBjString`	`getUuid()` Returns an entry's unique UUID that is automatically generated for all entries.
`void`	`removeClassName(BBjString className!)` Removes the provided class name string (or CSS style) from the entry's vector of class names.
`void`	`removeExtendedProperty(BBjString key!)` Removes the extended property from the entry's HashMap of extended properties given the property key.
`void`	`removeTag(BBjString tag!)` Removes the provided tag from the entry's vector of tags.
`void`	`setAllDay(BBjNumber allDay!)` Sets an entry's all-day status that determines if the entry is shown in the "all-day" section of the view, if applicable.
`void`	`setBackgroundColor(BBjString backgroundColor!)` Sets an entry's background color.
`void`	`setBorderColor(BBjString borderColor!)` Sets an entry's border color.
`void`	`setClassName(BBjString className!)` Deprecated. Deprecated in BBj 21.12 because this only supports a single class name and the class has methods that support mutliple class names. Please use the either the `setClassNames(BBjVector)` or `setClassNames(BBjString)` method instead.
`void`	`setClassNames(BBjString classNames!)` Sets an entry's class names (or CSS styles) from a comma-delimited string that determine the HTML class that's associated with the entry.
`void`	`setClassNames(BBjVector classNames!)` Sets an entry's class names (or CSS styles) from a BBjVector that determine the HTML class that's associated with the entry.
`void`	`setColor(BBjString color!)` Sets an entry's combined background and border color.
`void`	`setColors(BBjString backgroundColor!, BBjString borderColor!, BBjString textColor!)` A convenience method that sets an entry's background, border, and text colors in a single method call.
`void`	`setDescription(BBjString description!)` Sets an entry's extended information that can be used to further describe the entry beyond the title text.
`void`	`setDisplay(BBjString display!)` Sets an entry's alternate rendering style.
`void`	`setEnableDurationEditable(BBjNumber durationEditable!)` Sets an entry's duration editable status that determines if the entry's duration can be modified by the user by dragging (resizing).
`void`	`setEnableEditable(BBjNumber editable!)` Sets an entry's editable status that determines if the user can modify the entry, i.e.
`void`	`setEnableEntryOverlap(BBjNumber overlap!)` Sets an entry's overlap status that determines if the entries may be dragged/resized over one another.
`void`	`setEnableStartEditable(BBjNumber startEditable!)` Sets an entry's start time editable status that determines if the entry's start time can be modified by the user by dragging (resizing).
`void`	`setEnd(BBjString end!)` Sets an entry's exclusive ending date/time.
`void`	`setExtendedProperties(HashMap extendedProperties!)` Sets an entry's extended properties, i.e.
`void`	`setGroupId(BBjString groupId!)` Sets an entry's group ID.
`void`	`setId(BBjString id!)` Sets an entry's optional unique ID that can be used later to identify the entry.
`void`	`setLocation(BBjString location!)` Sets an entry's location that can be used to define a location for the entry.
`void`	`setStart(BBjString start!)` Sets an entry's starting date/time.
`void`	`setTags(BBjString tags!)` Sets an entry's tags that can be used for a variety of purposes such as hiding or showing entries based on given tags.
`void`	`setTags(BBjVector tags!)` Sets an entry's tags that can be used for a variety of purposes such as hiding or showing entries based on given tags.
`void`	`setTextColor(BBjString textColor!)` Sets an entry's text color.
`void`	`setTitle(BBjString title!)` Sets entry's title that is the description/summary text that will appear on an entry.
`void`	`setUrl(BBjString url!)` Sets an entry's associated URL that may be visited when this entry is clicked by the user.

- Method Detail
  - CALENDAR_ENTRY_DISPLAY_AUTO
```
static BBjString CALENDAR_ENTRY_DISPLAY_AUTO()
```
    When in daygrid view, it renders the entry as a solid rectangle if it is all-day or multi-day. If it's a timed entry, it renders the entry as a colored a dot. When in other views, the entry will render normally.
    
    Returns:
    
    A BBjString with the 'auto' display style which is the default.
  - CALENDAR_ENTRY_DISPLAY_BLOCK
```
static BBjString CALENDAR_ENTRY_DISPLAY_BLOCK()
```
    When in daygrid view, it renders the entry as a solid rectangle. When in other views, the entry will render normally.
    
    Returns:
    
    A BBjString with the 'auto' display style which is the default.
  - CALENDAR_ENTRY_DISPLAY_LIST_ITEM
```
static BBjString CALENDAR_ENTRY_DISPLAY_LIST_ITEM()
```
    When in daygrid view, it renders the entry as a colored dot. When in other views, the entry will render normally.
    
    Returns:
    
    A BBjString with the 'auto' display style which is the default.
  - CALENDAR_ENTRY_DISPLAY_BACKGROUND
```
static BBjString CALENDAR_ENTRY_DISPLAY_BACKGROUND()
```
    This modifies the background of the entry's date/time frame in the calendar.
  - CALENDAR_ENTRY_DISPLAY_INVERSE_BACKGROUND
```
static BBjString CALENDAR_ENTRY_DISPLAY_INVERSE_BACKGROUND()
```
    This inversely modifies the background of the entry's date/time frame in the calendar.
  - CALENDAR_ENTRY_DISPLAY_NONE
```
static BBjString CALENDAR_ENTRY_DISPLAY_NONE()
```
    This hides the entry on the calendar.
  - setId
```
void setId(BBjString id!)
```
    Sets an entry's optional unique ID that can be used later to identify the entry. If the entry's ID is not provided, it will be set to the same value as the UUID, which is guaranteed to be set automatically.
    
    Parameters:
    
    BBjString - id! A string to uniquely identify the entry.
  - getId
```
BBjString getId()
```
    Returns an entry's unique ID if it has previously been set. If the entry's ID was set at creation time, it will be set to the same value as the UUID, which is guaranteed to be set automatically.
    
    Returns:
    
    BBjString The entry's ID, or null() if it has not been previously been set.
  - getUuid
```
BBjString getUuid()
```
    Returns an entry's unique UUID that is automatically generated for all entries.
    
    Returns:
    
    BBjString The entry's automatically generated UUID.
  - setTitle
```
void setTitle(BBjString title!)
```
    Sets entry's title that is the description/summary text that will appear on an entry.
    
    Parameters:
    
    BBjString - title! A string to be used as the entry's title.
  - getTitle
```
BBjString getTitle()
```
    Returns an entry's optional unique ID if it has previously been set.
    
    Returns:
    
    BBjString The entry's title.
  - setDescription
```
void setDescription(BBjString description!)
```
    Sets an entry's extended information that can be used to further describe the entry beyond the title text. Note that the description property is not one of the standard FullCalendar fields. The BBjCalendarWidget will manage this field automatically so that you don't need to use the set/getExtendedProperties() methods in order to work with this property.
    
    Parameters:
    
    BBjString - description! A string that's used to further describe the entry beyond the title text.
    
    See Also:
    
    FullCalendar Event Object for information about non-standard fields.
  - getDescription
```
BBjString getDescription()
```
    Returns an entry's extended information that can be used to further describe the entry beyond the title text.
    
    Returns:
    
    BBjString The entry's description.
  - setLocation
```
void setLocation(BBjString location!)
```
    Sets an entry's location that can be used to define a location for the entry. Note that the location property is not one of the standard FullCalendar fields. The BBjCalendarWidget will manage this field automatically so that you don't need to use the set/getExtendedProperties() methods in order to work with this property.
    
    Parameters:
    
    BBjString - location! A string that's used to define a location for the entry.
    
    See Also:
    
    FullCalendar Event Object for information about non-standard fields.
  - getLocation
```
BBjString getLocation()
```
    Returns an entry's extended information that can be used to further describe the entry beyond the title text.
    
    Returns:
    
    BBjString The entry's location.
  - setUrl
```
void setUrl(BBjString url!)
```
    Sets an entry's associated URL that may be visited when this entry is clicked by the user.
    
    Parameters:
    
    BBjString - url! A string that contains a URL to be associated with the entry.
  - getUrl
```
BBjString getUrl()
```
    Returns an entry's associated URL that may be visited when this entry is clicked by the user.
    
    Returns:
    
    BBjString The entry's URL.
  - setGroupId
```
void setGroupId(BBjString groupId!)
```
    Sets an entry's group ID. Entries that share a groupId will be dragged and resized together automatically.
    
    Parameters:
    
    BBjString - groupId! A string that contains the entry's group ID. Entries that share a groupId will be dragged and resized together automatically.
  - getGroupId
```
BBjString getGroupId()
```
    Returns an entry's group ID. Entries that share a groupId will be dragged and resized together automatically.
    
    Returns:
    
    BBjString The entry's group ID.
  - setAllDay
```
void setAllDay(BBjNumber allDay!)
```
    Sets an entry's all-day status that determines if the entry is shown in the "all-day" section of the view, if applicable.
    
    Parameters:
    
    BBjNumber - allDay! A BBjNumber acting as a boolean that determines if the entry lasts all day (1) or not (0).
  - getAllDay
```
BBjNumber getAllDay()
```
    Returns an entry's all-day status that determines if the entry is shown in the "all-day" section of the view, if applicable.
    
    Returns:
    
    BBjNumber The entry's all-day status where 1 = all-day and 0 = a timed entry.
  - setEnableEntryOverlap
```
void setEnableEntryOverlap(BBjNumber overlap!)
```
    Sets an entry's overlap status that determines if the entries may be dragged/resized over one another.
    
    Parameters:
    
    BBjNumber - overlap! A BBjNumber acting as a boolean that determines if entries can overlap one another (1) or not (0).
  - getEnableEntryOverlap
```
BBjNumber getEnableEntryOverlap()
```
    Returns an entry's overlap status that determines if the entries may be dragged/resized over one another.
    
    Returns:
    
    BBjNumber The entry's overlap status where 1 = entries may overlap and 0 = entries cannot overlap.
  - setStart
```
void setStart(BBjString start!)
```
    Sets an entry's starting date/time. If the entry is explicitly all-day, then the time portion will be ignored.
    
    Parameters:
    
    BBjString - start! A string that contains the starting date/time for the entry.
  - getStart
```
BBjString getStart()
```
    Returns an entry's starting date/time.
    
    Returns:
    
    BBjString The entry's starting date/time.
  - setEnd
```
void setEnd(BBjString end!)
```
    Sets an entry's exclusive ending date/time. If the entry is explicitly all-day, then the time portion will be ignored.
    
    Parameters:
    
    BBjString - end! A string that contains the ending date/time for the entry.
  - getEnd
```
BBjString getEnd()
```
    Returns an entry's exclusive ending date/time.
    
    Returns:
    
    BBjString The entry's ending date/time.
  - setBackgroundColor
```
void setBackgroundColor(BBjString backgroundColor!)
```
    Sets an entry's background color.
    Colors may be specified as any valid CSS color, so "red", "rgb(255, 0, 0)", "#ff0000", "#f00", "hsl(0, 100%, 50%)", and all the versions of those formats that include an alpha channel are valid ways of specifying the color red.
    
    Parameters:
    
    BBjString - backgroundColor! A string that contains the color for the entry's background.
  - getBackgroundColor
```
BBjString getBackgroundColor()
```
    Returns an entry's background color.
    
    Returns:
    
    BBjString The entry's entry's background color.
  - setBorderColor
```
void setBorderColor(BBjString borderColor!)
```
    Sets an entry's border color.
    Colors may be specified as any valid CSS color, so "red", "rgb(255, 0, 0)", "#ff0000", "#f00", "hsl(0, 100%, 50%)", and all the versions of those formats that include an alpha channel are valid ways of specifying the color red.
    
    Parameters:
    
    BBjString - borderColor! A string that contains the color for the entry's border.
  - getBorderColor
```
BBjString getBorderColor()
```
    Returns an entry's border color.
    
    Returns:
    
    BBjString The entry's border color.
  - setTextColor
```
void setTextColor(BBjString textColor!)
```
    Sets an entry's text color.
    Colors may be specified as any valid CSS color, so "red", "rgb(255, 0, 0)", "#ff0000", "#f00", "hsl(0, 100%, 50%)", and all the versions of those formats that include an alpha channel are valid ways of specifying the color red.
    
    Parameters:
    
    BBjString - textColor! A string that contains the color for the entry's text.
  - getTextColor
```
BBjString getTextColor()
```
    Returns an entry's text color.
    
    Returns:
    
    BBjString The entry's text color.
  - setColor
```
void setColor(BBjString color!)
```
    Sets an entry's combined background and border color. Note: For a quick way to set a CalendarEvent's colors, see the setColors(backgroundColor!, borderColor!, textColor!) method.
    Note: This is a shorthand way of specifying the backgroundColor and borderColor at the same time. The color will be passed to the FullCalendar, but it internally sets the backgroundColor and borderColor to the value of the specified color and discards the given color. Therefore, you can set colors with this method, but the corresponding getColor() method may not return anything if you're working with a CalendarEvent object that was returned from the FullCalendar.
    Colors may be specified as any valid CSS color, so "red", "rgb(255, 0, 0)", "#ff0000", "#f00", "hsl(0, 100%, 50%)", and all the versions of those formats that include an alpha channel are valid ways of specifying the color red.
    
    Parameters:
    
    BBjString - color! A string that contains the color for the entry's background and border.
  - getColor
```
BBjString getColor()
```
    Returns an entry's combined background and border color, or null if the CalendarEvent object was provided by the FullCalendar. This is because the setColor() method is a shorthand way of specifying the backgroundColor and borderColor at the same time. The color will be passed to the FullCalendar, but it internally sets the backgroundColor and borderColor to the value of the specified color and discards the given color. Therefore, you can set colors with the setColor() method, but this getColor() method may not return anything if you're working with a CalendarEvent object that was returned from the FullCalendar.
    Note: For a quick way to set a CalendarEvent's colors, see the setColors(backgroundColor!, borderColor!, textColor!) method.
    
    Returns:
    
    BBjString The entry's combined background and border color.
  - setColors
```
void setColors(BBjString backgroundColor!,
BBjString borderColor!,
BBjString textColor!)
```
    A convenience method that sets an entry's background, border, and text colors in a single method call.
    Colors may be specified as any valid CSS color, so "red", "rgb(255, 0, 0)", "#ff0000", "#f00", "hsl(0, 100%, 50%)", and all the versions of those formats that include an alpha channel are valid ways of specifying the color red.
    
    Parameters:
    
    BBjString - color! A string that contains the color for the entry's background and border.
  - setClassName
```
void setClassName(BBjString className!)
```
    Deprecated. Deprecated in BBj 21.12 because this only supports a single class name and the class has methods that support mutliple class names. Please use the either the setClassNames(BBjVector) or setClassNames(BBjString) method instead.
    
    DEPRECATED Sets an entry's class name string (or CSS style) such as "myclass1", that determines the HTML class that's associated with the entry.
    See the setClassNames() methods to set multiple class names.
    
    Parameters:
    
    BBjString - className! A string that contains a class name string (or CSS style), such as "myclass1", that determines the HTML class that's associated with the entry.
  - getClassName
```
BBjString getClassName()
```
    Deprecated. Deprecated in BBj 21.12 because this only supports a single class name and the class has methods that support mutliple class names. Please use the getClassNames() method instead.
    
    DEPRECATED Returns an entry's a class name string.
    
    Returns:
    
    BBjString The entry's a class name string.
  - setClassNames
```
void setClassNames(BBjVector classNames!)
```
    Sets an entry's class names (or CSS styles) from a BBjVector that determine the HTML class that's associated with the entry. Class names should NOT be preceeded by a period, so possible class names could be work or personal.
    Note that this sets all the class names at once. It's possible to add class names, regardless of whether they have been set or not, using the addClassName() method. To remove a single class name from the entry, you can call the removeClassName() method, or get all the class names in a vector, remove the undesired classes, then set the class names.
    Here's an example of how you can use custom class names and the BBjCalendarWidget's injectCSS() method to affect a calendar entry's display:
    rem Create a calendar entry for 3PM today and give it a custom CSS class name of "small-text", then add it to the calendar myEntry! = CalendarAPI.createCalendarEntry("Write Advantage Article", date(0, "%Yl-%Mz-%Dz") + "T15:00:00") myEntry!.addClassName("small-text") myCal!.addEntry(myEntry!) rem Inject custom CSS to change the event's text size myCal!.injectCss(" .small-text div { font-size: 7px; } ")
    Parameters:
    
    BBjVector - classNames! A vector of strings with the entry's class names (or CSS styles) such as "myclass1", that determines the HTML class that's associated with the entry.
  - setClassNames
```
void setClassNames(BBjString classNames!)
```
    Sets an entry's class names (or CSS styles) from a comma-delimited string that determine the HTML class that's associated with the entry. Class names should NOT be preceeded by a period, so possible class names could be work or personal.
    This is similar to the setClassNames() method that takes a BBjVector except that it takes a comma-delimted string of class names for succinctness.
    Note that this sets all the class names at once. It's possible to add class names, regardless of whether they have been set or not, using the addClassName() method. To remove a single class name from the entry, you can call the removeClassName() method, or get all the class names in a vector, remove the undesired classes, then set the class names.
    Here's an example of how you can use custom class names and the BBjCalendarWidget's injectCSS() method to affect a calendar entry's display:
    rem Create a calendar entry for 3PM today and give it a custom CSS class name of "small-text", then add it to the calendar myEntry! = CalendarAPI.createCalendarEntry("Write Advantage Article", date(0, "%Yl-%Mz-%Dz") + "T15:00:00") myEntry!.addClassName("small-text") myCal!.addEntry(myEntry!) rem Inject custom CSS to change the event's text size myCal!.injectCss(" .small-text div { font-size: 7px; } ")
    Parameters:
    
    BBjString - classNames! A comma-delimted string of class names such as "work, personal".
    
    Since:
    
    BBj 21.12
  - getClassNames
```
BBjVector getClassNames()
```
    Returns an entry's class names (or CSS styles) in a vector of strings.
    
    Returns:
    
    BBjString The entry's class names in a vector of strings.
  - addClassName
```
void addClassName(BBjString className!)
```
    Adds the provided class name string (or CSS style) such as "myclass1" to the entry's vector of class names.
    This method can be used in place of the setClassNames() method as it adds the provided class name to the entry's vector of class names. It may be easier to call this method if you only need to set a few tags, as the setClassNames() method requires you to create and populate a BBjVector (unless you use the version that takes a comma-delimited string).
    Here's an example of how you can use custom class names and the BBjCalendarWidget's injectCSS() method to affect a calendar entry's display:
    rem Create a calendar entry for 3PM today and give it a custom CSS class name of "small-text", then add it to the calendar myEntry! = CalendarAPI.createCalendarEntry("Write Advantage Article", date(0, "%Yl-%Mz-%Dz") + "T15:00:00") myEntry!.addClassName("small-text") myCal!.addEntry(myEntry!) rem Inject custom CSS to change the event's text size myCal!.injectCss(" .small-text div { font-size: 7px; } ")
    Parameters:
    
    BBjString - className! The class name (or CSS style) such as "myclass1" to add to the entry.
    
    Since:
    
    BBj 21.12
  - removeClassName
```
void removeClassName(BBjString className!)
```
    Removes the provided class name string (or CSS style) from the entry's vector of class names.
    
    Parameters:
    
    BBjString - className! The class name (or CSS style) to remove from the entry's vector of class names.
    
    Since:
    
    BBj 21.12
  - setTags
```
void setTags(BBjVector tags!)
```
    Sets an entry's tags that can be used for a variety of purposes such as hiding or showing entries based on given tags.
    
    Parameters:
    
    BBjVector - tags! A vector of strings with the entry's tags.
  - setTags
```
void setTags(BBjString tags!)
```
    Sets an entry's tags that can be used for a variety of purposes such as hiding or showing entries based on given tags.
    This is similar to the setTags() method that takes a BBjVector except that it takes a comma-delimted string of tags for succinctness.
    
    Parameters:
    
    BBjString - tags! A comma-delimted string of tags such as "work, programming".
  - getTags
```
BBjVector getTags()
```
    Returns an entry's tags in a vector of strings.
    
    Returns:
    
    BBjVector The entry's tags in a vector of strings.
  - addTag
```
void addTag(BBjString tag!)
```
    Adds the provided tag to the entry's vector of tags.
    This method can be used in place of the setTags() method as it adds the provided tag to the entry's vector of tags. It may be easier to call this method if you only need to set a few tags, as the setTags() method requires you to create and populate a BBjVector or a comma-delimited string.
    
    Parameters:
    
    BBjString - tag! The tag to add to the entry.
  - removeTag
```
void removeTag(BBjString tag!)
```
    Removes the provided tag from the entry's vector of tags.
    
    Parameters:
    
    BBjString - tag! The tag to remove from the entry's vector of tags.
  - containsTag
```
BBjNumber containsTag(BBjString tag!)
```
    Returns whether the provided tag exists the entry's vector of tags.
    
    Returns:
    
    BBjNumber A BBjNumber acting as a boolean that indicates whether the entry contains the provided tag (1) or not (0).
  - containsAnyTag
```
BBjNumber containsAnyTag(BBjVector tags!)
```
    Returns whether an entry contains any of the provided tags in the entry's vector of tags.
    
    Parameters:
    
    BBjVector - tags! A BBjVector filled with the tags of interest.
    
    Returns:
    
    BBjNumber A BBjNumber acting as a boolean that indicates whether the entry contains any of the supplied tags (1) or not (0).
  - containsAnyTag
```
BBjNumber containsAnyTag(BBjString tags!)
```
    Returns whether an entry contains any of the provided tags in the entry's vector of tags.
    This is similar to the containsAnyTag() method that takes a BBjVector except that it takes a comma-delimted string of tags for succinctness.
    
    Parameters:
    
    BBjString - tags! A comma-delimted string of tags such as "work, programming, meeting".
    
    Returns:
    
    BBjNumber A BBjNumber acting as a boolean that indicates whether the entry contains any of the supplied tags (1) or not (0).
  - containsAllTags
```
BBjNumber containsAllTags(BBjVector tags!)
```
    Returns whether an entry contains all the provided tags in the entry's vector of tags.
    
    Returns:
    
    BBjNumber A BBjNumber acting as a boolean that indicates whether the entry contains all the supplied tags (1) or not (0).
  - containsAllTags
```
BBjNumber containsAllTags(BBjString tags!)
```
    Returns whether a CalendarEntry contains all the provided tags in comma-delimted string in the entry's vector of tags.
    This is similar to the containsAllTags() method that takes a BBjVector except that it takes a comma-delimted string of tags for succinctness.
    
    Parameters:
    
    BBjString - tags! A comma-delimted string of tags such as "work, programming, meeting".
    
    Returns:
    
    BBjNumber A BBjNumber acting as a boolean that indicates whether the entry contains all the supplied tags (1) or not (0).
  - addExtendedProperty
```
void addExtendedProperty(BBjString key!,
BBjString value!)
```
    Adds the provided extended property to the entry's HashMap of extended properties given the property key and value.
    Note that this method simply puts the provide key/value pair in the extended properties HashMap. If an entry in the HashMap already existed with that particular key, then it will be updated with the provided value.
    This method can be used in place of the setExtendedProperties() method as it adds the provided property to the entry's HashMap of extended properties. It may be easier to call this method if you only need to set a few extended properties, as the setExtendedProperties() method requires you to create and populate a HashMap.
    
    Parameters:
    
    BBjString - key! The key of the extended property to add to the entry.
    
    BBjString - value! The value of the extended property to add to the entry.
    
    Since:
    
    BBj 21.12
  - removeExtendedProperty
```
void removeExtendedProperty(BBjString key!)
```
    Removes the extended property from the entry's HashMap of extended properties given the property key.
    
    Parameters:
    
    BBjString - key! The extended property key to remove from the entry's HashMap of extended properties.
    
    Since:
    
    BBj 21.12
  - containsExtendedPropertyKey
```
BBjNumber containsExtendedPropertyKey(BBjString key!)
```
    Returns whether the provided extended property key exists the entry's HashMap of extended properties.
    
    Parameters:
    
    BBjString - key! The key that you're checking to see if it exists in the entry's extended properties.
    
    Returns:
    
    BBjNumber A BBjNumber acting as a boolean that indicates whether the entry contains the provided extended property key (1) or not (0).
    
    Since:
    
    BBj 21.12
  - getExtendedPropertyValue
```
BBjString getExtendedPropertyValue(BBjString key!)
```
    Returns the value of the provided extended property if the key exists in the entry's HashMap of extended properties.
    
    Parameters:
    
    BBjString - key! The extended property key that you wish to get the associated value
    
    Returns:
    
    BBjString The value of the extended property key. If the provided key does not exist in the entry's extended properties, this method will return null().
    
    Since:
    
    BBj 21.12
  - setExtendedProperties
```
void setExtendedProperties(HashMap extendedProperties!)
```
    Sets an entry's extended properties, i.e. custom properties.
    
    Parameters:
    
    HashMap - extendedProperties! A HashMap of custom key/value string pairs that define the entry's custom properties.
  - getExtendedProperties
```
HashMap getExtendedProperties()
```
    Returns an entry's custom key/value string pairs that define the entry's custom properties
    
    Returns:
    
    HashMap The entry's custom key/value string pairs that define the entry's custom properties.
  - setDisplay
```
void setDisplay(BBjString display!)
```
    Sets an entry's alternate rendering style. This overrides the calendar's master EntryDisplay option for this specific entry.
    The display style may be one of the following constants:
    - CalendarAPI.CALENDAR_ENTRY_DISPLAY_AUTO() - (default) When in daygrid, renders the event as a solid rectangle if it is all-day or multi-day. If a timed event, will render it with a dot. When in other views, will render normally.
    - CalendarAPI.CALENDAR_ENTRY_DISPLAY_BLOCK() - When in daygrid, renders the event as a solid rectangle. When in other views, will render normally.
    - CalendarAPI.CALENDAR_ENTRY_DISPLAY_LIST_ITEM() - When in daygrid, renders the event with a dot. When in other views, will render normally.
    - CalendarAPI.CALENDAR_ENTRY_DISPLAY_BACKGROUND() - Highlights the background of the entry's container.
    - CalendarAPI.CALENDAR_ENTRY_DISPLAY_INVERSE_BACKGROUND() - Hightlights the spans of time not occupied by an entry, or the opposite of the background.
    - CalendarAPI.CALENDAR_ENTRY_DISPLAY_NONE() - Won't render the event at all.
    Parameters:
    
    BBjString - display! A constant that denotes the desired entry display style.
  - getDisplay
```
BBjString getDisplay()
```
    Returns an entry's display style.
    
    Returns:
    
    BBjString The entry's display style.
  - setEnableEditable
```
void setEnableEditable(BBjNumber editable!)
```
    Sets an entry's editable status that determines if the user can modify the entry, i.e. change the entry's starting date/time and duration. This overrides the calendar's master EnableEditable option for this specific entry. Note: This determines if the events can be dragged and resized and enables or disables both settings simultaneously. IOW, it's a shorhand way of setting both the EnableStartEditable and EnableDurationEditable properties at the same time. If you don’t want to set both, use the more specific setEnableStartEditable() or setEnableDurationEditable() methods instead.
    rem Example 1: The user can move and resize the entry, i.e. change the starting time/date and the duration myEntry! = CalendarAPI.createCalendarEntry("Write Advantage Article", date(0, "%Yl-%Mz-%Dz") + "T15:00:00") myEntry!.setEnableEditable(1) rem Example 2: The user can move and resize the entry, i.e. change the starting time/date and the duration myEntry! = CalendarAPI.createCalendarEntry("Write Advantage Article", date(0, "%Yl-%Mz-%Dz") + "T15:00:00") myEntry!.setEnableStartEditable(1) myEntry!.setEnableDurationEditable(1) rem Example 3: The user can change the entry's starting time/date but not the duration myEntry! = CalendarAPI.createCalendarEntry("Write Advantage Article", date(0, "%Yl-%Mz-%Dz") + "T15:00:00") myEntry!.setEnableStartEditable(1) rem Example 4: The user can change the entry's duration but not the starting time/date myEntry! = CalendarAPI.createCalendarEntry("Write Advantage Article", date(0, "%Yl-%Mz-%Dz") + "T15:00:00") myEntry!.setEnableDurationEditable(1)
    Parameters:
    
    BBjNumber - editable! A BBjNumber acting as a boolean that indicates whether the entry can be modified by the user, where 1 = editable and 0 = read-only.
  - getEnableEditable
```
BBjNumber getEnableEditable()
```
    Returns the entry's editable status that determines if the entry can be modified by the user.
    
    Returns:
    
    BBjNumber A BBjNumber acting as a boolean that indicates whether the entry's editable status, where 1 = editable and 0 = read-only.
  - setEnableStartEditable
```
void setEnableStartEditable(BBjNumber startEditable!)
```
    Sets an entry's start time editable status that determines if the entry's start time can be modified by the user by dragging (resizing). This overrides the calendar's master EnableStartEditable option for this specific entry.
    Note: See the setEnableEditable() method if you wish to set the setEnableStartEditable() and setEnableDurationEditable() parameters simultaneously. That method also contains sample code that demonstrates different ways to affect an entry's editability.
    
    Parameters:
    
    BBjNumber - startEditable! A BBjNumber acting as a boolean that indicates whether the entry's starting time can be modified by the user, where 1 = editable and 0 = not editable.
  - getEnableStartEditable
```
BBjNumber getEnableStartEditable()
```
    Returns the entry's start time editable status that determines if the entry's start time can be modified by the user by dragging (resizing).
    
    Returns:
    
    BBjNumber A BBjNumber acting as a boolean that indicates whether the entry's starting time can be modified by the user, where 1 = editable and 0 = not editable.
  - setEnableDurationEditable
```
void setEnableDurationEditable(BBjNumber durationEditable!)
```
    Sets an entry's duration editable status that determines if the entry's duration can be modified by the user by dragging (resizing). This overrides the calendar's master EnableDurationEditable option for this specific entry.
    Note: See the setEnableEditable() method if you wish to set the setEnableStartEditable() and setEnableDurationEditable() parameters simultaneously. That method also contains sample code that demonstrates different ways to affect an entry's editability.
    
    Parameters:
    
    BBjNumber - durationEditable! A BBjNumber acting as a boolean that indicates whether the entry's duration can be modified by the user, where 1 = editable and 0 = not editable.
  - getEnableDurationEditable
```
BBjNumber getEnableDurationEditable()
```
    Returns the entry's duration editable status that determines if the entry's duration can be modified by the user by dragging (resizing).
    
    Returns:
    
    BBjNumber A BBjNumber acting as a boolean that indicates whether the entry's duration can be modified by the user, where 1 = editable and 0 = not editable.
  - getAsString
```
BBjString getAsString()
```
    Returns a stringified JsonObject representation of the CalendarEntry object.
    
    Returns:
    
    BBjString The calendar entry in stringified JSON format.
  - getAsFormattedString
```
BBjString getAsFormattedString()
```
    Returns a formatted, i.e. pretty-printed or beautified, stringified JsonObject representation of the CalendarEntry object.
    
    Returns:
    
    BBjString The calendar entry in stringified JSON format.
  - getAsJsonObject
```
JsonObject getAsJsonObject()
```
    Returns a JsonObject representation of the CalendarEntry object.
    
    Returns:
    
    JsonObject The calendar entry as a JsonObject.
    
    See Also:
    
    JsonObject for information about an object in JSON format.

Interface CalendarEntry

Method Summary

Method Detail

CALENDAR_ENTRY_DISPLAY_AUTO

CALENDAR_ENTRY_DISPLAY_BLOCK

CALENDAR_ENTRY_DISPLAY_LIST_ITEM

CALENDAR_ENTRY_DISPLAY_BACKGROUND

CALENDAR_ENTRY_DISPLAY_INVERSE_BACKGROUND

CALENDAR_ENTRY_DISPLAY_NONE

setId

getId

getUuid

setTitle

getTitle

setDescription

getDescription

setLocation

getLocation

setUrl

getUrl

setGroupId

getGroupId

setAllDay

getAllDay

setEnableEntryOverlap

getEnableEntryOverlap

setStart

getStart

setEnd

getEnd

setBackgroundColor

getBackgroundColor

setBorderColor

getBorderColor

setTextColor

getTextColor

setColor

getColor

setColors

setClassName

getClassName

setClassNames

setClassNames

getClassNames

addClassName

removeClassName

setTags

setTags

getTags

addTag

removeTag

containsTag

containsAnyTag

containsAnyTag

containsAllTags

containsAllTags

addExtendedProperty

removeExtendedProperty

containsExtendedPropertyKey

getExtendedPropertyValue

setExtendedProperties

getExtendedProperties

setDisplay

getDisplay

setEnableEditable

getEnableEditable

setEnableStartEditable

getEnableStartEditable

setEnableDurationEditable

getEnableDurationEditable

getAsString

getAsFormattedString

getAsJsonObject