Save the date! Android Dev Summit is coming to Mountain View, CA on November 7-8, 2018.
added in version 24.1.0
belongs to Maven artifact com.android.support:customtabs:28.0.0-alpha1

CustomTabsCallback

public class CustomTabsCallback
extends Object

java.lang.Object
   ↳ android.support.customtabs.CustomTabsCallback


A callback class for custom tabs client to get messages regarding events in their custom tabs. In the implementation, all callbacks are sent to the UI thread for the client.

Summary

Constants

int NAVIGATION_ABORTED

Sent when loading was aborted by a user action before it finishes like clicking on a link or refreshing the page.

int NAVIGATION_FAILED

Sent when the tab couldn't finish loading due to a failure.

int NAVIGATION_FINISHED

Sent when the tab has finished loading a page.

int NAVIGATION_STARTED

Sent when the tab has started loading a page.

int TAB_HIDDEN

Sent when the tab becomes hidden.

int TAB_SHOWN

Sent when the tab becomes visible.

Public constructors

CustomTabsCallback()

Public methods

void extraCallback(String callbackName, Bundle args)

Unsupported callbacks that may be provided by the implementation.

void onMessageChannelReady(Bundle extras)

Called when CustomTabsSession has requested a postMessage channel through requestPostMessageChannel(CustomTabsSessionToken, android.net.Uri) and the channel is ready for sending and receiving messages on both ends.

void onNavigationEvent(int navigationEvent, Bundle extras)

To be called when a navigation event happens.

void onPostMessage(String message, Bundle extras)

Called when a tab controlled by this CustomTabsSession has sent a postMessage.

void onRelationshipValidationResult(int relation, Uri requestedOrigin, boolean result, Bundle extras)

Called when a relationship validation result is available.

Inherited methods

From class java.lang.Object

Constants

NAVIGATION_ABORTED

added in version 24.1.0
int NAVIGATION_ABORTED

Sent when loading was aborted by a user action before it finishes like clicking on a link or refreshing the page.

Constant Value: 4 (0x00000004)

NAVIGATION_FAILED

added in version 24.1.0
int NAVIGATION_FAILED

Sent when the tab couldn't finish loading due to a failure.

Constant Value: 3 (0x00000003)

NAVIGATION_FINISHED

added in version 24.1.0
int NAVIGATION_FINISHED

Sent when the tab has finished loading a page.

Constant Value: 2 (0x00000002)

NAVIGATION_STARTED

added in version 24.1.0
int NAVIGATION_STARTED

Sent when the tab has started loading a page.

Constant Value: 1 (0x00000001)

TAB_HIDDEN

added in version 24.1.0
int TAB_HIDDEN

Sent when the tab becomes hidden.

Constant Value: 6 (0x00000006)

TAB_SHOWN

added in version 24.1.0
int TAB_SHOWN

Sent when the tab becomes visible.

Constant Value: 5 (0x00000005)

Public constructors

CustomTabsCallback

added in version 24.1.0
CustomTabsCallback ()

Public methods

extraCallback

added in version 24.1.0
void extraCallback (String callbackName, 
                Bundle args)

Unsupported callbacks that may be provided by the implementation.

Note:Clients should never rely on this callback to be called and/or to have a defined behavior, as it is entirely implementation-defined and not supported.

This can be used by implementations to add extra callbacks, for testing or experimental purposes.

Parameters
callbackName String: Name of the extra callback.

args Bundle: Arguments for the calback

onMessageChannelReady

added in version 25.4.0
void onMessageChannelReady (Bundle extras)

Called when CustomTabsSession has requested a postMessage channel through requestPostMessageChannel(CustomTabsSessionToken, android.net.Uri) and the channel is ready for sending and receiving messages on both ends.

Parameters
extras Bundle: Reserved for future use.

onNavigationEvent

added in version 24.1.0
void onNavigationEvent (int navigationEvent, 
                Bundle extras)

To be called when a navigation event happens.

Parameters
navigationEvent int: The code corresponding to the navigation event.

extras Bundle: Reserved for future use.

onPostMessage

added in version 25.4.0
void onPostMessage (String message, 
                Bundle extras)

Called when a tab controlled by this CustomTabsSession has sent a postMessage. If postMessage() is called from a single thread, then the messages will be posted in the same order. When received on the client side, it is the client's responsibility to preserve the ordering further.

Parameters
message String: The message sent.

extras Bundle: Reserved for future use.

onRelationshipValidationResult

added in version 27.1.0
void onRelationshipValidationResult (int relation, 
                Uri requestedOrigin, 
                boolean result, 
                Bundle extras)

Called when a relationship validation result is available.

Parameters
relation int: Relation for which the result is available. Value previously passed to validateRelationship(int, Uri, Bundle). Must be one of the CustomTabsService#RELATION_* constants.

requestedOrigin Uri: Origin requested. Value previously passed to validateRelationship(int, Uri, Bundle).

result boolean: Whether the relation was validated.

extras Bundle: Reserved for future use.