DoctorCheck

class DoctorCheck(val name: String, val status: DoctorStatus, val message: String, val fixHint: String?, val id: String?)

One diagnosed item of a DoctorReport.

Instances are created by PassKi; the constructor is internal API so fields can be added without breaking binaries.

Constructors

Link copied to clipboard
constructor(name: String, status: DoctorStatus, message: String, fixHint: String?, id: String?)
constructor(name: String, status: DoctorStatus, message: String, fixHint: String?)

Properties

Link copied to clipboard

How to fix a DoctorStatus.Fail or DoctorStatus.Warn; may span several lines. Null when there's nothing to do.

Link copied to clipboard
val id: String?

Stable ID from PassKi's setup check catalog (e.g. AND-01, IOS-02), shared with the Gradle plugin's passkiCheck and the setup docs (docs/checks/<id>.md). Null for checks without a catalog entry.

Link copied to clipboard

What was found, in one human-readable sentence.

Link copied to clipboard

Short name of what was checked, e.g. assetlinks.json.

Link copied to clipboard

Outcome of the check.

Functions

Link copied to clipboard
open override fun toString(): String

One line: status marker, id (when set), name and message. fixHint is left out; see DoctorReport.toString.