android.support.customtabs.CustomTabsCallback Java Examples

/**
 * Notifies the application of a page load metric.
 *
 * TODD(lizeb): Move this to a proper method in {@link CustomTabsCallback} once one is
 * available.
 *
 * @param session Session identifier.
 * @param metricName Name of the page load metric.
 * @param navigationStartTick Absolute navigation start time, as TimeTicks taken from native.
 *
 * @param offsetMs Offset in ms from navigationStart.
 */
boolean notifyPageLoadMetric(CustomTabsSessionToken session, String metricName,
        long navigationStartTick, long offsetMs) {
    CustomTabsCallback callback = mClientManager.getCallbackForSession(session);
    if (callback == null) return false;

    if (!mNativeTickOffsetUsComputed) {
        // Compute offset from time ticks to uptimeMillis.
        mNativeTickOffsetUsComputed = true;
        long nativeNowUs = TimeUtils.nativeGetTimeTicksNowUs();
        long javaNowUs = SystemClock.uptimeMillis() * 1000;
        mNativeTickOffsetUs = nativeNowUs - javaNowUs;
    }

    Bundle args = new Bundle();
    args.putLong(PageLoadMetrics.NAVIGATION_START,
            (navigationStartTick - mNativeTickOffsetUs) / 1000);
    args.putLong(metricName, offsetMs);
    try {
        callback.extraCallback(PAGE_LOAD_METRICS_CALLBACK, args);
    } catch (Exception e) {
        // Pokemon exception handling, see above and crbug.com/517023.
        return false;
    }
    return true;
}
 

@Override
public void onPageLoadFinished(Tab tab) {
    long pageLoadFinishedTimestamp = SystemClock.elapsedRealtime();
    mCustomTabsConnection.notifyNavigationEvent(
            mSession, CustomTabsCallback.NAVIGATION_FINISHED);
    // Both histograms (commit and PLT) are reported here, to make sure
    // that they are always recorded together, and that we only record
    // commits for successful navigations.
    if (mCurrentState == STATE_WAITING_LOAD_FINISH && mIntentReceivedTimestamp > 0) {
        long timeToPageLoadStartedMs = mPageLoadStartedTimestamp - mIntentReceivedTimestamp;
        long timeToPageLoadFinishedMs =
                pageLoadFinishedTimestamp - mIntentReceivedTimestamp;
        // Same bounds and bucket count as "Startup.FirstCommitNavigationTime"
        RecordHistogram.recordCustomTimesHistogram(
                "CustomTabs.IntentToFirstCommitNavigationTime", timeToPageLoadStartedMs,
                1, TimeUnit.MINUTES.toMillis(1), TimeUnit.MILLISECONDS, 225);
        // Same bounds and bucket count as PLT histograms.
        RecordHistogram.recordCustomTimesHistogram("CustomTabs.IntentToPageLoadedTime",
                timeToPageLoadFinishedMs, 10, TimeUnit.MINUTES.toMillis(10),
                TimeUnit.MILLISECONDS, 100);
    }
    resetPageLoadTracking();
}
 

@Override
public void onPageLoadStarted(Tab tab, String url) {
    if (mCurrentState == STATE_WAITING_LOAD_START) {
        mPageLoadStartedTimestamp = SystemClock.elapsedRealtime();
        mCurrentState = STATE_WAITING_LOAD_FINISH;
    } else if (mCurrentState == STATE_WAITING_LOAD_FINISH) {
        if (mCustomTabsConnection != null) {
            mCustomTabsConnection.notifyNavigationEvent(
                    mSession, CustomTabsCallback.NAVIGATION_ABORTED);
            mCustomTabsConnection.sendNavigationInfo(
                    mSession, tab.getUrl(), tab.getTitle(), null);
        }
        mPageLoadStartedTimestamp = SystemClock.elapsedRealtime();
    }
    if (mCustomTabsConnection != null) {
        mCustomTabsConnection.setSendNavigationInfoForSession(mSession, false);
        mCustomTabsConnection.notifyNavigationEvent(
                mSession, CustomTabsCallback.NAVIGATION_STARTED);
        mScreenshotTakenForCurrentNavigation = false;
    }
}
 

