يحدد مدير المستأجر المستخدم للمساعدة في إدارة العمليات المتعلقة بالمستأجر. هذا يتضمن:
- القدرة على إنشاء وتحديث وإدراج والحصول على وحذف المستأجرين للمشروع الأساسي.
- الحصول على مثيل
TenantAwareAuthلتشغيل العمليات ذات الصلة بالمصادقة (إدارة المستخدم، وإدارة تكوين الموفر، والتحقق من الرمز المميز، وإنشاء رابط البريد الإلكتروني، وما إلى ذلك) في سياق مستأجر محدد.
إمضاء:
export declare class TenantManager
طُرق
| طريقة | الصفات التعريفية | وصف |
|---|---|---|
| أوثفورتينانت (معرف المستأجر) | إرجاع مثيل TenantAwareAuth المرتبط بمعرف المستأجر المحدد. | |
| إنشاء المستأجر(tenantOptions) | إنشاء مستأجر جديد. عند إنشاء مستأجرين جدد، سيتطلب المستأجرون الذين يستخدمون فواتير وحصة منفصلة مشروعهم الخاص ويجب تعريفهم على أنه full_service . | |
| حذف المستأجر (معرف المستأجر) | حذف مستأجر موجود. | |
| الحصول على المستأجر (معرف المستأجر) | الحصول على تكوين المستأجر الخاص بالمستأجر المطابق لمعرف tenantId المحدد. | |
| قائمة المستأجرين (maxResults، pageToken) | استرداد قائمة المستأجرين (دفعة واحدة فقط) بحجم maxResults بدءًا من الإزاحة كما هو محدد بواسطة pageToken . يتم استخدام هذا لاسترداد جميع المستأجرين لمشروع محدد على دفعات. | |
| تحديث المستأجر (معرف المستأجر، خيارات المستأجر) | يقوم بتحديث تكوين المستأجر الحالي. |
TenantManager.authForTenant()
إرجاع مثيل TenantAwareAuth المرتبط بمعرف المستأجر المحدد.
إمضاء:
authForTenant(tenantId: string): TenantAwareAuth;
حدود
| معامل | يكتب | وصف |
|---|---|---|
| معرف المستأجر | خيط | معرف المستأجر الذي سيتم إرجاع مثيل TenantAwareAuth الخاص به. |
عائدات:
مثيل TenantAwareAuth المطابق لمعرف المستأجر هذا.
TenantManager.createTenant()
إنشاء مستأجر جديد. عند إنشاء مستأجرين جدد، سيتطلب المستأجرون الذين يستخدمون فواتير وحصة منفصلة مشروعهم الخاص ويجب تعريفهم على أنه full_service .
إمضاء:
createTenant(tenantOptions: CreateTenantRequest): Promise<Tenant>;
حدود
| معامل | يكتب | وصف |
|---|---|---|
| TenantOptions | طلب إنشاء المستأجر | الخصائص التي سيتم تعيينها في تكوين المستأجر الجديد الذي سيتم إنشاؤه. |
عائدات:
وعد < المستأجر >
وعد تم الوفاء به مع تكوين المستأجر المطابق للمستأجر الذي تم إنشاؤه حديثًا.
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>;
حدود
| معامل | يكتب | وصف |
|---|---|---|
| maxResults | رقم | حجم الصفحة 1000 إذا لم يتم تحديده. وهذا أيضًا الحد الأقصى المسموح به. |
| pageToken | خيط | رمز الصفحة التالية. إذا لم يتم تحديده، فسيتم إرجاع المستأجرين بدءًا من دون أي إزاحة. |
عائدات:
الوعد< ListTenantsResult >
وعد يتم حله مع مجموعة من المستأجرين الذين تم تنزيلهم والرمز المميز للصفحة التالية.
TenantManager.updateTenant()
يقوم بتحديث تكوين المستأجر الحالي.
إمضاء:
updateTenant(tenantId: string, tenantOptions: UpdateTenantRequest): Promise<Tenant>;
حدود
| معامل | يكتب | وصف |
|---|---|---|
| معرف المستأجر | خيط | tenantId المطابق للمستأجر المطلوب حذفه. |
| TenantOptions | UpdateTenantRequest | الخصائص المراد تحديثها على المستأجر المقدم. |
عائدات:
وعد < المستأجر >
الوعد الذي تم الوفاء به مع تحديث بيانات المستأجر.