Skip to content

API reference

The API reference is generated by Dokka from the sources of the published modules at the same commit as this site.

Open the API reference

It covers exactly the published modules (see releasing); storage:testing, samples and build logic are not included. The same documentation ships in every artifact's -javadoc.jar.

Reading it

  • Declarations annotated @InternalKSecureMessageApi are public only so that KSecureMessage's own modules can use them (codecs, sealed-record helpers, rotation machinery). They carry no compatibility promise and applications do not need them. Dokka shows the annotation on the declaration.
  • The SQLDelight-generated …sqldelight.db packages are public only because SQLDelight cannot generate internal code; they are not API.
  • The public API is tracked by the checked-in ABI baseline (./gradlew checkKotlinAbi); 0.x minor versions may still change it.