mini_program_contracts library
Classes
- ActionNames
- Stable wire names for host-dispatched mobile MVP actions.
- CallSecureApiActionPayload
- Payload for a host-controlled secure API operation.
- FeatureFlagKeys
- Utility helpers for feature flag key contract values.
- HostActionRequest
- Standard request envelope sent from the SDK to a host bridge action handler.
- HostActionResult
- Standard result envelope returned by the host bridge after handling an action.
- MiniProgramCachePolicy
- Cache rules declared by a mini-program manifest.
- MiniProgramCacheRule
- Cache rules declared by a mini-program manifest for one payload class.
- MiniProgramCacheRuleConverter
- Backward-compatible cache-rule converter for manifest cache policy fields.
- MiniProgramErrorCodes
- Stable error code constants shared across contracts, SDK, and hosts.
- MiniProgramFallback
- Minimal fallback metadata declared by a mini-program manifest.
- MiniProgramManifest
- Canonical manifest contract delivered to hosts and the shared SDK.
- OpenMiniProgramScreenActionPayload
- OpenNativeScreenActionPayload
- Payload for a host-controlled native navigation request.
- PopMiniProgramScreenActionPayload
- PopToMiniProgramRootActionPayload
- PopToMiniProgramScreenActionPayload
- ReplaceMiniProgramScreenActionPayload
- ResetMiniProgramStackActionPayload
- SdkVersionRange
- Semver range expression describing which SDK versions a manifest supports.
- SdkVersionRangeConverter
- Converts between a manifest wire string and SdkVersionRange.
- TrackEventActionPayload
- Payload for a host-controlled analytics event dispatch.
Enums
- Capability
- Host capabilities that a mini-program can require before rendering.
- HostActionStatus
- Terminal outcome states for a host-dispatched action.
- MiniProgramCacheMode
- Contract-level cache behavior for a manifest or screen payload.
- MiniProgramFallbackStrategy
- Supported fallback behaviors when a mini-program cannot continue normally.
Extensions
- CallSecureApiActionPayloadPatterns on CallSecureApiActionPayload
- Adds pattern-matching-related methods to CallSecureApiActionPayload.
- CapabilityX on Capability
- HostActionRequestPatterns on HostActionRequest
- Adds pattern-matching-related methods to HostActionRequest.
- HostActionResultPatterns on HostActionResult
- Adds pattern-matching-related methods to HostActionResult.
- HostActionResultX on HostActionResult
- MiniProgramCachePolicyPatterns on MiniProgramCachePolicy
- Adds pattern-matching-related methods to MiniProgramCachePolicy.
- MiniProgramCacheRulePatterns on MiniProgramCacheRule
- Adds pattern-matching-related methods to MiniProgramCacheRule.
- MiniProgramCacheRuleX on MiniProgramCacheRule
- MiniProgramFallbackPatterns on MiniProgramFallback
- Adds pattern-matching-related methods to MiniProgramFallback.
- MiniProgramManifestPatterns on MiniProgramManifest
- Adds pattern-matching-related methods to MiniProgramManifest.
- MiniProgramManifestX on MiniProgramManifest
- OpenNativeScreenActionPayloadPatterns on OpenNativeScreenActionPayload
- Adds pattern-matching-related methods to OpenNativeScreenActionPayload.
- SdkVersionRangePatterns on SdkVersionRange
- Adds pattern-matching-related methods to SdkVersionRange.
- SdkVersionRangeX on SdkVersionRange
- TrackEventActionPayloadPatterns on TrackEventActionPayload
- Adds pattern-matching-related methods to TrackEventActionPayload.