API

constructor({ credentials, options })

• Mô tả: Khởi tạo đối tượng KalapaCMPSDK với các thông tin chứng thực và các tùy chọn cấu hình.
• Tham số:
  • credentials: Đối tượng kiểu SDKCredentials chứa thông tin chứng thực SDK.
  • options: Đối tượng kiểu SDKOptions chứa các tùy chọn cấu hình cho SDK, bao gồm các guiOptions và language.
• Trả về: Một thể hiện mới của KalapaCMPSDK.

Ví dụ:

/**
 * Toàn bộ cấu hình có ở đây
 * https://docs.cmp.kalapa.vn/web/config/full.html
 */
const sdk = new KalapaCMPSDK({
  credentials: {
    url: "provided-url",
    key: "provided-key",
    trackingId: "your-customer-tracking-id",
  },
  options: {
    guiOptions: {
      consentModal: {
        layout: "cloud",
        position: "bottom center",
      },
      preferencesModal: {
        layout: "box",
      },
    },
    language: "vi",
    forceConsent: true,
    darkMode: false,
  },
});

setNewConfig({ credentials, options })

• Mô tả: Cập nhật cấu hình mới cho SDK bằng cách đặt lại các chứng thực và tùy chọn. Hàm này thực hiện các bước:

  • Đặt lại thông tin chứng thực (credentials).
  • Cập nhật các cài đặt danh mục, giao diện và ngôn ngữ.
  • Thiết lập tùy chọn ép buộc sự đồng ý nếu cần.
  • Khởi chạy lại giao diện consent với cấu hình mới của SDK

• Tham số:

  • credentials: Đối tượng kiểu SDKCredentials chứa thông tin chứng thực mới.
  • options: Đối tượng kiểu SDKOptions chứa các tùy chọn cấu hình mới, bao gồm guiOptions, language, và forceConsent.

Ví dụ:

/**
 * Toàn bộ cấu hình có ở đây
 * https://docs.cmp.kalapa.vn/web/config/full.html
 */
sdk.setNewConfig({
  credentials: {
    url: "provided-url",
    key: "provided-key",
    trackingId: "your-customer-tracking-id",
  },
  options: {
    guiOptions: {
      consentModal: {
        layout: "cloud",
        position: "bottom center",
      },
      preferencesModal: {
        layout: "box",
      },
    },
    language: "vi",
    forceConsent: true,
    darkMode: false,
  },
});

Here is the content without the "ABC":

## `getCategories()`

- **Mô tả**: Trả về các danh mục của consent đã được định nghĩa trong cấu hình của dự án.
- **Trả về**: Các danh mục consent được định nghĩa trong cấu hình của dự án.

### Ví dụ:

```javascript
const categories = sdk.getCategories();
```

---

getProjectConfig()

• Mô tả: Trả về cấu hình của dự án, được lấy từ API.
• Trả về: Cấu hình dự án được trả về từ API.

Ví dụ:

const projectConfig = sdk.getProjectConfig();

---

updateGuiOptions(guiOptions: SDKGuiOptions)

• Mô tả: Cập nhật các tùy chọn GUI của nền tảng quản lý consent.
• Tham số: guiOptions (SDKGuiOptions) - Các tùy chọn GUI mới cần được áp dụng.
• Không có giá trị trả về.

Ví dụ:

sdk.updateGuiOptions({
  consentModal: {
    layout: "box",
    position: "top center",
  },
});

---

updateCredentials(credentials: SDKCredentials)

• Mô tả: Cập nhật thông tin xác thực SDK.
• Tham số: credentials (SDKCredentials) - Thông tin xác thực mới.
• Không có giá trị trả về.

Ví dụ:

sdk.updateCredentials({
  url: "https://new-api-url.com",
  key: "new-api-key",
  trackingId: "new-tracking-id",
});

---

checkUserConsent()

• Mô tả: Kiểm tra trạng thái consent của người dùng.
• Trả về: Một Promise trả về trạng thái consent của người dùng hoặc null nếu không tìm thấy dữ liệu consent.

Ví dụ:

sdk.checkUserConsent().then((consentStatus) => {
  console.log(consentStatus); // Consent hoặc null
});

reset()

• Mô tả: Reset lại cấu hình của SDK
• Trả về: Hàm này không trả về giá trị.

Ví dụ:

sdk.reset();