Package org.mozilla.geckoview
Interface TranslationsController.SessionTranslation.Delegate
- Enclosing class:
- TranslationsController.SessionTranslation
@AnyThread
public static interface TranslationsController.SessionTranslation.Delegate
The translations session delegate is used for receiving translation events and information.
-
Method Summary
Modifier and TypeMethodDescriptiondefault void
onExpectedTranslate
(GeckoSession session) onExpectedTranslate occurs when it is likely the user will want to translate and it is feasible.default void
onOfferTranslate
(GeckoSession session) onOfferTranslate occurs when a page should be offered for translation.default void
onTranslationStateChange
(GeckoSession session, TranslationsController.SessionTranslation.TranslationState translationState) onTranslationStateChange occurs when new information about the translation state is available.
-
Method Details
-
onOfferTranslate
onOfferTranslate occurs when a page should be offered for translation.An offer should occur when all conditions are met:
* The page is not in the user's preferred language
* The page language is eligible for translation
* The host hasn't been offered for translation in this session
* No user preferences indicate that translation shouldn't be offered
* It is possible to translate
Usual use-case is to show a pop-up recommending a translation.
- Parameters:
session
- The associated GeckoSession.
-
onExpectedTranslate
onExpectedTranslate occurs when it is likely the user will want to translate and it is feasible. For example, if the page is in a different language than the user preferred language or languages.Usual use-case is to add a toolbar option for translate.
- Parameters:
session
- The associated GeckoSession.
-
onTranslationStateChange
default void onTranslationStateChange(@NonNull GeckoSession session, @Nullable TranslationsController.SessionTranslation.TranslationState translationState) onTranslationStateChange occurs when new information about the translation state is available. This includes information when first visiting the page and after calls to translate.- Parameters:
session
- The associated GeckoSession.translationState
- The state of the translation as reported by the translation engine.
-