SwiftDocC
IndexingRecord

Structure

IndexingRecord

A structure containing indexing information for a RenderNode.

struct IndexingRecord

Topics

Structures

struct Kind
The kind of documentation for a search result.

Instance Properties

let headings: [String]
Headings and subheadings in the document or section.
let kind: IndexingRecord.Kind
The kind of document or section whose text content this record collects.
let location: IndexingRecord.Location
The location of a search result for this record.
let platforms: [IndexingRecord.PlatformAvailability]?
Information about the platforms for which the summarized element is available.
let rawIndexableTextContent: String
A concatenation of all other raw text content in the document or section.
let summary: String
A summary phrase, sentence, or abstract from a document or section for use in previewing content in search results.
let title: String
The title of the document or section.

Type Aliases

typealias PlatformAvailability
The availability information for a platform.

Enumerations

enum Location
The location of the content for this record.