RenderMetadata

Arbitrary metadata for a render node.

struct RenderMetadata

Topics

Structures

Instance Properties

var category: String?
The name of technology associated with a tutorial.
var categoryPathComponent: String?
var color: TopicColor?
Custom authored color that represents this page.
var conformance: ConformanceSection?
Information the availability of generic APIs.
var customMetadata: [String : String]
Author provided custom metadata describing the page.
var estimatedTime: String?
A description of the estimated time to complete the tutorials of a technology.
var extendedModule: String?
The name of the module extension in which the symbol is defined, if applicable.
var extendedModuleVariants: VariantCollection<String?>
The variants for the module extension.
var externalID: String?
An identifier for a symbol generated externally.
var externalIDVariants: VariantCollection<String?>
The variants of the external ID.
var extraMetadata: [RenderMetadata.CodingKeys : Any]
Additional metadata associated with the render node.
var fragments: [DeclarationRenderSection.Token]?
Abbreviated declaration to display in links.
var fragmentsVariants: VariantCollection<[DeclarationRenderSection.Token]?>
The variants for the fragments of a page.
var hasNoExpandedDocumentation: Bool
Whether there isn’t a version of the page with more content that a renderer can link to.
var images: [TopicImage]
Custom authored images that represent this page.
var modules: [RenderMetadata.Module]?
The modules that the symbol is apart of.
var modulesVariants: VariantCollection<[RenderMetadata.Module]?>
The variants for the modules.
var navigatorTitle: [DeclarationRenderSection.Token]?
Abbreviated declaration to display in navigators.
var navigatorTitleVariants: VariantCollection<[DeclarationRenderSection.Token]?>
The variants for the navigator title of a page.
var platforms: [AvailabilityRenderItem]?
The platform availability information about a symbol.
var platformsVariants: VariantCollection<[AvailabilityRenderItem]?>
The variants for the platforms.
var remoteSource: RenderMetadata.RemoteSource?
The remote location where the source declaration of the topic can be viewed.
var remoteSourceVariants: VariantCollection<RenderMetadata.RemoteSource?>
The variants for the topic’s remote source.
var required: Bool
Whether protocol method is required to be implemented by conforming types.
var requiredVariants: VariantCollection<Bool>
The variants for the required property.
var role: String?
The role of the document.
var roleHeading: String?
A heading describing the type of the document.
var roleHeadingVariants: VariantCollection<String?>
The variants of the role heading.
var sourceFileURI: String?
The URI of the source file in which the symbol was originally declared, suitable for display in a user interface.
var sourceFileURIVariants: VariantCollection<String?>
The variants for the source file URI of a page.
var symbolAccessLevel: String?
The access level of a symbol, e.g., “public” or “private”.
var symbolAccessLevelVariants: VariantCollection<String?>
The variants for the access level of a symbol.
var symbolKind: String?
The kind of a symbol, e.g., “class” or “func”.
var symbolKindVariants: VariantCollection<String?>
The variants of the symbol kind.
var tags: [RenderNode.Tag]?
Any tags assigned to the node.
var title: String?
The title of the page.
var titleVariants: VariantCollection<String?>
The variants of the title.

Enumerations

enum Role
A list of pre-defined roles to assign to nodes.