API Docs for: 1.0.0
Show:

GSPCalendar.Client Class

Constructor

GSPCalendar.Client

()

Methods

getTitle

() String

Returns:

String:

The title to display

isTrue

(
  • the
)
Boolean private

Due to the variety of ways that ServiceNow indicates "True" or "False" inside the system, this function interprets the variety of truthy values and assess if the passed value is one of them and returns false otherwise as the value is not "truthy".

Parameters:

Returns:

Boolean:

The leveled boolean value indicating if the passed value should be considered true of false.

mapEvent

(
  • source
)
Object

Map an event from the CalendarUtil to a FullCalendar event object.

See the FullCalendar event documentation for details on what the event object can contain; https://fullcalendar.io/docs/event-object

Additional information on rendering the event can be found at https://fullcalendar.io/docs/event-display but can vary in relation to where the options are specified.

Parameters:

Returns:

Properties

calendarConfiguration

Object

Defines the configuration for FullCalendar to use.

This is currently set to display the Month view and make the Calendar display not editable since the controls for Events are inside ServiceNow.

See FullCalendar's documentation for further details at https://fullcalendar.io/docs .

Additionally, the Event Display documentation for FullCalendar described at https://fullcalendar.io/docs/event-display can be useful for managing Event rendering and some may need to be specified as part of the Calendar's configuration.

data

Object
Contains the values of the data object that was assembled on by the Widget's Server-Side counter part.

events

Array

Holds the event data for the calendar that was loaded after being processed by mapEvent so that FullCalendar can display the events accordingly.

eventSources

Array

FullCalendar supports receiving an array of arrays to describe the events present on the Calendar so that multiple sources can easily be read and loaded.

As we only have one source, this isn't particularly necessary, but a future state may involve something akin to pulling in the calendar for the current user as well, in which case this could be useful.

options

Object
Contains the values of the options object that was assembled on by the Widget's Server-Side counter part.