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 आईडी टोकन भेज पाएगा. यह ज़रूरी नहीं है और इसे null पर सेट किया जा सकता है. यह सिर्फ़ तब ज़रूरी होता है, जब 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

उस सर्वर का क्लाइंट आईडी जिसे आईडी टोकन जारी किया जाएगा