@blocklet/js-sdkは、いくつかのサービスクラスに編成されており、それぞれが特定の機能ドメインを担当しています。これらのサービスは、さまざまなBlocklet APIエンドポイントの専用クライアントとして機能し、プラットフォームの機能と対話するための構造化された直感的な方法を提供します。
ほとんどのコアサービスは、getBlockletSDK()関数を使用して取得できるメインのBlockletSDKインスタンスのプロパティとして事前に初期化され、利用可能です。
Accessing a Service
import { getBlockletSDK } from '@blocklet/js-sdk';
const sdk = getBlockletSDK();
// AuthServiceにアクセスしてユーザー情報を取得
async function getUserProfile() {
const profile = await sdk.user.getProfile();
console.log(profile);
}
// BlockletServiceにアクセスしてblocklet情報を取得
async function getBlockletMeta() {
const meta = await sdk.blocklet.getMeta();
console.log(meta);
}下の図は、BlockletSDKインスタンスの構造とコアサービスとの関係を示しています。
以下は、利用可能なサービスの完全なリストです。任意のサービスをクリックすると、その詳細なAPIリファレンスが表示されます。
AuthService
ユーザープロファイル、プライバシー設定、通知、およびログアウトなどの認証アクションを管理するためのAPI。
BlockletService
`window.blocklet`またはリモートURLからblockletメタデータを取得およびロードするためのAPI。
ComponentService
マウントされたコンポーネントに関する情報を取得し、それらのURLを構築するためのAPI。
FederatedService
Federated Login Group設定と対話し、マスターアプリと現在のアプリに関する情報を取得するためのAPI。
TokenService
ストレージ（CookiesおよびLocalStorage）からセッショントークンとリフレッシュトークンを取得、設定、削除するための低レベルAPI。
UserSessionService
ユーザーログインセッションを取得および管理するためのAPI。
各サービスは、Blockletプラットフォームの特定の部分に焦点を当てたメソッドのセットを提供します。これらのサービスによって返されるデータ構造と型を理解するには、型のリファレンスを参照してください。