مدیر مستاجر را تعریف می کند که برای کمک به مدیریت عملیات مربوط به مستاجر استفاده می شود. این شامل:
- امکان ایجاد، به روز رسانی، فهرست کردن، دریافت و حذف مستاجران برای پروژه اساسی.
- دریافت یک نمونه
TenantAwareAuthبرای اجرای عملیات مربوط به Auth (مدیریت کاربر، مدیریت پیکربندی ارائه دهنده، تأیید رمز، تولید پیوند ایمیل، و غیره) در زمینه یک مستاجر مشخص.
امضا:
export declare class TenantManager
مواد و روش ها
| روش | اصلاح کننده ها | شرح |
|---|---|---|
| authForTenant(tenantId) | یک نمونه TenantAwareAuth را که به شناسه مستاجر داده شده محدود شده است، برمی گرداند. | |
| createTenant(tenantOptions) | مستاجر جدید ایجاد می کند. هنگام ایجاد مستاجران جدید، مستاجرینی که از صورتحساب و سهمیه جداگانه استفاده می‌کنند، به پروژه خود نیاز دارند و باید به عنوان full_service تعریف شوند. | |
| حذف مستاجر(مستاجر شناسه) | مستاجر موجود را حذف می کند. | |
| getTenant (مستاجر شناسه) | پیکربندی مستاجر را برای مستاجر مربوط به یک tenantId معین دریافت می کند. | |
| listTenants (maxResults، pageToken) | فهرستی از مستاجران (فقط یک دسته) را با اندازه maxResults که از آفست مشخص شده توسط pageToken شروع می شود، بازیابی می کند. این برای بازیابی همه مستاجران یک پروژه مشخص به صورت دسته ای استفاده می شود. | |
| updateTenant(tenantId، tenantOptions) | پیکربندی مستاجر موجود را به روز می کند. |
TenantManager.authForTenant()
یک نمونه TenantAwareAuth را که به شناسه مستاجر داده شده محدود شده است، برمی گرداند.
امضا:
authForTenant(tenantId: string): TenantAwareAuth;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| شناسه مستاجر | رشته | شناسه مستاجر که نمونه TenantAwareAuth آن قرار است برگردانده شود. |
برمی گرداند:
نمونه TenantAwareAuth مربوط به این شناسه مستاجر.
TenantManager.createTenant()
مستاجر جدید ایجاد می کند. هنگام ایجاد مستاجران جدید، مستاجرینی که از صورتحساب و سهمیه جداگانه استفاده می کنند، به پروژه خود نیاز دارند و باید به عنوان full_service تعریف شوند. .
امضا:
createTenant(tenantOptions: CreateTenantRequest): Promise<Tenant>;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| گزینه های مستاجر | CreateTenantRequest | ویژگی هایی که باید روی پیکربندی مستاجر جدید ایجاد شوند تنظیم شوند. |
برمی گرداند:
قول< مستاجر >
قولی که با پیکربندی مستاجر مطابق با مستاجر جدید ایجاد شده محقق شد.
TenantManager.deleteTenant()
مستاجر موجود را حذف می کند.
امضا:
deleteTenant(tenantId: string): Promise<void>;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| شناسه مستاجر | رشته | tenantId مربوط به مستاجر برای حذف. |
برمی گرداند:
قول<باطل>
یک وعده توخالی که پس از حذف مستاجر انجام می شود.
TenantManager.getTenant()
پیکربندی مستاجر را برای مستاجر مربوط به یک tenantId معین دریافت می کند .
امضا:
getTenant(tenantId: string): Promise<Tenant>;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| شناسه مستاجر | رشته | شناسه مستاجر مربوط به مستاجری که داده‌های او واکشی می‌شود. |
برمی گرداند:
قول< مستاجر >
قولی که با پیکربندی مستاجر به tenantId ارائه شده محقق شد .
TenantManager.listTenants()
فهرستی از مستأجران (فقط یک دسته) با اندازه maxResults بازیابی می کند که از افست مشخص شده توسط pageToken شروع می شود. . این برای بازیابی همه مستاجران یک پروژه مشخص به صورت دسته ای استفاده می شود.
امضا:
listTenants(maxResults?: number, pageToken?: string): Promise<ListTenantsResult>;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| حداکثر نتایج | عدد | اندازه صفحه، 1000 اگر تعریف نشده باشد. این نیز حداکثر حد مجاز است. |
| pageToken | رشته | توکن صفحه بعد. اگر مشخص نشده باشد، مستاجران را بدون هیچ گونه جبرانی باز می گرداند. |
برمی گرداند:
Promise< ListTenantsResult >
قولی که با دسته ای از مستاجران دانلود شده و توکن صفحه بعدی حل می شود.
TenantManager.updateTenant()
پیکربندی مستاجر موجود را به روز می کند.
امضا:
updateTenant(tenantId: string, tenantOptions: UpdateTenantRequest): Promise<Tenant>;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| شناسه مستاجر | رشته | tenantId مربوط به مستاجر برای حذف. |
| گزینه های مستاجر | UpdateTenantRequest | املاک برای به روز رسانی در مستاجر ارائه شده. |
برمی گرداند:
قول< مستاجر >
وعده ای که با به روز رسانی داده های مستاجر محقق شد.