API Trình quản lý thẻ - Tham khảo thông số

Tài liệu này mô tả mục đích và cách trình bày về Trình quản lý thẻ .

Giới thiệu

API Trình quản lý thẻ giúp bạn tạo và quản lý các tài nguyên của Trình quản lý thẻ chẳng hạn như Thẻ, Trình kích hoạt và Biến.

Hầu hết các loại Thẻ và Biến đều có thông số bổ sung cụ thể vào Thẻ hoặc Biến và có thể được đặt khi tạo/cập nhật tài nguyên. Danh sách thông số (key, type cặp) cho từng Thẻ và Biến được liệt kê trong Từ điển thẻ Tệp đối chiếu.

Để định cấu hình các thông số cụ thể của Thẻ hoặc Biến này, thông số đối tượng được xác định và đặt làm giá trị cho parameter của Thẻ hoặc Tài nguyên của biến.

Đối tượng tham số

Đối tượng sau đây đại diện cho một đối tượng tham số:

[
  {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ]
  }
]

type

Loại thông số của Thẻ hoặc Biến đang được định cấu hình.

Thuộc tính type sẽ xác định cho dù thuộc tính value, list hay map cần được bao gồm trong đối tượng thông số, như được mô tả trong bảng bên dưới.

Ví dụ: nếu bạn đặt type thành boolean thì Bạn phải đưa thuộc tính value vào đối tượng thông số và đặt đến true hoặc false.

Giá trị	Thuộc tính bổ sung cần bao gồm	Nội dung cần đặt thuộc tính bổ sung
template	value	value là chuỗi bất kỳ, bao gồm cả các biến tham chiếu, ví dụ: foo{{bar}}
boolean	value	value sẽ là true hoặc false.
number	value	value là một số nguyên.
list	list	list sẽ chứa không hoặc nhiều thông số khác, thứ tự có thể/có thể không quan trọng; key của bất kỳ tham số nào trong list sẽ bị bỏ qua.
map	map	map sẽ chứa không hoặc nhiều tham số, thứ tự không bao gồm vấn đề; key trên bất kỳ tham số nào trong map đều phải là duy nhất.

key

Khoá thông số của Thẻ hoặc Biến đang được định cấu hình.

Trường key dùng để xác định tham số của ứng dụng cụ thể Thẻ hoặc Biến đang được đặt. Tất cả các loại tham số đều cần có key (ngoại trừ các tham số list).

Ví dụ

Đối tượng thông số cho Thẻ HTML tuỳ chỉnh. có một tham số loại template và hai loại boolean thông số:

"parameter": [
  {
    "key": "html",
    "type": "template",
    "value": "<script>alert('hello world')</script>"
  },
  {
    "key": "supportDocumentWrite",
    "type": "boolean",
    "value": "false"
  }
]

Đối tượng tham số cho Lệnh gọi hàm Thẻ, có một tham số loại template và một map loại tham số:

"parameter": [
  {
    "key": "functionName",
    "type": "template",
    "value": "fn"
  },
  {
    "key": "functionArgument",
    "map": [
      {
        "key": "argkey1",
        "type": "template",
        "value": "argval1"
      }
    ],
    "type": "map"
  }
]