SolapiProvider
Defined in: packages/provider/src/solapi/provider.ts:27
SOLAPI Provider package entrypoint
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SolapiProvider(
config,client?):SolapiProvider
Defined in: packages/provider/src/solapi/provider.ts:62
Parameters
Section titled “Parameters”config
Section titled “config”client?
Section titled “client?”SolapiSdkClient
Returns
Section titled “Returns”SolapiProvider
Properties
Section titled “Properties”
readonlyid:"solapi"="solapi"
Defined in: packages/provider/src/solapi/provider.ts:28
Unique identifier for this provider instance. Used for routing and logging.
Example
Section titled “Example”"solapi"Implementation of
Section titled “Implementation of”
readonlyname:"SOLAPI Messaging Provider"="SOLAPI Messaging Provider"
Defined in: packages/provider/src/solapi/provider.ts:29
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/solapi/provider.ts:30
Message types this provider supports. Messages of unsupported types will be rejected.
Implementation of
Section titled “Implementation of”Methods
Section titled “Methods”getBalance()
Section titled “getBalance()”getBalance(
query?):Promise<Result<BalanceResult,KMsgError>>
Defined in: packages/provider/src/solapi/provider.ts:145
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):Promise<Result<DeliveryStatusResult|null,KMsgError>>
Defined in: packages/provider/src/solapi/provider.ts:135
Query delivery status for a previously sent message. Optional capability - not all providers support this.
Parameters
Section titled “Parameters”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/solapi/provider.ts:50
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/solapi/provider.ts:89
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):Promise<Result<SendResult,KMsgError>>
Defined in: packages/provider/src/solapi/provider.ts:119
Send a message through this provider.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<Result<SendResult, KMsgError>>
Result with SendResult on success, KMsgError on failure.