GetGoogleIdOption.Builder

Kotlin |Java

public final class GetGoogleIdOption.Builder

---

أداة إنشاء لـ GetGoogleIdOption

ملخّص

طُرق وضع التصميم العامة
Builder()

الإجراءات العامة
final @NonNull GetGoogleIdOption.Builder	associateLinkedAccounts(     @NonNull String linkedServiceId,     List<@NonNull String> idTokenDepositionScopes ) تحدّد هذه السمة ما إذا كان سيتم السماح بتسجيل الدخول باستخدام حسابات Google المرتبطة بحسابات المستخدمين.
final @NonNull GetGoogleIdOption	build()
final @NonNull GetGoogleIdOption.Builder	setAutoSelectEnabled(boolean autoSelectEnabled) تضبط هذه السمة سلوك الاختيار التلقائي في الطلب.
final @NonNull GetGoogleIdOption.Builder	setClaims(@NonNull List<@NonNull Claim> claims) تضبط هذه السمة المطالبات التي سيتم تضمينها في رمز تعريف Google.
final @NonNull GetGoogleIdOption.Builder	setFilterByAuthorizedAccounts(boolean filterByAuthorizedAccounts) تضبط هذه السمة ما إذا كان سيُسمح للمستخدم فقط بالاختيار من حسابات Google التي تم منحها الإذن بتسجيل الدخول إلى تطبيقك.
final @NonNull GetGoogleIdOption.Builder	setHostedDomainFilter(String hostedDomainFilter) يضبط فلتر النطاق المستضاف لحصر استخدام ميزة "تسجيل الدخول باستخدام Google" على الحسابات ضمن نطاق معيّن في Google Workspace.
final @NonNull GetGoogleIdOption.Builder	setNonce(String nonce) تضبط هذه السمة القيمة العشوائية التي سيتم استخدامها عند إنشاء رمز مميّز لمعرّف Google.
final @NonNull GetGoogleIdOption.Builder	setRequestVerifiedPhoneNumber(boolean requestVerifiedPhoneNumber) تضبط هذه السمة ما إذا كان سيُطلب توفير رقم هاتف تم تأكيده أثناء عمليات الاشتراك.
final @NonNull GetGoogleIdOption.Builder	setServerClientId(@NonNull String serverClientId) يضبط معرّف العميل للخادم ليتم استخدامه كجمهور لرموز تعريف Google التي يتم إنشاؤها أثناء تسجيل الدخول.

طُرق وضع التصميم العامة

عامل بناء

public Builder()

الإجراءات العامة

associateLinkedAccounts

public final @NonNull GetGoogleIdOption.Builder associateLinkedAccounts(
    @NonNull String linkedServiceId,
    List<@NonNull String> idTokenDepositionScopes
)

تحدّد هذه السمة ما إذا كان سيتم السماح بتسجيل الدخول باستخدام حسابات Google المرتبطة بحسابات المستخدمين.

عند اختيار بيانات اعتماد من هذا النوع، سيتم أولاً إيداع رمز مميّز لمعرّف Google لحساب Google المرتبط بالحساب المحدّد في خادمك، ثم سيتم إرجاعه إليك. وكما هو الحال مع عملية تسجيل الدخول العادية، يمكن أن يستخدم الخلفية رمز التعريف لتسجيل دخول المستخدم. يُرجى العِلم أنّ عملية إيداع الرمز المميّز لتعريف الهوية ستتم فقط عند تسجيل الدخول للمرة الأولى باستخدام بيانات الاعتماد هذه. لن تتطلّب عمليات تسجيل الدخول اللاحقة إيداعًا، لأنّه سيتم ربط الرمز المميّز للمعرّف بحساب المستخدم.

المعلمات
@NonNull String linkedServiceId	معرّف الخدمة المستخدَم عند ربط الحسابات بحساب Google
List<@NonNull String> idTokenDepositionScopes	نطاقات OAuth التي ستحتاج إليها Google لإيداع رمز مميّز لمعرّف Google في خادم الخلفية لتطبيقك هذا الحقل اختياري ويمكن ضبطه على قيمة فارغة. يجب توفيرها فقط إذا كانت Google تتطلّب نطاقات معيّنة لتتمكّن من إيداع رمز التعريف.

إنشاء

public final @NonNull GetGoogleIdOption build()

setAutoSelectEnabled

public final @NonNull GetGoogleIdOption.Builder setAutoSelectEnabled(boolean autoSelectEnabled)