@Override
public void onPageLoadStarted(Tab tab, String url) {
    if (mCurrentState == STATE_WAITING_LOAD_START) {
        mPageLoadStartedTimestamp = SystemClock.elapsedRealtime();
        mCurrentState = STATE_WAITING_LOAD_FINISH;
    } else if (mCurrentState == STATE_WAITING_LOAD_FINISH) {
        if (mCustomTabsConnection != null) {
            mCustomTabsConnection.notifyNavigationEvent(
                    mSession, CustomTabsCallback.NAVIGATION_ABORTED);
            mCustomTabsConnection.sendNavigationInfo(
                    mSession, tab.getUrl(), tab.getTitle(), null);
        }
        mPageLoadStartedTimestamp = SystemClock.elapsedRealtime();
    }
    if (mCustomTabsConnection != null) {
        mCustomTabsConnection.setSendNavigationInfoForSession(mSession, false);
        mCustomTabsConnection.notifyNavigationEvent(
                mSession, CustomTabsCallback.NAVIGATION_STARTED);
        mScreenshotTakenForCurrentNavigation = false;
    }
}
 

@Override
public void onCustomTabsServiceConnected(ComponentName name, CustomTabsClient client) {
    client.warmup(0);
    customTabsSession = client.newSession(new CustomTabsCallback());
    if (customTabsSession == null) {
        return;
    }
    // Delay to not slow down native app loading
    customTabsSession.mayLaunchUrl(Uri.parse(Common.CROWDIN_URL), null, null);
}
 

/**
 * Notifies the application of a navigation event.
 *
 * Delivers the {@link CustomTabsConnectionCallback#onNavigationEvent}
 * callback to the application.
 *
 * @param session The Binder object identifying the session.
 * @param navigationEvent The navigation event code, defined in {@link CustomTabsCallback}
 * @return true for success.
 */
boolean notifyNavigationEvent(CustomTabsSessionToken session, int navigationEvent) {
    CustomTabsCallback callback = mClientManager.getCallbackForSession(session);
    if (callback == null) return false;
    try {
        callback.onNavigationEvent(navigationEvent, null);
    } catch (Exception e) {
        // Catching all exceptions is really bad, but we need it here,
        // because Android exposes us to client bugs by throwing a variety
        // of exceptions. See crbug.com/517023.
        return false;
    }
    return true;
}
 

@Override
public void onPageLoadFailed(Tab tab, int errorCode) {
    resetPageLoadTracking();
    if (mCustomTabsConnection != null) {
        mCustomTabsConnection.notifyNavigationEvent(
                mSession, CustomTabsCallback.NAVIGATION_FAILED);
    }
}
 

@Override
public void onDidAttachInterstitialPage(Tab tab) {
    if (tab.getSecurityLevel() != ConnectionSecurityLevel.DANGEROUS) return;
    resetPageLoadTracking();
    if (mCustomTabsConnection != null) {
        mCustomTabsConnection.notifyNavigationEvent(
                mSession, CustomTabsCallback.NAVIGATION_FAILED);
    }
}
 

@Override
public void onShown(Tab tab) {
    if (mCustomTabsConnection != null) {
        mCustomTabsConnection.notifyNavigationEvent(
                mSession, CustomTabsCallback.TAB_SHOWN);
    }
}
 

private void connectBoundService() throws Exception {
    CustomTabsSession session = mock(CustomTabsSession.class);
    ComponentName componentName = new ComponentName(DEFAULT_BROWSER_PACKAGE, DEFAULT_BROWSER_PACKAGE + ".CustomTabsService");
    //This depends on an implementation detail but is the only way to test it because of methods visibility
    PowerMockito.when(session, "getComponentName").thenReturn(componentName);

    when(customTabsClient.newSession(Matchers.<CustomTabsCallback>eq(null))).thenReturn(session);
    CustomTabsServiceConnection conn = serviceConnectionCaptor.getValue();
    conn.onCustomTabsServiceConnected(componentName, customTabsClient);
    verify(customTabsClient).newSession(Matchers.<CustomTabsCallback>eq(null));
    verify(customTabsClient).warmup(eq(0L));
}
 

