AuthService | ArcBlock

AuthService 提供了一個全面的 API，用於管理使用者帳戶的各個方面。它處理使用者個人資料、隱私和通知設定、追蹤其他使用者等社交互動，以及登出和刪除帳戶等關鍵的身份驗證操作。您可以透過 SDK 實例中的 sdk.auth 來存取它。

此服務與 TokenService 密切合作以管理身份驗證狀態，但在大多數操作中抽象化了底層的權杖處理。

使用者個人資料管理

這些方法允許您獲取、更新和管理使用者個人資料。

getProfile

擷取當前已驗證使用者的完整個人資料。

const profile = await sdk.auth.getProfile();
console.log(profile);

profile Promise<object> — 一個解析為使用者個人資料物件的 Promise。

回應範例

{
  "did": "z8ia29UsENBg6tLZUKi2HABj38Cw1LmHZocbQ",
  "fullName": "John Doe",
  "email": "john.doe@example.com",
  "avatar": "https://example.com/avatar.png",
  "bio": "開發者和愛好者。",
  "metadata": {}
}

saveProfile

更新當前已驗證使用者的個人資料。您可以更新 locale、metadata 等欄位。

參數

profileData object (required) — 一個包含要更新的個人資料欄位的物件。
- locale string — 使用者的偏好語言地區設定（例如：'en'）。
- inviter string — 邀請當前使用者的使用者 DID。
- metadata any — 一個用於儲存自訂使用者資料的物件。
- address any — 使用者的地址資訊。

const updatedProfile = await sdk.auth.saveProfile({
  metadata: { twitter: '@johndoe' },
  locale: 'en-US'
});
console.log('個人資料已儲存：', updatedProfile);

updatedProfile Promise<object> — 一個解析為已更新個人資料物件的 Promise。

getUserPublicInfo

透過 DID 獲取任何使用者的公開可用資訊。

參數

options object (required)
- did string (required) — 使用者的去中心化識別碼（DID）。

const publicInfo = await sdk.auth.getUserPublicInfo({ did: 'z8ia...' });
console.log(publicInfo.fullName);

UserPublicInfo Promise<object> — 一個解析為 UserPublicInfo 物件的 Promise。
- avatar string — 使用者頭像的 URL。
- did string — 使用者的 DID。
- fullName string — 使用者的全名。
- sourceAppPid string | null — 來源應用程式的 PID。

refreshProfile

強制從原始來源同步使用者個人資料，確保資料是最新的。

await sdk.auth.refreshProfile();
console.log('已啟動個人資料刷新。');

void Promise<void> — 一個在刷新請求已發送時解析的 Promise。

updateDidSpace

更新使用者的 DID Space 設定，這決定了他們的資料儲存在哪裡。

參數

options object (required)
- spaceGateway object (required) — 一個包含新 DID Space 閘道詳細資訊的物件。
  - did string (required) — 空間的 DID。
  - name string (required) — 空間的名稱。
  - url string (required) — 空間的 URL。
  - endpoint string (required) — 空間的 API 端點。

const spaceGateway = {
  did: 'zNK...',
  name: 'My Personal Space',
  url: 'https://space.example.com',
  endpoint: 'https://space.example.com/api'
};

await sdk.auth.updateDidSpace({ spaceGateway });
console.log('DID Space 更新成功。');

void Promise<void> — 一個在成功更新後解析的 Promise。

getProfileUrl

為使用者的公開個人資料頁面建構 URL。

參數

options object (required)
- did string (required) — 使用者的 DID。
- locale string (required) — 個人資料頁面的目標地區設定。

const url = await sdk.auth.getProfileUrl({ did: 'z8ia...', locale: 'en' });
console.log('個人資料 URL：', url);

url Promise<string> — 一個解析為完整個人資料 URL 字串的 Promise。

設定管理

管理使用者特定的隱私和通知設定。

getUserPrivacyConfig

擷取指定使用者的隱私設定。

參數

options object (required)
- did string (required) — 正在請求其隱私設定的使用者 DID。

const privacyConfig = await sdk.auth.getUserPrivacyConfig({ did: 'z8ia...' });
console.log('電子郵件是否公開？', privacyConfig.isEmailPublic);

PrivacyConfig Promise<object> — 一個解析為使用者 PrivacyConfig 物件的 Promise，其中鍵是設定名稱，值是布林值。

saveUserPrivacyConfig

儲存當前已驗證使用者的隱私設定。

參數

config object (required) — 一個帶有鍵值對的物件，代表隱私設定。

const newConfig = { isEmailPublic: false, allowFriendRequests: false };
const savedConfig = await sdk.auth.saveUserPrivacyConfig(newConfig);
console.log('隱私設定已儲存。');

