Class HelpContentV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.v1.responses.components.HelpContentV1

All Implemented Interfaces:

ToSchema

public class HelpContentV1
extends Object
implements ToSchema

Public help contract. Targeting and data provenance are never serialized.

Constructor Summary

Constructors

Constructor	Description
HelpContentV1()	Constructor for schema generation.
HelpContentV1(QHelpContent wrapped)	Wrap visible help.

Method Summary

Modifier and Type	Method	Description
String	getContent()	Getter for content
String	getContentAsHtml()	Getter for contentAsHtml
HelpFormat	getFormat()	Getter for format
List<String>	getRoles()	Getter for roles
String	getSummary()	Getter for summary
static List<HelpContentV1>	of(List<QHelpContent> contents)	Wrap a list, applying targeting also for endpoints wrapping full metadata.
static Map<String,List<HelpContentV1>>	of(Map<String,List<QHelpContent>> contents)	Wrap a slot map while preserving property names and null shapes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.kingsrook.qqq.middleware.javalin.schemabuilder.ToSchema

toSchema

Constructor Details

HelpContentV1

public HelpContentV1()

Constructor for schema generation.

HelpContentV1

public HelpContentV1(QHelpContent wrapped)

Wrap visible help.

Method Details

getContent

public String getContent()

Getter for content

getContentAsHtml

public String getContentAsHtml()

Getter for contentAsHtml

getSummary

public String getSummary()

Getter for summary

getFormat

public HelpFormat getFormat()

Getter for format

getRoles

public List<String> getRoles()

Getter for roles

of

public static List<HelpContentV1> of(List<QHelpContent> contents)

Wrap a list, applying targeting also for endpoints wrapping full metadata.

of

public static Map<String,List<HelpContentV1>> of(Map<String,List<QHelpContent>> contents)

Wrap a slot map while preserving property names and null shapes.