private CustomTabsSession getSession() {
    return mClient.newSession(new CustomTabsCallback() {
        @Override
        public void onNavigationEvent(int navigationEvent, Bundle extras) {
            super.onNavigationEvent(navigationEvent, extras);
        }
    });
}
 

private CustomTabsSession getSession() {
    return mClient.newSession(new CustomTabsCallback() {
        @Override
        public void onNavigationEvent(int navigationEvent, Bundle extras) {
            super.onNavigationEvent(navigationEvent, extras);
        }
    });
}
 

private CustomTabsSession getSession() {
    return mClient.newSession(new CustomTabsCallback() {
        @Override
        public void onNavigationEvent(int navigationEvent, Bundle extras) {
            super.onNavigationEvent(navigationEvent, extras);
        }
    });
}
 

/**
 * Notifies the application of a page load metric.
 *
 * TODD(lizeb): Move this to a proper method in {@link CustomTabsCallback} once one is
 * available.
 *
 * @param session Session identifier.
 * @param metricName Name of the page load metric.
 * @param offsetMs Offset in ms from navigationStart.
 */
boolean notifyPageLoadMetric(CustomTabsSessionToken session, String metricName, long offsetMs) {
    CustomTabsCallback callback = mClientManager.getCallbackForSession(session);
    if (callback == null) return false;
    Bundle args = new Bundle();
    args.putLong(metricName, offsetMs);
    try {
        callback.extraCallback(PAGE_LOAD_METRICS_CALLBACK, args);
    } catch (Exception e) {
        // Pokemon exception handling, see above and crbug.com/517023.
        return false;
    }
    return true;
}
 

/**
 * Notifies the application of a navigation event.
 *
 * Delivers the {@link CustomTabsConnectionCallback#onNavigationEvent}
 * callback to the application.
 *
 * @param session The Binder object identifying the session.
 * @param navigationEvent The navigation event code, defined in {@link CustomTabsCallback}
 * @return true for success.
 */
boolean notifyNavigationEvent(CustomTabsSessionToken session, int navigationEvent) {
    CustomTabsCallback callback = mClientManager.getCallbackForSession(session);
    if (callback == null) return false;
    try {
        callback.onNavigationEvent(navigationEvent, null);
    } catch (Exception e) {
        // Catching all exceptions is really bad, but we need it here,
        // because Android exposes us to client bugs by throwing a variety
        // of exceptions. See crbug.com/517023.
        return false;
    }
    return true;
}
 

@Override
public void onPageLoadFailed(Tab tab, int errorCode) {
    resetPageLoadTracking();
    if (mCustomTabsConnection != null) {
        mCustomTabsConnection.notifyNavigationEvent(
                mSession, CustomTabsCallback.NAVIGATION_FAILED);
    }
}
 

@Override
public void onPageLoadFinished(Tab tab) {
    long pageLoadFinishedTimestamp = SystemClock.elapsedRealtime();
    if (mCustomTabsConnection != null) {
        mCustomTabsConnection.notifyNavigationEvent(
                mSession, CustomTabsCallback.NAVIGATION_FINISHED);
    }
    // Both histograms (commit and PLT) are reported here, to make sure
    // that they are always recorded together, and that we only record
    // commits for successful navigations.
    if (mCurrentState == STATE_WAITING_LOAD_FINISH && mIntentReceivedTimestamp > 0) {
        long timeToPageLoadStartedMs = mPageLoadStartedTimestamp - mIntentReceivedTimestamp;
        long timeToPageLoadFinishedMs =
                pageLoadFinishedTimestamp - mIntentReceivedTimestamp;

        String histogramPrefix = mOpenedByChrome ? "ChromeGeneratedCustomTab" : "CustomTabs";
        RecordHistogram.recordCustomTimesHistogram(
                histogramPrefix + ".IntentToFirstCommitNavigationTime2.ZoomedOut",
                timeToPageLoadStartedMs,
                50, TimeUnit.MINUTES.toMillis(10), TimeUnit.MILLISECONDS, 50);
        RecordHistogram.recordCustomTimesHistogram(
                histogramPrefix + ".IntentToFirstCommitNavigationTime2.ZoomedIn",
                timeToPageLoadStartedMs, 200, 1000, TimeUnit.MILLISECONDS, 100);
        // Same bounds and bucket count as PLT histograms.
        RecordHistogram.recordCustomTimesHistogram(histogramPrefix + ".IntentToPageLoadedTime",
                timeToPageLoadFinishedMs, 10, TimeUnit.MINUTES.toMillis(10),
                TimeUnit.MILLISECONDS, 100);
    }
    resetPageLoadTracking();
    captureNavigationInfo(tab);
}
 

