PixaPluginIntegrationCandidate class final

Candidate integration path exposed by a pub plugin package.

Constructors

PixaPluginIntegrationCandidate.external({required String id, required PixaPluginIntegrationRegistrar register, String? packageName, bool available = true, bool requiredIntegration = false, int priority = externalPriority, String? unavailableMessage})
Creates an external or standalone FFI candidate.
const
PixaPluginIntegrationCandidate.platformChannel({required String id, required bool platformAvailable, required PixaPluginIntegrationRegistrar register, String? packageName, bool requiredIntegration = false, int priority = platformChannelPriority, String? unavailableMessage})
Creates a platform-channel candidate.
const
PixaPluginIntegrationCandidate.pureDart({required String id, required PixaPluginIntegrationRegistrar register, String? packageName, bool available = true, bool requiredIntegration = false, int priority = pureDartPriority, String? unavailableMessage})
Creates a pure Dart candidate.
const
PixaPluginIntegrationCandidate.runtimeHost({required String id, required bool hostRuntimeAvailable, required PixaPluginIntegrationRegistrar register, String? packageName, bool requiredIntegration = false, int priority = runtimeHostPriority, String? unavailableMessage})
Creates a host-runtime candidate.
const

Properties

available → bool
Whether this candidate is usable for the current app configuration.
final
hashCode → int
The hash code for this object.
no setterinherited
id → String
Stable candidate id inside the plugin package.
final
mode → PixaPluginIntegrationMode
Candidate execution boundary.
final
packageName → String?
Pub package that provides this candidate, used for diagnostics.
final
priority → int
Higher priority wins among available candidates.
final
register → PixaPluginIntegrationRegistrar
Registers descriptors for this candidate only.
final
requiredIntegration → bool
Whether this candidate must be available instead of falling back.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
unavailableMessage → String?
Safe message explaining why an unavailable candidate cannot be used.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

externalPriority → const int
External candidates are the last default fallback.
platformChannelPriority → const int
Platform-channel candidates outrank Dart/external by default.
pureDartPriority → const int
Pure Dart candidates outrank external by default.
runtimeHostPriority → const int
Runtime host candidates outrank platform/Dart/external by default.