Integrate JumpSeat directly in an application by leveraging the JumpSeat JavaScript API. Easily start a guide with a function call or get information from JumpSeat about the user, pathways, and guides.

Using the API

With JumpSeat loaded, the JumpSeat object is available

Methods

JumpSeat.app();

Returns the connected application’s ID for informational purposes.

 

JumpSeat.guide.getAll(force);

Returns a promise, with a payload of all guides available in an application. Guides resolved in the promise object are pulled from application local storage. Use force to clear the cache and query the server. A forced request’s results will update the cache.

 

JumpSeat.guide.current();

Returns the currently running guide ID.

 

JumpSeat.guide.currentStep();

Returns the index of the current guide’s step.

 

JumpSeat.guide.fromPathway(pathwayid);

Retuns a promise, with a payload of all guides in the given pathway.

 

JumpSeat.guide.start(id);

Starts a guide with the given ID. This will end a current guide in progress.

 

JumpSeat.isAdmin();

Returns boolean of the currently logged in user’s admin status. The admin status determines if the user can author guides.

 

JumpSeat.locale();

Returns the current user’s locale. Individual user’s locales can be overridden by an admin on the user administration page.

 

JumpSeat.pathway.current();

Returns current pathway ID.

 

JumpSeat.pathway.getAll()

Returns a promise, with a payload of available pathways.

 

JumpSeat.user();

Returns the current user’s Email/ID. This function is useful to troubleshoot user mapping configuration.