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