Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WikiResult

Defines the wiki result that matched a wiki search request.

Hierarchy

  • WikiResult

Index

Properties

Optional collection

collection: Collection

Collection of the result file.

Optional contentId

contentId: string

ContentId of the result file.

Optional fileName

fileName: string

Name of the result file.

Optional hits

hits: Array<WikiHit>

Highlighted snippets of fields that match the search request. The list is sorted by relevance of the snippets.

Optional path

path: string

Path at which result file is present.

Optional project

Project details of the wiki document.

Optional wiki

wiki: Wiki

Wiki information for the result.

Generated using TypeDoc