Khởi tạo API máy khách (bản xem trước)

[Bài viết này là tài liệu trước khi phát hành và có thể thay đổi.]

Quan trọng

  • Đây là một tính năng xem trước.
  • Các tính năng xem trước không được dùng cho sản xuất và có thể có chức năng bị hạn chế. Các tính năng này tuân theo các điều khoản sử dụng bổ sung và có sẵn trước khi phát hành chính thức để khách hàng có thể truy cập sớm và cung cấp phản hồi.

Microsoft. PowerPages.onPagesClientApiReady

Power Pages khởi tạo API máy khách không xảy ra ngay lập tức khi trang tải. Sử dụng hàm Microsoft.PowerPages.onPagesClientApiReady để gán đối tượng API $pages khi đã sẵn sàng, vì vậy tập lệnh của bạn chỉ có thể truy nhập API trang sau khi hoàn tất khởi tạo. Bạn có thể khởi tạo theo hai cách.

Quan trọng

Biệt Microsoft.Dynamic365.Portal.onPagesClientApiReady danh không được chấp nhận. Nó vẫn hoạt động để các tập lệnh hiện có tiếp tục chạy, nhưng ghi một cảnh báo một lần vào bảng điều khiển trình duyệt và bị xóa trong một bản phát hành trong tương lai. Sử dụng Microsoft.PowerPages.onPagesClientApiReady thay thế.

Tính sẵn sàng của API dựa trên gọi lại

Sử dụng hàm gọi lại gán đối tượng API cho biến mà bạn xác định khi đã sẵn sàng. Hai ví dụ cho thấy cách thực hiện:

Bằng cách sử dụng hàm ẩn danh:

Microsoft.PowerPages.onPagesClientApiReady(($pages) => {
    const forms = $pages.currentPage.forms.getAll();
    console.log(`Found ${forms.length} forms on the page.`);
});

Bằng cách sử dụng hàm đã đặt tên:

function start($pages){
    const forms = $pages.currentPage.forms.getAll();
    console.log(`Found ${forms.length} forms on the page.`);
}

Microsoft.PowerPages.onPagesClientApiReady(start)

Promise/await-based API readiness

Sử dụng đang chờ xử lý lời hứa được hàm trả Microsoft.PowerPages.onPagesClientApiReady về cho một dòng không đồng bộ rõ ràng hơn.

let $pages = await Microsoft.PowerPages.onPagesClientApiReady();
const forms = $pages.currentPage.forms.getAll();
console.log(`Found ${forms.length} forms on the page.`);

Khi nào nên sử dụng từng phương pháp

Bảng sau đây mô tả thời điểm sử dụng từng phương pháp tiếp cận.

Phương pháp tiếp cận Lúc sử dụng
Tính sẵn sàng của API dựa trên gọi lại Sử dụng khi bạn async/awaitcần hỗ trợ các trình duyệt cũ hơn hoặc tập lệnh cũ không hỗ trợ hoặc khi bạn muốn đăng ký nhiều bộ xử lý chạy khi API đã sẵn sàng. Lý tưởng cho các mẫu hình hướng theo sự kiện.
Promise/await-based API readiness Sử dụng trong môi trường JavaScript hiện đại hỗ trợ async/await mã sạch hơn, tuần tự. Tốt nhất khi lô-gic của bạn phụ thuộc vào API đang sẵn sàng trước khi tiếp tục thực thi.

Mẹo

Nếu cơ sở mã của bạn đã sử dụng async/await, hãy ưu tiên cách tiếp cận dựa trên Promise để nhất quán.

Các ví dụ trong bài viết này và trong các loại điều khiển APIasync máy khách sử dụng mẫu hình dựa trên gọi lại với một cuộc gọi lại, await để mỗi ví dụ có thể sử dụng khi gọi một phương pháp không đồng bộ. Bỏ qua từ khóa async khi mã của riêng bạn không sử dụng await. Mỗi ví dụ minh họa một hoặc nhiều lệnh gọi API và các ví dụ về tác nhân được xây dựng dựa trên các giá trị mà ví dụ trước đó xác định. Để biết ví dụ về việc kết hợp một số API để triển khai một kịch bản hoàn chỉnh, hãy xem Power Pages dụ về API máy khách.

  • Last updated on