PrivacyConfig Promise<object> — 一個解析為已儲存 PrivacyConfig 物件的 Promise。

getUserNotificationConfig

獲取當前使用者的通知設定，包括 webhooks 和頻道偏好。

const notificationConfig = await sdk.auth.getUserNotificationConfig();
console.log('Webhooks:', notificationConfig.webhooks);

NotificationConfig Promise<object> — 一個解析為 NotificationConfig 物件的 Promise。
- webhooks array
  - webhook object
    - type 'slack' | 'api' (required)
    - url string (required)
- notifications object
  - email boolean
  - wallet boolean
  - phone boolean

saveUserNotificationConfig

為當前使用者儲存新的通知設定。

參數

config object (required) — 新的通知設定物件。
- webhooks array
  - webhook object
    - type 'slack' | 'api' (required)
    - url string (required)
- notifications object
  - email boolean
  - wallet boolean
  - phone boolean

const newConfig = {
  webhooks: [
    { type: 'api', url: 'https://example.com/webhook' }
  ],
  notifications: {
    email: true,
    wallet: false
  }
};
const savedConfig = await sdk.auth.saveUserNotificationConfig(newConfig);
console.log('通知設定已儲存：', savedConfig);

NotificationConfig Promise<object> — 一個解析為已儲存 NotificationConfig 物件的 Promise。

testNotificationWebhook

測試 webhook 設定以確保它可以接收測試通知。

參數

webhook object (required) — 要測試的 webhook 物件。
- type 'slack' | 'api' (required)
- url string (required)

const webhookToTest = {
  type: 'slack',
  url: 'https://hooks.slack.com/services/...'
};
const result = await sdk.auth.testNotificationWebhook(webhookToTest);
console.log('Webhook 測試成功：', result.success);

result Promise<object> — 一個解析為帶有 success 屬性的物件的 Promise。
- success boolean — 指示測試是否成功。

社交互動

管理使用者之間的社交聯繫。

followUser

追蹤另一位使用者。

參數

options object (required)
- userDid string (required) — 要追蹤的使用者 DID。

const userToFollow = 'z8ia...';
await sdk.auth.followUser({ userDid: userToFollow });
console.log(`成功追蹤 ${userToFollow}。`);

void Promise<void> — 一個在操作完成後解析的 Promise。

unfollowUser

取消追蹤使用者。

參數

options object (required)
- userDid string (required) — 要取消追蹤的使用者 DID。

const userToUnfollow = 'z8ia...';
await sdk.auth.unfollowUser({ userDid: userToUnfollow });
console.log(`成功取消追蹤 ${userToUnfollow}。`);

void Promise<void> — 一個在操作完成後解析的 Promise。

isFollowingUser

檢查當前使用者是否正在追蹤特定使用者。

參數

options object (required)
- userDid string (required) — 要檢查的使用者 DID。

const userToCheck = 'z8ia...';
const { isFollowing } = await sdk.auth.isFollowingUser({ userDid: userToCheck });
if (isFollowing) {
  console.log(`您正在追蹤 ${userToCheck}。`);
} else {
  console.log(`您沒有追蹤 ${userToCheck}。`);
}

result Promise<object> — 一個解析為包含 isFollowing 屬性的物件的 Promise。
- isFollowing boolean — 如果當前使用者正在追蹤指定使用者，則為 true。

身份驗證與帳戶操作

執行與使用者會話和帳戶生命週期相關的關鍵操作。

logout

將當前使用者登出。可以設定為從特定設備或所有會話登出。

參數

options object
- visitorId string — 要登出的特定設備/會話的 ID。
- status string — 要登出的會話狀態。
- includeFederated boolean — 如果為 true，也會從聯邦登入群組中的所有應用程式登出。

// 從當前會話簡單登出
await sdk.auth.logout({});
console.log('登出成功。');

// 從特定設備和所有聯邦應用程式登出
await sdk.auth.logout({ visitorId: 'some-visitor-id', includeFederated: true });

void Promise<void> — 一個在登出過程完成後解析的 Promise。

destroyMyself

永久刪除當前已驗證使用者的帳戶。此操作不可逆，應極其謹慎使用。

// 這是一個破壞性操作。通常，您需要與使用者確認此操作。
try {
  const result = await sdk.auth.destroyMyself();
  console.log(`帳戶 ${result.did} 已被永久刪除。`);
} catch (error) {
  console.error('刪除帳戶失敗：', error);
}

result Promise<object> — 一個解析為包含已刪除使用者 DID 的物件的 Promise。
- did string — 已刪除使用者的 DID。