SolapiProvider
Defined in: packages/provider/src/solapi/provider.ts:26
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:57
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:27
Implementation of
Section titled “Implementation of”
readonlyname:"SOLAPI Messaging Provider"="SOLAPI Messaging Provider"
Defined in: packages/provider/src/solapi/provider.ts:28
Implementation of
Section titled “Implementation of”supportedTypes
Section titled “supportedTypes”
readonlysupportedTypes: readonlyMessageType[]
Defined in: packages/provider/src/solapi/provider.ts:29
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:136
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:126
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:49
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:80
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:110
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<Result<SendResult, KMsgError>>