تضبط هذه السمة سلوك الاختيار التلقائي في الطلب.

بالنسبة إلى المستخدمين الذين يوافقون على استخدام ميزة "الاختيار التلقائي"، تتيح هذه الميزة اختيار بيانات الاعتماد تلقائيًا بدون انتظار إجراء من المستخدم (مثل النقر على زر "متابعة"). يمكن اختيار بيانات الاعتماد تلقائيًا في حال استيفاء الشرطَين التاليَين: 1) لا يمكن استخدام سوى بيانات اعتماد واحدة لتسجيل الدخول، و2) لا يلزم اتّخاذ أي إجراءات إضافية بشأن بيانات الاعتماد هذه (على سبيل المثال، تمّت الموافقة على أذونات مشاركة البيانات لحساب Google).

setClaims

public final @NonNull GetGoogleIdOption.Builder setClaims(@NonNull List<@NonNull Claim> claims)

تضبط هذه السمة المطالبات التي سيتم تضمينها في رمز تعريف Google.

للاطّلاع على قائمة بالمطالبات المتاحة، يُرجى الرجوع إلى المستندات. سيتم تجاهل أي مطالبات غير متوافقة.

المعلمات
@NonNull List<@NonNull Claim> claims	قائمة بالمطالبات

setFilterByAuthorizedAccounts

public final @NonNull GetGoogleIdOption.Builder setFilterByAuthorizedAccounts(boolean filterByAuthorizedAccounts)

تضبط هذه السمة ما إذا كان سيُسمح للمستخدم فقط بالاختيار من حسابات Google التي تم منحها الإذن بتسجيل الدخول إلى تطبيقك. القيمة التلقائية هي "صحيح".

إذا كانت القيمة {@code true}، لن يتمكّن المستخدم من اختيار أي حساب على Google يتطلّب الحصول على إذن صريح لمشاركة بيانات الملف الشخصي الأساسية أو بيانات البريد الإلكتروني مع تطبيقك. قد يقلّل ذلك من بعض المشاكل في رحلة المستخدم لتسجيل الدخول، ويضمن أنّ بيانات الاعتماد التي تم عرضها تخص "مستخدمًا متكرّرًا"، ولكنّه يحدّ من حرية المستخدم في الاختيار من بين جميع حسابات Google على الجهاز.

المعلمات
boolean filterByAuthorizedAccounts	ما إذا كان سيتم السماح للمستخدم فقط بالاختيار من حسابات Google التي تم منحها الإذن بتسجيل الدخول إلى تطبيقك

setHostedDomainFilter

public final @NonNull GetGoogleIdOption.Builder setHostedDomainFilter(String hostedDomainFilter)

يضبط فلتر النطاق المستضاف لحصر استخدام ميزة "تسجيل الدخول باستخدام Google" على الحسابات ضمن نطاق معيّن في Google Workspace.

سيؤدي تمرير قيمة فارغة أو سلسلة فارغة إلى عدم إجراء أي فلترة.

المعلمات
String hostedDomainFilter	النطاق المطلوب الفلترة حسبه (مثلاً example.com")

setNonce

public final @NonNull GetGoogleIdOption.Builder setNonce(String nonce)

تضبط هذه السمة القيمة العشوائية التي سيتم استخدامها عند إنشاء رمز مميّز لمعرّف Google.

المعلمات
String nonce	الرقم العشوائي الذي سيتم استخدامه أثناء إنشاء رمز التعريف

setRequestVerifiedPhoneNumber

public final @NonNull GetGoogleIdOption.Builder setRequestVerifiedPhoneNumber(boolean requestVerifiedPhoneNumber)

تضبط هذه السمة ما إذا كان سيُطلب توفير رقم هاتف تم تأكيده أثناء عمليات الاشتراك.

لاستخدام هذه الميزة، يجب ضبط الحقل [filterByAuthorizedAccounts] بشكل صريح على القيمة false، لأنّ هذه الميزة متاحة فقط أثناء عمليات الاشتراك.

setServerClientId

public final @NonNull GetGoogleIdOption.Builder setServerClientId(@NonNull String serverClientId)

يضبط معرّف العميل للخادم ليتم استخدامه كجمهور لرموز تعريف Google التي يتم إنشاؤها أثناء تسجيل الدخول.

المعلمات
@NonNull String serverClientId	معرّف العميل للخادم الذي سيتم إصدار رمز التعريف المميز له