API Reference
This section provides a comprehensive, automatically generated reference for all public methods, interfaces, and types exposed by the Blocklet SDK. It serves as a detailed guide for developers to understand the SDK's capabilities, including core services, utility functions, and data structures.
Classes#
Explore detailed documentation for the core classes provided by the Blocklet SDK. This includes classes for authentication (AuthService), managing notifications (Notification), handling DID Connect flows (BlockletAuthenticator, WalletAuthenticator), and interacting with Blocklet Server configurations (Config), as well as other foundational components (Component, Security).
Functions#
Discover global and utility functions that simplify common development tasks. This section covers functions for wallet management (getWallet, encrypt, decrypt, signResponse, verifyResponse), user information retrieval (getUserInfo), authentication utilities (getLoginProvider, encodeKycStatus, decodeKycStatus), communication methods (sendToUser, sendToMail, sendToRelay, broadcast), event bus interactions (subscribe, unsubscribe, publish), and component interactions (call, getUrl, getRelativeUrl, getComponentMountPoint, getComponentWebEndpoint, waitForComponentRunning, getResourceExportDir, getReleaseExportDir, getResources, getPackResources).
Types & Enums#
This part offers a comprehensive listing of all TypeScript types and enumerations utilized throughout the Blocklet SDK. Understanding these types is essential for writing robust and type-safe Blocklet applications, covering data structures for Blocklet Server responses, requests, and internal SDK operations.
This API Reference is designed to be your go-to resource for detailed information on the Blocklet SDK. Begin by delving into the core Classes to understand the foundational building blocks of your Blocklet application.