Xác định trình quản lý đối tượng thuê được sử dụng để giúp quản lý các hoạt động liên quan đến đối tượng thuê. Điêu nay bao gôm:
- Khả năng tạo, cập nhật, liệt kê, nhận và xóa đối tượng thuê cho dự án cơ bản.
- Lấy phiên bản
TenantAwareAuthđể chạy các hoạt động liên quan đến Auth (quản lý người dùng, quản lý cấu hình nhà cung cấp, xác minh mã thông báo, tạo liên kết email, v.v.) trong ngữ cảnh của một đối tượng thuê được chỉ định.
Chữ ký:
export declare class TenantManager
phương pháp
| Phương pháp | sửa đổi | Sự miêu tả |
|---|---|---|
| authForTenant(tenantId) | Trả về một phiên bản TenantAwareAuth được liên kết với ID đối tượng thuê đã cho. | |
| createTenant(tenantOptions) | Tạo một người thuê nhà mới. Khi tạo đối tượng thuê mới, những đối tượng thuê sử dụng hạn ngạch và thanh toán riêng sẽ yêu cầu dự án riêng của họ và phải được xác định là full_service . | |
| xóaTenant(tenantId) | Xóa một người thuê nhà hiện có. | |
| getTenant(tenantId) | Nhận cấu hình đối tượng thuê cho đối tượng thuê tương ứng với tenantId nhất định. | |
| listTenants(maxResults, pageToken) | Truy xuất danh sách đối tượng thuê (chỉ một lô) có kích thước maxResults bắt đầu từ phần bù như được chỉ định bởi pageToken . Điều này được sử dụng để truy xuất tất cả các đối tượng thuê của một dự án được chỉ định theo đợt. | |
| cập nhậtTenant(tenantId,rentOptions) | Cập nhật cấu hình đối tượng thuê hiện có. |
TenantManager.authForTenant()
Trả về một phiên bản TenantAwareAuth được liên kết với ID đối tượng thuê đã cho.
Chữ ký:
authForTenant(tenantId: string): TenantAwareAuth;
Thông số
| Tham số | Kiểu | Sự miêu tả |
|---|---|---|
| id người thuê nhà | sợi dây | ID đối tượng thuê có phiên bản TenantAwareAuth sẽ được trả về. |
Trả về:
Phiên bản TenantAwareAuth tương ứng với mã định danh đối tượng thuê này.
TenantManager.createTenant()
Tạo một người thuê nhà mới. Khi tạo đối tượng thuê mới, những đối tượng thuê sử dụng hạn ngạch và thanh toán riêng sẽ yêu cầu dự án của riêng họ và phải được xác định là full_service .
Chữ ký:
createTenant(tenantOptions: CreateTenantRequest): Promise<Tenant>;
Thông số
| Tham số | Kiểu | Sự miêu tả |
|---|---|---|
| tùy chọn thuê nhà | TạoYêu cầu thuê nhà | Các thuộc tính cần đặt trên cấu hình đối tượng thuê mới sẽ được tạo. |
Trả về:
Lời hứa< Người thuê nhà >
Lời hứa được thực hiện với cấu hình đối tượng thuê tương ứng với đối tượng thuê mới được tạo.
TenantManager.deleteTenant()
Xóa một người thuê nhà hiện có.
Chữ ký:
deleteTenant(tenantId: string): Promise<void>;
Thông số
| Tham số | Kiểu | Sự miêu tả |
|---|---|---|
| id người thuê nhà | sợi dây | tenantId tương ứng với đối tượng thuê cần xóa. |
Trả về:
Hứa<void>
Một lời hứa trống rỗng được thực hiện sau khi đối tượng thuê đã bị xóa.
TenantManager.getTenant()
Nhận cấu hình đối tượng thuê cho đối tượng thuê tương ứng với một tenantId nhất định .
Chữ ký:
getTenant(tenantId: string): Promise<Tenant>;
Thông số
| Tham số | Kiểu | Sự miêu tả |
|---|---|---|
| id người thuê nhà | sợi dây | Mã định danh đối tượng thuê tương ứng với đối tượng thuê có dữ liệu cần tìm nạp. |
Trả về:
Lời hứa< Người thuê nhà >
Một lời hứa đã được thực hiện với cấu hình đối tượng thuê đối với tenantId được cung cấp .
TenantManager.listTenants()
Truy xuất danh sách đối tượng thuê (chỉ một lô) với kích thước maxResults bắt đầu từ phần bù như được chỉ định bởi pageToken . Điều này được sử dụng để truy xuất tất cả các đối tượng thuê của một dự án được chỉ định theo đợt.
Chữ ký:
listTenants(maxResults?: number, pageToken?: string): Promise<ListTenantsResult>;
Thông số
| Tham số | Kiểu | Sự miêu tả |
|---|---|---|
| kết quả tối đa | con số | Kích thước trang, 1000 nếu không xác định. Đây cũng là giới hạn tối đa cho phép. |
| trangToken | sợi dây | Mã thông báo trang tiếp theo. Nếu không được chỉ định, trả về đối tượng thuê bắt đầu mà không có bất kỳ khoản bù đắp nào. |
Trả về:
Lời hứa< Danh sách Người thuê Kết quả >
Lời hứa được giải quyết bằng một loạt đối tượng thuê được tải xuống và mã thông báo trang tiếp theo.
TenantManager.updateTenant()
Cập nhật cấu hình đối tượng thuê hiện có.
Chữ ký:
updateTenant(tenantId: string, tenantOptions: UpdateTenantRequest): Promise<Tenant>;
Thông số
| Tham số | Kiểu | Sự miêu tả |
|---|---|---|
| id người thuê nhà | sợi dây | tenantId tương ứng với đối tượng thuê cần xóa. |
| tùy chọn thuê nhà | Cập nhậtYêu cầu thuê nhà | Các thuộc tính cần cập nhật về đối tượng thuê được cung cấp. |
Trả về:
Lời hứa< Người thuê nhà >
Một lời hứa đã được thực hiện với việc cập nhật dữ liệu của đối tượng thuê.