@Override
public void onShown(Tab tab) {
    if (mCustomTabsConnection != null) {
        mCustomTabsConnection.notifyNavigationEvent(
                mSession, CustomTabsCallback.TAB_SHOWN);
    }
}
 

@Override
public void onDidAttachInterstitialPage(Tab tab) {
    if (tab.getSecurityLevel() != ConnectionSecurityLevel.DANGEROUS) return;
    resetPageLoadTracking();
    if (mCustomTabsConnection != null) {
        mCustomTabsConnection.notifyNavigationEvent(
                mSession, CustomTabsCallback.NAVIGATION_FAILED);
    }
}
 

@Override
public void onCustomTabsServiceConnected(ComponentName name, CustomTabsClient client) {
    client.warmup(0);
    customTabsSession = client.newSession(new CustomTabsCallback());
    if (customTabsSession == null) {
        return;
    }
    // Delay to not slow down native app loading
    communicationHandler.postDelayed(() -> customTabsSession.mayLaunchUrl(Uri.parse(Utils.getUrl(HassActivity.this)), null, null), 1500);
}
 

private CustomTabsSession getSession() {
    if (mClient == null) {
        mCustomTabsSession = null;
    } else if (mCustomTabsSession == null) {
        mCustomTabsSession = mClient.newSession(new CustomTabsCallback());
    }
    return mCustomTabsSession;
}
 

public CustomTabsSession getCustomTabsSession() {
  if (customTabsClient == null) {
    return null;
  }

  if (currentSession == null) {
    currentSession = customTabsClient.newSession(new CustomTabsCallback(){
      @Override
      public void onNavigationEvent(int navigationEvent, Bundle extras) {
        switch (navigationEvent) {
          case NAVIGATION_FINISHED:
            notifyListeners("browserPageLoaded", new JSObject());
            break;
        }
      }
    });
  }

  return currentSession;
}
 

/**
 * Notifies the application of a navigation event.
 *
 * Delivers the {@link CustomTabsConnectionCallback#onNavigationEvent}
 * callback to the application.
 *
 * @param session The Binder object identifying the session.
 * @param navigationEvent The navigation event code, defined in {@link CustomTabsCallback}
 * @return true for success.
 */
boolean notifyNavigationEvent(CustomTabsSessionToken session, int navigationEvent) {
    CustomTabsCallback callback = mClientManager.getCallbackForSession(session);
    if (callback == null) return false;
    try {
        callback.onNavigationEvent(navigationEvent, null);
    } catch (Exception e) {
        // Catching all exceptions is really bad, but we need it here,
        // because Android exposes us to client bugs by throwing a variety
        // of exceptions. See crbug.com/517023.
        return false;
    }
    return true;
}
 

@Override
public void onPageLoadStarted(Tab tab, String url) {
    if (mCurrentState == STATE_WAITING_LOAD_START) {
        mPageLoadStartedTimestamp = SystemClock.elapsedRealtime();
        mCurrentState = STATE_WAITING_LOAD_FINISH;
    } else if (mCurrentState == STATE_WAITING_LOAD_FINISH) {
        mCustomTabsConnection.notifyNavigationEvent(
                mSession, CustomTabsCallback.NAVIGATION_ABORTED);
        mPageLoadStartedTimestamp = SystemClock.elapsedRealtime();
    }
    mCustomTabsConnection.notifyNavigationEvent(
            mSession, CustomTabsCallback.NAVIGATION_STARTED);
}
 

