TenantManager class

Xác định người quản lý đối tượng thuê được dùng để giúp quản lý các hoạt động liên quan đến đối tượng thuê. Điều này bao gồm:

• Có thể tạo, cập nhật, liệt kê, nhận và xoá đối tượng thuê cho dự án cơ bản.
• Lấy một thực thể TenantAwareAuth để chạy các hoạt động liên quan đến tính năng Xác thực (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 đường liên kết email, v.v.) trong bối cảnh đối tượng thuê được chỉ định.

Chữ ký:

export declare class TenantManager 

Phương thức

Phương thức	Công cụ sửa đổi	Mô tả
authForTenant(tenantId)		Trả về một thực thể TenantAwareAuth liên kết với mã đối tượng thuê đã cho.
createTenant(tenantOptions)		Tạo một đối tượng thuê mới. Khi tạo những người thuê mới, những người thuê sử dụng hệ thống thanh toán và hạn mức riêng sẽ phải có dự án riêng và phải được xác định là full_service.
deleteTenant(tenantId)		Xoá một đối tượng thuê hiện có.
getTenant(tenantId)		Lấy cấu hình đối tượng thuê của đối tượng thuê tương ứng với một tenantId nhất định.
listTenants(maxKết quả, pageToken)		Truy xuất danh sách đối tượng thuê (chỉ một lô) có kích thước là maxResults bắt đầu từ giá trị bù trừ do pageToken chỉ định. Thao tác này dùng để truy xuất tất cả đối tượng thuê của một dự án cụ thể theo lô.
updateTenant(tenantId; tenantOptions)		Cập nhật cấu hình đối tượng thuê hiện có.

TenantManager.authForTenant()

Trả về một thực thể TenantAwareAuth liên kết với mã đối tượng thuê đã cho.

Chữ ký:

authForTenant(tenantId: string): TenantAwareAuth;

Thông số

Thông số	Loại	Mô tả
mã đối tượng thuê	chuỗi	Mã đối tượng thuê có thực thể TenantAwareAuth cần trả về.

Trường hợp trả lại hàng:

TenantAwareAuth

Thực thể TenantAwareAuth tương ứng với giá trị nhận dạng đối tượng thuê này.

TenantManager.createTenant()

Tạo một đối tượng thuê mới. Khi tạo những người thuê mới, những người thuê sử dụng hệ thống thanh toán và hạn mức riêng sẽ phải có dự án riêng và phải được xác định là full_service.

Chữ ký:

createTenant(tenantOptions: CreateTenantRequest): Promise<Tenant>;

Thông số

Thông số	Loại	Mô tả
Lựa chọn cho người thuê nhà	CreateTenantRequest	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ường hợp trả lại hàng:

Cam kết<Tenant>

Lời hứa được thực hiện thông qua cấu hình của đối tượng thuê tương ứng với đối tượng thuê mới được tạo.

TenantManager.deleteTenant()

Xoá một đối tượng thuê hiện có.

Chữ ký:

deleteTenant(tenantId: string): Promise<void>;

Thông số

Thông số	Loại	Mô tả
mã đối tượng thuê	chuỗi	tenantId tương ứng với đối tượng thuê cần xoá.

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

Một lời hứa không có nội dung được thực hiện sau khi đối tượng thuê bị xoá.

TenantManager.getTenant()

Lấy cấu hình đối tượng thuê của đố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ố

Thông số	Loại	Mô tả
mã đối tượng thuê	chuỗi	Giá trị nhận dạng đối tượng thuê tương ứng với đối tượng thuê có dữ liệu cần tìm nạp.

Trường hợp trả lại hàng:

Cam kết<Tenant>

Lời hứa đã được thực hiện thông qua cấu hình của đối tượng thuê cho tenantId được cung cấp.

TenantManager.listTenants()

Truy xuất danh sách đối tượng thuê (chỉ một lô) có kích thước là maxResults, bắt đầu từ giá trị bù trừ theo chỉ định của pageToken. Thao tác này dùng để truy xuất tất cả đối tượng thuê của một dự án cụ thể theo lô.

Chữ ký:

listTenants(maxResults?: number, pageToken?: string): Promise<ListTenantsResult>;

Thông số

Thông số	Loại	Mô tả
kết quả tối đa	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 được phép.
mã thông báo trang	chuỗi	Mã thông báo trang tiếp theo. Nếu không được chỉ định, hệ thống sẽ trả về những đối tượng thuê bắt đầu mà không có bất kỳ khoản bù trừ nào.

Trường hợp trả lại hàng:

Cam kết<ListTenantsResult>

Lời hứa sẽ được giải quyết với một loạt đối tượng thuê đã 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ố

Thông số	Loại	Mô tả
mã đối tượng thuê	chuỗi	tenantId tương ứng với đối tượng thuê cần xoá.
Lựa chọn cho người thuê nhà	UpdateTenantRequest	Các cơ sở lưu trú cần cập nhật về đối tượng thuê được cung cấp.

Trường hợp trả lại hàng:

Cam kết<Tenant>

Lời hứa đã được thực hiện bằng dữ liệu cập nhật đối tượng thuê.