pyrx_synapse_platform_interface library

Platform-interface contract for the PYRX Synapse Flutter SDK.

This library exposes:

  • PyrxSynapsePlatform — the abstract base class that platform implementations (pyrx_synapse_ios, pyrx_synapse_android) extend.
  • MethodChannelPyrxSynapse — the default implementation that routes calls through the Pigeon-generated PyrxSynapseHostApi proxy and receives events through the Pigeon-generated PyrxSynapseEventApi stream channel.
  • The Pigeon-generated DTO types (PyrxInitArgs, PyrxIdentityResult, PyrxDebugInfo, PyrxPushPermissionResult, PyrxEventEnvelope, PushReceivedEventDto, PushClickedEventDto, IdentitySnapshotDto, QueueDrainedEventDto, IdentityChangedEventDto, PyrxEventKind, and Phase 10 PR-2b in-app DTOs: InAppMessageDto, InAppCtaDto, InAppShowTokenDto, InAppMessageReceivedEventDto, InAppMessageDismissedEventDto).

Customers do not import this package directly — they import package:pyrx_synapse/pyrx_synapse.dart, which re-exports everything you need and (in PR-2) layers a Dart-idiomatic Synapse namespace on top.

Classes

IdentityChangedEventDto
IdentitySnapshotDto
InAppCtaDto
One call-to-action button on an InAppMessageDto. NLT source has already been resolved against the current contact at fetch time — label and actionPayload are ready to render verbatim.
InAppMessageDismissedEventDto
InAppMessageDto
One in-app message delivered to a registered render callback.
InAppMessageReceivedEventDto
InAppShowTokenDto
Result of PyrxSynapseHostApi.inAppShow. Mirrors the iOS Synapse.ShowToken and Android ShowToken — both opaque handles that unregister the callback when closed.
MethodChannelPyrxSynapse
PushClickedEventDto
PushReceivedEventDto
PyrxDebugInfo
Snapshot returned by PyrxSynapseHostApi.debugInfo.
PyrxEventEnvelope
Single wire envelope for the 7-event observer surface. Exactly one of the *Payload fields is non-null per envelope, matching kind.
PyrxIdentityResult
Result of PyrxSynapseHostApi.identify and PyrxSynapseHostApi.alias.
PyrxInitArgs
Arguments for PyrxSynapseHostApi.initialize.
PyrxPushPermissionResult
Result of PyrxSynapseHostApi.requestPushPermission.
PyrxSynapsePlatform
Abstract platform interface for PYRX Synapse.
QueueDrainedEventDto

Enums

PyrxEventKind
Discriminator for PyrxEventEnvelope. Mirrors the case-set of the native sealed types byte-for-byte.