Methods

async, static fetch(domain, user, pass) → {Array.<object>}

plugin/freshdesk.js, line 28

Fetches all the solution articles and forum posts from the designated source.

Parameters:

Name	Type	Description
domain	string	the domain of the API to make the request to
user	string	the username for the API
pass	string	the password for the API

Returns:

Array.<object> -

a list of processed solution articles, forum topics, and forum comments

static isSupported() → {Boolean}

plugin/freshdesk.js, line 132

Checks to see if certain functions are defined.

Returns:

Boolean

static plugin() → {void}

plugin/freshdesk.js, line 14

The lunr.js builder plugin. Meant to be used like builder.use(plugin)

Returns:

void

static process(doc, sourcenullable) → {object}

plugin/freshdesk.js, line 112

Modify the documents so that they can be indexed correctly.

Parameters:

Name	Type	Attributes	Description
doc	object		the document to be processed
source	string	<nullable>	the source of the document

Returns:

object -

the processed document