@Override
public void onDidAttachInterstitialPage(Tab tab) {
    if (tab.getSecurityLevel() != ConnectionSecurityLevel.SECURITY_ERROR) return;
    resetPageLoadTracking();
    mCustomTabsConnection.notifyNavigationEvent(
            mSession, CustomTabsCallback.NAVIGATION_FAILED);
}
 

@Override
public void onPauseWithNative() {
    super.onPauseWithNative();
    CustomTabsConnection.getInstance(getApplication()).notifyNavigationEvent(
            mSession, CustomTabsCallback.TAB_HIDDEN);
}
 

/**
 * @return The callback {@link CustomTabsSessionToken} for the given session.
 */
public synchronized CustomTabsCallback getCallbackForSession(CustomTabsSessionToken session) {
    return session != null ? session.getCallback() : null;
}
 

@Override
public void onPageLoadFinished(Tab tab) {
    long pageLoadFinishedTimestamp = SystemClock.elapsedRealtime();
    if (mCustomTabsConnection != null) {
        mCustomTabsConnection.notifyNavigationEvent(
                mSession, CustomTabsCallback.NAVIGATION_FINISHED);
    }

    if (mCurrentState == STATE_WAITING_LOAD_FINISH && mIntentReceivedTimestamp > 0) {
        String histogramPrefix = mOpenedByChrome ? "ChromeGeneratedCustomTab" : "CustomTabs";
        long timeToPageLoadFinishedMs = pageLoadFinishedTimestamp - mIntentReceivedTimestamp;
        if (mPageLoadStartedTimestamp > 0) {
            long timeToPageLoadStartedMs = mPageLoadStartedTimestamp - mIntentReceivedTimestamp;
            // Intent to Load Start is recorded here to make sure we do not record
            // failed/aborted page loads.
            RecordHistogram.recordCustomTimesHistogram(
                    histogramPrefix + ".IntentToFirstCommitNavigationTime2.ZoomedOut",
                    timeToPageLoadStartedMs, 50, TimeUnit.MINUTES.toMillis(10),
                    TimeUnit.MILLISECONDS, 50);
            RecordHistogram.recordCustomTimesHistogram(
                    histogramPrefix + ".IntentToFirstCommitNavigationTime2.ZoomedIn",
                    timeToPageLoadStartedMs, 200, 1000, TimeUnit.MILLISECONDS, 100);
        }
        // Same bounds and bucket count as PLT histograms.
        RecordHistogram.recordCustomTimesHistogram(histogramPrefix + ".IntentToPageLoadedTime",
                timeToPageLoadFinishedMs, 10, TimeUnit.MINUTES.toMillis(10),
                TimeUnit.MILLISECONDS, 100);

        // Not all page loads go through a navigation commit (prerender for instance).
        if (mPageLoadStartedTimestamp != 0) {
            long timeToFirstCommitMs = mFirstCommitTimestamp - mIntentReceivedTimestamp;
            // Current median is 550ms, and long tail is very long. ZoomedIn gives good view of
            // the median and ZoomedOut gives a good overview.
            RecordHistogram.recordCustomTimesHistogram(
                    "CustomTabs.IntentToFirstCommitNavigationTime3.ZoomedIn",
                    timeToFirstCommitMs, 200, 1000, TimeUnit.MILLISECONDS, 100);
            // For ZoomedOut very rarely is it under 50ms and this range matches
            // CustomTabs.IntentToFirstCommitNavigationTime2.ZoomedOut.
            RecordHistogram.recordCustomTimesHistogram(
                    "CustomTabs.IntentToFirstCommitNavigationTime3.ZoomedOut",
                    timeToFirstCommitMs, 50, TimeUnit.MINUTES.toMillis(10),
                    TimeUnit.MILLISECONDS, 50);
        }
    }
    resetPageLoadTracking();
    captureNavigationInfo(tab);
}
 

@Override
public void onShown(Tab tab) {
    mCustomTabsConnection.notifyNavigationEvent(
            mSession, CustomTabsCallback.TAB_SHOWN);
}
 

/**
 * @return The callback {@link CustomTabsSessionToken} for the given session.
 */
public synchronized CustomTabsCallback getCallbackForSession(CustomTabsSessionToken session) {
    return session != null ? session.getCallback() : null;
}