API Methods

Available methods for interacting with the Jarvis Analytics Scheduler.

Constructor

new JarvisAnalyticsScheduler(settings)

Creates a new instance of the Jarvis Analytics Scheduler.

const jarvis = new JarvisAnalyticsScheduler({
  token: "YOUR_TOKEN",
  locationId: "YOUR_LOCATION_ID",
  companyId: "YOUR_COMPANY_ID"
});

Methods

toggle(locationId)

Opens the scheduler widget for a specific location.

jarvis.toggle("location_123");

Parameters:

• locationId (string) - The ID of the location to open the scheduler for

Example:

// Open scheduler for specific location
jarvis.toggle("location_456");

Event Methods

onload(callback)

Register a callback for when the scheduler loads.

jarvis.onload(() => {
  console.log("Scheduler loaded");
});

onNextStep(callback)

Register a callback for step changes and booking events.

jarvis.onNextStep((event) => {
  console.log("Step changed:", event);
});

onTimesNearby(callback)

Register a callback for location changes.

jarvis.onTimesNearby((event) => {
  console.log("Location changed:", event);
});

onBookError(callback)

Register a callback for booking errors.

jarvis.onBookError((event) => {
  console.error("Booking error:", event);
});

onBookSuccess(callback)

Register a callback for successful bookings.

jarvis.onBookSuccess((event) => {
  console.log("Booking successful:", event);
});

onOcrScan(callback)

Register a callback for OCR scanning events.

jarvis.onOcrScan((event) => {
  console.log("OCR scan completed:", event);
});

onSubmitted(callback)

Register a callback for form submission events.

jarvis.onSubmitted((event) => {
  console.log("Form submitted:", event);
});

Complete Example

const jarvis = new JarvisAnalyticsScheduler({
  token: "YOUR_TOKEN",
  locationId: "YOUR_LOCATION_ID",
  companyId: "YOUR_COMPANY_ID",
  title: "Book an Appointment",
  iframeMode: false,
  showLogo: 1,
  showPhoneNumber: true,
  showAddress: false
});

// Event handlers
jarvis.onload(() => {
  console.log("Scheduler loaded");
});

jarvis.onNextStep((event) => {
  console.log("Step changed:", event);
});

jarvis.onBookSuccess((event) => {
  console.log("Booking successful:", event);
});

// Open scheduler
jarvis.toggle("location_123");