GetGoogleIdOption.Builder

class GetGoogleIdOption.Builder


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

ملخّص

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

الوظائف العامة

GetGoogleIdOption.Builder
associateLinkedAccounts(
    linkedServiceId: String,
    idTokenDepositionScopes: List<String>?
)

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

GetGoogleIdOption
GetGoogleIdOption.Builder
setAutoSelectEnabled(autoSelectEnabled: Boolean)

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

GetGoogleIdOption.Builder
setClaims(claims: List<Claim>)

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

GetGoogleIdOption.Builder
setFilterByAuthorizedAccounts(filterByAuthorizedAccounts: Boolean)

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

GetGoogleIdOption.Builder
setHostedDomainFilter(hostedDomainFilter: String?)

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

GetGoogleIdOption.Builder
setNonce(nonce: String?)

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

GetGoogleIdOption.Builder
setRequestVerifiedPhoneNumber(requestVerifiedPhoneNumber: Boolean)

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

GetGoogleIdOption.Builder
setServerClientId(serverClientId: String)

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

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

عامل بناء

Builder()

الوظائف العامة

associateLinkedAccounts

fun associateLinkedAccounts(
    linkedServiceId: String,
    idTokenDepositionScopes: List<String>?
): GetGoogleIdOption.Builder

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

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

المعلمات
linkedServiceId: String

معرّف الخدمة المستخدَم عند ربط الحسابات بحساب Google

idTokenDepositionScopes: List<String>?

نطاقات OAuth التي ستحتاج إليها Google لإيداع رمز مميّز لمعرّف Google في خادم الخلفية لتطبيقك هذا الحقل اختياري ويمكن ضبطه على قيمة فارغة. يجب توفيرها فقط إذا كانت Google تتطلّب نطاقات معيّنة لتتمكّن من إيداع رمز التعريف.

إنشاء

fun build(): GetGoogleIdOption

setAutoSelectEnabled

fun setAutoSelectEnabled(autoSelectEnabled: Boolean): GetGoogleIdOption.Builder

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

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

setClaims

fun setClaims(claims: List<Claim>): GetGoogleIdOption.Builder

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

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

المعلمات
claims: List<Claim>

قائمة بالمطالبات

setFilterByAuthorizedAccounts

fun setFilterByAuthorizedAccounts(filterByAuthorizedAccounts: Boolean): GetGoogleIdOption.Builder

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

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

المعلمات
filterByAuthorizedAccounts: Boolean

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

setHostedDomainFilter

fun setHostedDomainFilter(hostedDomainFilter: String?): GetGoogleIdOption.Builder

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

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

المعلمات
hostedDomainFilter: String?

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

setNonce

fun setNonce(nonce: String?): GetGoogleIdOption.Builder

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

المعلمات
nonce: String?

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

setRequestVerifiedPhoneNumber

fun setRequestVerifiedPhoneNumber(requestVerifiedPhoneNumber: Boolean): GetGoogleIdOption.Builder

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

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

setServerClientId

fun setServerClientId(serverClientId: String): GetGoogleIdOption.Builder

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

المعلمات
serverClientId: String

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