Skip to content
Skip to main content

calendarSyncStore

calendarSyncStore

Section titled “calendarSyncStore”

The interface for the CalendarSync component state store. calendarSyncStore manages all form data and UI state information for the component.

import { calendarSyncStore, CalendarSync } from "@nylas/react";


export default function App() {
  const store = calendarSyncStore();
  useEffect(() => {
    store.setName("ExampleName");
  }, []);


  return (
    <div>
      <CalendarSync />
    </div>
  );
}

calendarSyncStore properties

Section titled “calendarSyncStore properties”

advancedSettings

Section titled “advancedSettings”
DescriptionDisplay the Advanced Settings section.
Typeboolean
Defaultfalse

calendar

Section titled “calendar”
DescriptionThe synced calendar.
Typenull | Calendar

getCalendar

Section titled “getCalendar”
DescriptionFetches calendar data from the Nylas Calendar API.
Type(calendarId: string, grantId: string, fallbackNotetakerName?: string) => Promise<void>

handleCancel

Section titled “handleCancel”
DescriptionCancels changes and resets to original values.
Type(notetakerName?: string, onCancelCallback?: () => ...) => void

handleDisable

Section titled “handleDisable”
DescriptionDisables Notetaker for the synced calendar.
Type(calendarId: string, grantId: string, fallbackNotetakerName?: string,
onUpdate?: (data: ...) => ..., onError?: (error: ...) => ...,
onCancel?: () => ...) => Promise<void>

handleSave

Section titled “handleSave”
DescriptionSaves Notetaker settings for the synced calendar.
Type(calendarId: string, grantId: string, onUpdate?: (data: ...) => ...,
onError?: (error: ...) => ...) => Promise<void>

hasChanges

Section titled “hasChanges”
DescriptionIndicates that the user made changes.
Typeboolean
Defaultfalse

isLoading

Section titled “isLoading”
DescriptionIndicates that the component is loading.
Typeboolean
Defaultfalse

name

Section titled “name”
DescriptionThe name for the calendar sync.
Typestring

reset

Section titled “reset”
DescriptionResets the store and all form fields to their default values.
Type() => void

selectedFilters

Section titled “selectedFilters”
DescriptionA list of selected meeting filters.
TypeMeetingFilter[]

selectedRecordingTypes

Section titled “selectedRecordingTypes”
DescriptionA list of selected recording types (video, audio, or transcript).
TypeRecordingType[]

setAdvancedSettings

Section titled “setAdvancedSettings”
DescriptionSets the visibility of the Advanced Settings section.
Type(show: boolean) => void

setCalendar

Section titled “setCalendar”
DescriptionSets the calendar.
Type(calendar: null | Calendar) => void

setHasChanges

Section titled “setHasChanges”
DescriptionSets whether the user made changes.
Type(hasChanges: boolean) => void

setIsLoading

Section titled “setIsLoading”
DescriptionSets the loading state.
Type(isLoading: boolean) => void

setName

Section titled “setName”
DescriptionSets the name for the calendar sync.
Type(name: string) => void

setSelectedFilters

Section titled “setSelectedFilters”
DescriptionSets the selected meeting filters.
Type(filters: MeetingFilter[]) => void

setSelectedRecordingTypes

Section titled “setSelectedRecordingTypes”
DescriptionSets the selected recording types.
Type(types: RecordingType[]) => void

toggleMeetingFilter

Section titled “toggleMeetingFilter”
DescriptionToggles the specified meeting filter on or off.
Type(filter: MeetingFilter) => void

toggleRecordingType

Section titled “toggleRecordingType”
DescriptionToggles the specified recording type on or off.
Type(type: RecordingType) => void