IWINVSendProvider
Defined in: packages/provider/src/iwinv/provider.send.ts:68
IWINV send/status/balance focused entrypoint.
Extended by
Section titled “Extended by”Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new IWINVSendProvider(
config):IWINVSendProvider
Defined in: packages/provider/src/iwinv/provider.send.ts:91
Parameters
Section titled “Parameters”config
Section titled “config”Returns
Section titled “Returns”IWINVSendProvider
Properties
Section titled “Properties”
readonlyid:"iwinv"="iwinv"
Defined in: packages/provider/src/iwinv/provider.send.ts:69
Unique identifier for this provider instance. Used for routing and logging.
Example
Section titled “Example”"solapi"Implementation of
Section titled “Implementation of”
readonlyname:"IWINV Messaging Provider"="IWINV Messaging Provider"
Defined in: packages/provider/src/iwinv/provider.send.ts:70
Human-readable name for display purposes.
Example
Section titled “Example”"SOLAPI"Implementation of
Section titled “Implementation of”supportedTypes
Section titled “supportedTypes”
readonlysupportedTypes: readonlyMessageType[]
Defined in: packages/provider/src/iwinv/provider.send.ts:71
Message types this provider supports. Messages of unsupported types will be rejected.
Implementation of
Section titled “Implementation of”transportCapabilities
Section titled “transportCapabilities”
readonlytransportCapabilities:object
Defined in: packages/provider/src/iwinv/provider.send.ts:72
Per-operation transport features supported by this provider. Missing declarations must be treated as unsupported.
abortSignal
Section titled “abortSignal”
readonlyabortSignal:"supported"="supported"
injectableFetch
Section titled “injectableFetch”
readonlyinjectableFetch:"supported"="supported"
Implementation of
Section titled “Implementation of”Provider.transportCapabilities
Methods
Section titled “Methods”getBalance()
Section titled “getBalance()”getBalance(
query?):Promise<Result<BalanceResult,KMsgError>>
Defined in: packages/provider/src/iwinv/provider.send.ts:221
Query the remaining balance/points for the provider account.
Parameters
Section titled “Parameters”query?
Section titled “query?”Returns
Section titled “Returns”Promise<Result<BalanceResult, KMsgError>>
Implementation of
Section titled “Implementation of”getDeliveryStatus()
Section titled “getDeliveryStatus()”getDeliveryStatus(
query,context?):Promise<Result<DeliveryStatusResult|null,KMsgError>>
Defined in: packages/provider/src/iwinv/provider.send.ts:189
Query delivery status for a previously sent message. Optional capability - not all providers support this.
Parameters
Section titled “Parameters”context?
Section titled “context?”Returns
Section titled “Returns”Promise<Result<DeliveryStatusResult | null, KMsgError>>
Implementation of
Section titled “Implementation of”getOnboardingSpec()
Section titled “getOnboardingSpec()”getOnboardingSpec():
ProviderOnboardingSpec
Defined in: packages/provider/src/iwinv/provider.send.ts:79
Get the onboarding specification for this provider. Used by tooling to guide provider configuration.
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”healthCheck()
Section titled “healthCheck()”healthCheck():
Promise<ProviderHealthStatus>
Defined in: packages/provider/src/iwinv/provider.send.ts:116
Check if the provider is operational. Used for health monitoring and circuit breaker decisions.
Returns
Section titled “Returns”Promise<ProviderHealthStatus>
Implementation of
Section titled “Implementation of”send()
Section titled “send()”send(
options,context?):Promise<Result<SendResult,KMsgError>>
Defined in: packages/provider/src/iwinv/provider.send.ts:151
Send a message through this provider.
Parameters
Section titled “Parameters”options
Section titled “options”context?
Section titled “context?”Returns
Section titled “Returns”Promise<Result<SendResult, KMsgError>>
Result with SendResult on success, KMsgError on failure.