1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
|
/*
* Copyright (C) 2015 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.support.customtabs;
import android.os.Bundle;
/**
* 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.
*/
public class CustomTabsCallback {
/**
* Sent when the tab has started loading a page.
*/
public static final int NAVIGATION_STARTED = 1;
/**
* Sent when the tab has finished loading a page.
*/
public static final int NAVIGATION_FINISHED = 2;
/**
* Sent when the tab couldn't finish loading due to a failure.
*/
public static final int NAVIGATION_FAILED = 3;
/**
* Sent when loading was aborted by a user action before it finishes like clicking on a link
* or refreshing the page.
*/
public static final int NAVIGATION_ABORTED = 4;
/**
* Sent when the tab becomes visible.
*/
public static final int TAB_SHOWN = 5;
/**
* Sent when the tab becomes hidden.
*/
public static final int TAB_HIDDEN = 6;
/**
* To be called when a navigation event happens.
*
* @param navigationEvent The code corresponding to the navigation event.
* @param extras Reserved for future use.
*/
public void onNavigationEvent(int navigationEvent, Bundle extras) {}
/**
* Unsupported callbacks that may be provided by the implementation.
*
* <p>
* <strong>Note:</strong>Clients should <strong>never</strong> rely on this callback to be
* called and/or to have a defined behavior, as it is entirely implementation-defined and not
* supported.
*
* <p> This can be used by implementations to add extra callbacks, for testing or experimental
* purposes.
*
* @param callbackName Name of the extra callback.
* @param args Arguments for the calback
*/
public void extraCallback(String callbackName, Bundle args) {}
/**
* Called when {@link CustomTabsSession} has requested a postMessage channel through
* {@link CustomTabsService#requestPostMessageChannel(
* CustomTabsSessionToken, android.net.Uri)} and the channel
* is ready for sending and receiving messages on both ends.
*
* @param extras Reserved for future use.
*/
public void onMessageChannelReady(Bundle extras) {}
/**
* Called when a tab controlled by this {@link 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.
*
* @param message The message sent.
* @param extras Reserved for future use.
*/
public void onPostMessage(String message, Bundle extras) {}
}
|
