SolapiProvider
Defined in: packages/provider/src/solapi/provider.ts:27
SOLAPI Provider package entrypoint
Implements
섹션 제목: “Implements”Constructors
섹션 제목: “Constructors”Constructor
섹션 제목: “Constructor”new SolapiProvider(
config,client?):SolapiProvider
Defined in: packages/provider/src/solapi/provider.ts:62
Parameters
섹션 제목: “Parameters”config
섹션 제목: “config”client?
섹션 제목: “client?”SolapiSdkClient
Returns
섹션 제목: “Returns”SolapiProvider
Properties
섹션 제목: “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
섹션 제목: “Example”"solapi"Implementation of
섹션 제목: “Implementation of”name
섹션 제목: “name”
readonlyname:"SOLAPI Messaging Provider"="SOLAPI Messaging Provider"
Defined in: packages/provider/src/solapi/provider.ts:29
Human-readable name for display purposes.
Example
섹션 제목: “Example”"SOLAPI"Implementation of
섹션 제목: “Implementation of”supportedTypes
섹션 제목: “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
섹션 제목: “Implementation of”Methods
섹션 제목: “Methods”getBalance()
섹션 제목: “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
섹션 제목: “Parameters”query?
섹션 제목: “query?”Returns
섹션 제목: “Returns”Promise<Result<BalanceResult, KMsgError>>
Implementation of
섹션 제목: “Implementation of”getDeliveryStatus()
섹션 제목: “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
섹션 제목: “Parameters”query
섹션 제목: “query”Returns
섹션 제목: “Returns”Promise<Result<DeliveryStatusResult | null, KMsgError>>
Implementation of
섹션 제목: “Implementation of”getOnboardingSpec()
섹션 제목: “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
섹션 제목: “Returns”Implementation of
섹션 제목: “Implementation of”healthCheck()
섹션 제목: “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
섹션 제목: “Returns”Promise<ProviderHealthStatus>
Implementation of
섹션 제목: “Implementation of”send()
섹션 제목: “send()”send(
options):Promise<Result<SendResult,KMsgError>>
Defined in: packages/provider/src/solapi/provider.ts:119
Send a message through this provider.
Parameters
섹션 제목: “Parameters”options
섹션 제목: “options”Returns
섹션 제목: “Returns”Promise<Result<SendResult, KMsgError>>
Result with SendResult on success, KMsgError on failure.