מגדיר את מנהל הדיירים המשמש לסייע בניהול פעולות הקשורות לדייר. זה כולל:
- היכולת ליצור, לעדכן, לרשום, לקבל ולמחוק דיירים עבור הפרויקט הבסיסי.
- קבלת מופע
TenantAwareAuthלהפעלת פעולות הקשורות ל-Auth (ניהול משתמשים, ניהול תצורת ספק, אימות אסימונים, יצירת קישורים לדוא"ל וכו') בהקשר של דייר שצוין.
חֲתִימָה:
export declare class TenantManager
שיטות
| שיטה | משנה | תיאור |
|---|---|---|
| authForTenant(tenantId) | מחזירה מופע TenantAwareAuth המחובר למזהה הדייר הנתון. | |
| createTenant(tenantOptions) | יוצר דייר חדש. בעת יצירת דיירים חדשים, דיירים המשתמשים בחיוב ובמכסה נפרדים ידרשו פרויקט משלהם וחייבים להיות מוגדרים כ- full_service . | |
| deleteTenant(tenantId) | מוחק שוכר קיים. | |
| getTenant(tenantId) | מקבל את תצורת הדייר עבור הדייר התואמת ל- 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 המתאים לדייר שיש למחוק. |
החזרות:
הבטחה<void>
הבטחה ריקה מתוכן לאחר שהשוכר נמחק.
TenantManager.getTenant()
מקבל את תצורת הדייר עבור הדייר התואמת ל- tenantId נתון .
חֲתִימָה:
getTenant(tenantId: string): Promise<Tenant>;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| זיהוי דייר | חוּט | מזהה הדייר המתאים לדייר שאת הנתונים שלו יש לאחזר. |
החזרות:
הבטחה< דייר >
הבטחה שמומשה עם תצורת הדייר ל- tenantId שסופק .
TenantManager.listTenants()
מאחזר רשימה של דיירים (אצווה בודדת בלבד) עם גודל של maxResults החל מההיסט כפי שצוין על ידי pageToken . זה משמש כדי לאחזר את כל הדיירים של פרויקט מוגדר בקבוצות.
חֲתִימָה:
listTenants(maxResults?: number, pageToken?: string): Promise<ListTenantsResult>;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| maxResults | מספר | גודל העמוד, 1000 אם לא מוגדר. זהו גם הגבול המרבי המותר. |
| pageToken | חוּט | אסימון העמוד הבא. אם לא צוין, מחזיר דיירים החל ללא כל קיזוז. |
החזרות:
הבטחה< ListTenantsResult >
הבטחה שנפתרת עם אצווה של דיירים שהורדו ואסימון העמוד הבא.
TenantManager.updateTenant()
מעדכן תצורת דייר קיימת.
חֲתִימָה:
updateTenant(tenantId: string, tenantOptions: UpdateTenantRequest): Promise<Tenant>;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| זיהוי דייר | חוּט | ה- tenantId המתאים לדייר שיש למחוק. |
| דייר אפשרויות | UpdateTenantRequest | הנכסים לעדכן על השוכר המסופק. |
החזרות:
הבטחה< דייר >
הבטחה מומשה עם עדכון נתוני הדיירים.