ee.data.authenticateViaOauth

Konfiguruje uwierzytelnianie po stronie klienta wywołań interfejsu EE API za pomocą biblioteki klienta Google API w JavaScript. Biblioteka zostanie wczytana automatycznie, jeśli nie jest jeszcze wczytana na stronie. Użytkownik zostanie poproszony o przyznanie aplikacji zidentyfikowanej przez identyfikator klienta dostępu do swoich danych EE, jeśli nie zrobił tego wcześniej.

Tę lub inną metodę uwierzytelniania należy wywołać przed ee.initialize().

Pamiętaj, że jeśli użytkownik nie przyznał wcześniej dostępu aplikacji zidentyfikowanej przez identyfikator klienta, domyślnie pojawi się okno z prośbą o przyznanie wymaganych uprawnień. To wyskakujące okienko może jednak zostać zablokowane przez przeglądarkę. Aby tego uniknąć, określ wywołanie zwrotne opt_onImmediateFailed i wyrenderuj w nim przycisk logowania na stronie, a następnie wywołaj ee.data.authenticateViaPopup() z modułu obsługi zdarzeń kliknięcia tego przycisku. Dzięki temu przeglądarka nie zablokuje wyskakującego okienka, ponieważ będzie ono bezpośrednim wynikiem działania użytkownika.

Token uwierzytelniający będzie w miarę możliwości odświeżany automatycznie. Możesz bezpiecznie założyć, że wszystkie wywołania asynchroniczne będą wysyłane z odpowiednimi danymi logowania. W przypadku wywołań synchronicznych sprawdź jednak, czy jest dostępny token uwierzytelniania, używając funkcji ee.data.getAuthToken(), a jeśli go nie ma, wywołaj ręcznie funkcję ee.data.refreshAuthToken(). Operacja odświeżania tokena jest asynchroniczna i nie można jej wykonać w tle na żądanie przed wywołaniami synchronicznymi.

WykorzystanieZwroty
ee.data.authenticateViaOauth(clientId, success, error, extraScopes, onImmediateFailed, suppressDefaultScopes)
ArgumentTypSzczegóły
clientIdCiąg znakówIdentyfikator klienta OAuth aplikacji lub wartość null, aby wyłączyć wywołania uwierzytelnione. Możesz go uzyskać w Google Developers Console. Projekt musi mieć źródło JavaScript, które odpowiada domenie, w której działa skrypt.
successFunkcjaFunkcja, która ma zostać wywołana, jeśli uwierzytelnianie się powiedzie.
errorFunkcja, opcjonalnieFunkcja, która ma zostać wywołana w przypadku nieudanego uwierzytelnienia, przekazała komunikat o błędzie. Jeśli uwierzytelnianie w trybie natychmiastowym (w tle) się nie powiedzie i określono opt_onImmediateFailed, wywoływana jest ta funkcja zamiast opt_error.
extraScopesList[String], opcjonalnieDodatkowe zakresy protokołu OAuth, o które chcesz poprosić.
onImmediateFailedFunkcja, opcjonalnieFunkcja, która ma być wywoływana, jeśli automatyczne uwierzytelnianie w tle się nie powiedzie. Domyślnie jest to ee.data.authenticateViaPopup(), powiązane z przekazanymi wywołaniami zwrotnymi.
suppressDefaultScopesWartość logiczna, opcjonalnaJeśli ma wartość „true”, żądane są tylko zakresy określone w parametrze opt_extraScopes. Zakresy domyślne nie są żądane, chyba że zostały wyraźnie określone w parametrze opt_extraScopes.