SearchFacet

Kind: global class

• SearchFacet
  • .all(query, [opts], [optCb])
  • .files(query, [opts], [optCb])
  • .messages(query, [opts], [optCb])

searchFacet.all(query, [opts], [optCb])

Searches for messages and files matching a query.

Kind: instance method of [SearchFacet](#SearchFacet)
See: search.all

Param	Type	Description
query	?	Search query. May contains booleans, etc.
[opts]	Object
opts.sort	?	Return matches sorted by either score or timestamp.
opts.sort_dir	?	Change sort direction to ascending (asc) or descending (desc).
opts.highlight	?	Pass a value of 1 to enable query highlight markers (see below).
[optCb]	function	Optional callback, if not using promises.

searchFacet.files(query, [opts], [optCb])

Searches for files matching a query.

Kind: instance method of [SearchFacet](#SearchFacet)
See: search.files

Param	Type	Description
query	?	Search query. May contain booleans, etc.
[opts]	Object
opts.sort	?	Return matches sorted by either score or timestamp.
opts.sort_dir	?	Change sort direction to ascending (asc) or descending (desc).
opts.highlight	?	Pass a value of 1 to enable query highlight markers (see below).
[optCb]	function	Optional callback, if not using promises.

searchFacet.messages(query, [opts], [optCb])

Searches for messages matching a query.

Kind: instance method of [SearchFacet](#SearchFacet)
See: search.messages

Param	Type	Description
query	?	Search query. May contains booleans, etc.
[opts]	Object
opts.sort	?	Return matches sorted by either score or timestamp.
opts.sort_dir	?	Change sort direction to ascending (asc) or descending (desc).
opts.highlight	?	Pass a value of 1 to enable query highlight markers (see below).
[optCb]	function	Optional callback, if not using promises.