SDK Types

SDKCredentials

• Mô tả: Đối tượng chứa thông tin xác thực cần thiết để kết nối với API.
• Thuộc tính:
  • url: Chuỗi, URL của API.
  • key: Chuỗi, API Key.
  • trackingId: Chuỗi, ID theo dõi.

Ví dụ:

const credentials: SDKCredentials = {
  url: "https://api.example.com",
  key: "your-api-key",
  trackingId: "your-tracking-id",
};

---

SDKOptions

• Mô tả: Đối tượng chứa các tùy chọn cấu hình SDK tổng quát.
• Thuộc tính:
  • guiOptions: Tùy chọn cấu hình giao diện người dùng (xem SDKGuiOptions).
  • language: Ngôn ngữ của SDK, có thể là "vi" hoặc "en".
  • forceConsent: Boolean, yêu cầu người dùng phải đồng ý trước khi tiếp tục.
  • darkMode: Boolean, cấu hình chế độ tối cho giao diện người dùng.

Ví dụ:

const options: SDKOptions = {
  guiOptions: {
    consentModal: {
      layout: "box",
      position: "top center",
    },
  },
  language: "vi",
  forceConsent: true,
  darkMode: false,
};

SDKGuiOptions

• Mô tả: Tùy chọn cấu hình giao diện người dùng của SDK, bao gồm các tùy chọn cho các modal đồng ý và sở thích.
• Thuộc tính:
  • consentModal: Các tùy chọn cho modal đồng ý người dùng.
    • layout: Bố cục của modal đồng ý người dùng (xem ConsentModalLayout).
    • position: Vị trí của modal đồng ý người dùng (xem ConsentModalPosition).
  • preferencesModal: Các tùy chọn cho modal sở thích người dùng.
    • layout: Bố cục của modal sở thích người dùng (xem PreferencesModalLayout).
    • position: Vị trí của modal sở thích người dùng (xem PreferencesModalPosition).

Ví dụ:

const guiOptions: SDKGuiOptions = {
  consentModal: {
    layout: "box",
    position: "top center",
  },
  preferencesModal: {
    layout: "bar",
    position: "right",
  },
};

---

ConsentModalLayout

• Mô tả: Các kiểu bố cục của modal đồng ý người dùng.
• Các giá trị hợp lệ:
  • "box"
  • "box wide"
  • "box inline"
  • "cloud"
  • "cloud inline"
  • "bar"
  • "bar inline"

Ví dụ:

const layout: ConsentModalLayout = "box";

---

ConsentModalPosition

• Mô tả: Các vị trí của modal đồng ý người dùng.
• Các giá trị hợp lệ:
  • "top"
  • "bottom"
  • "middle"
  • "top left"
  • "top center"
  • "top right"
  • "middle left"
  • "middle center"
  • "middle right"
  • "bottom left"
  • "bottom center"
  • "bottom right"

Ví dụ:

const position: ConsentModalPosition = "top center";

---

PreferencesModalLayout

• Mô tả: Các kiểu bố cục của modal sở thích người dùng.
• Các giá trị hợp lệ:
  • "box"
  • "bar"
  • "bar wide"

Ví dụ:

const layout: PreferencesModalLayout = "bar";

---

PreferencesModalPosition

• Mô tả: Các vị trí của modal sở thích người dùng.
• Các giá trị hợp lệ:
  • "left"
  • "right"

Ví dụ:

const position: PreferencesModalPosition = "left";

SDKError

• Mô tả: Lỗi SDK bao gồm mã lỗi, tên lỗi và mô tả chi tiết.
• Thuộc tính:
  • code: Mã lỗi (số nguyên).
  • name: Tên lỗi (chuỗi).
  • description: Mô tả lỗi chi tiết.

Ví dụ:

const error: SDKError = new SDKError(
  1001,
  "INVALID_CREDENTIALS",
  "API Key is missing."
);