[go: nahoru, domu]
Google Git
Sign in
android / platform / frameworks / support / d87afe7bd6dde2299603313bc1c843337e0af308 / . / navigation / navigation-common / api / restricted_current.txt
blob: 896ad41e533c64570a5617346a696f499922e8d8 [file] [log] [blame]
Aurimas Liutikas3aa5a202020-10-05 09:42:14 -0700[diff] [blame]1// Signature format: 4.0
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]2package androidx.navigation {
3
4 public final class ActionOnlyNavDirections implements androidx.navigation.NavDirections {
5 ctor public ActionOnlyNavDirections(int);
6 method public int getActionId();
7 method public android.os.Bundle getArguments();
8 }
9
10 public interface FloatingWindow {
11 }
12
13 public final class NavAction {
Jeremy Woods71e5fe52021-01-21 12:15:01 -0800[diff] [blame]14 ctor public NavAction(@IdRes int destinationId, optional androidx.navigation.NavOptions? navOptions, optional android.os.Bundle? defaultArguments);
15 ctor public NavAction(@IdRes int destinationId, optional androidx.navigation.NavOptions? navOptions);
16 ctor public NavAction(@IdRes int destinationId);
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]17 method public android.os.Bundle? getDefaultArguments();
18 method public int getDestinationId();
19 method public androidx.navigation.NavOptions? getNavOptions();
Jeremy Woods71e5fe52021-01-21 12:15:01 -0800[diff] [blame]20 method public void setDefaultArguments(android.os.Bundle? p);
21 method public void setNavOptions(androidx.navigation.NavOptions? p);
22 property public final android.os.Bundle? defaultArguments;
23 property public final int destinationId;
24 property public final androidx.navigation.NavOptions? navOptions;
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]25 }
26
27 public interface NavArgs {
28 }
29
30 public final class NavArgument {
31 method public Object? getDefaultValue();
Jeremy Woodsc96f0862021-02-27 01:40:50 -0800[diff] [blame]32 method public androidx.navigation.NavType<java.lang.Object> getType();
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]33 method public boolean isDefaultValuePresent();
34 method public boolean isNullable();
Jeremy Woodsc96f0862021-02-27 01:40:50 -0800[diff] [blame]35 property public final Object? defaultValue;
36 property public final boolean isDefaultValuePresent;
37 property public final boolean isNullable;
38 property public final androidx.navigation.NavType<java.lang.Object> type;
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]39 }
40
41 public static final class NavArgument.Builder {
42 ctor public NavArgument.Builder();
43 method public androidx.navigation.NavArgument build();
Jeremy Woodsc96f0862021-02-27 01:40:50 -0800[diff] [blame]44 method public androidx.navigation.NavArgument.Builder setDefaultValue(Object? defaultValue);
45 method public androidx.navigation.NavArgument.Builder setIsNullable(boolean isNullable);
46 method public <T> androidx.navigation.NavArgument.Builder setType(androidx.navigation.NavType<T> type);
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]47 }
48
Jeremy Woods1b403fb2020-04-06 17:56:22 -0700[diff] [blame]49 public final class NavDeepLink {
50 method public String? getAction();
51 method public String? getMimeType();
Jeremy Woods23c2ef92020-04-21 08:58:11 -0700[diff] [blame]52 method public String? getUriPattern();
Jeremy Woods125c6fc2021-01-07 18:38:12 -0800[diff] [blame]53 property public final String? action;
54 property public final String? mimeType;
55 property public final String? uriPattern;
Jeremy Woods1b403fb2020-04-06 17:56:22 -0700[diff] [blame]56 }
57
58 public static final class NavDeepLink.Builder {
59 method public androidx.navigation.NavDeepLink build();
Jeremy Woods125c6fc2021-01-07 18:38:12 -0800[diff] [blame]60 method public static androidx.navigation.NavDeepLink.Builder fromAction(String action);
61 method public static androidx.navigation.NavDeepLink.Builder fromMimeType(String mimeType);
62 method public static androidx.navigation.NavDeepLink.Builder fromUriPattern(String uriPattern);
63 method public androidx.navigation.NavDeepLink.Builder setAction(String action);
64 method public androidx.navigation.NavDeepLink.Builder setMimeType(String mimeType);
65 method public androidx.navigation.NavDeepLink.Builder setUriPattern(String uriPattern);
Jeremy Woods1b403fb2020-04-06 17:56:22 -0700[diff] [blame]66 }
67
68 public class NavDeepLinkRequest {
69 method public String? getAction();
70 method public String? getMimeType();
71 method public android.net.Uri? getUri();
Jeremy Woods444c6cf2021-01-07 22:38:44 -0800[diff] [blame]72 property public String? action;
73 property public String? mimeType;
74 property public android.net.Uri? uri;
Jeremy Woods1b403fb2020-04-06 17:56:22 -0700[diff] [blame]75 }
76
77 public static final class NavDeepLinkRequest.Builder {
78 method public androidx.navigation.NavDeepLinkRequest build();
Jeremy Woods444c6cf2021-01-07 22:38:44 -0800[diff] [blame]79 method public static androidx.navigation.NavDeepLinkRequest.Builder fromAction(String action);
80 method public static androidx.navigation.NavDeepLinkRequest.Builder fromMimeType(String mimeType);
81 method public static androidx.navigation.NavDeepLinkRequest.Builder fromUri(android.net.Uri uri);
82 method public androidx.navigation.NavDeepLinkRequest.Builder setAction(String action);
83 method public androidx.navigation.NavDeepLinkRequest.Builder setMimeType(String mimeType);
84 method public androidx.navigation.NavDeepLinkRequest.Builder setUri(android.net.Uri uri);
85 field public static final androidx.navigation.NavDeepLinkRequest.Builder.Companion Companion;
86 }
87
88 public static final class NavDeepLinkRequest.Builder.Companion {
89 method public androidx.navigation.NavDeepLinkRequest.Builder fromAction(String action);
90 method public androidx.navigation.NavDeepLinkRequest.Builder fromMimeType(String mimeType);
91 method public androidx.navigation.NavDeepLinkRequest.Builder fromUri(android.net.Uri uri);
Jeremy Woods1b403fb2020-04-06 17:56:22 -0700[diff] [blame]92 }
93
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]94 public class NavDestination {
Jeremy Woods468f4f82021-02-27 01:47:53 -0800[diff] [blame]95 ctor public NavDestination(String navigatorName);
96 ctor public NavDestination(androidx.navigation.Navigator<? extends androidx.navigation.NavDestination> navigator);
97 method public final void addArgument(String argumentName, androidx.navigation.NavArgument argument);
98 method public final void addDeepLink(String uriPattern);
99 method public final void addDeepLink(androidx.navigation.NavDeepLink navDeepLink);
100 method public final androidx.navigation.NavAction? getAction(@IdRes int id);
101 method public final java.util.Map<java.lang.String,androidx.navigation.NavArgument> getArguments();
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]102 method @IdRes public final int getId();
103 method public final CharSequence? getLabel();
104 method public final String getNavigatorName();
105 method public final androidx.navigation.NavGraph? getParent();
Jeremy Woods468f4f82021-02-27 01:47:53 -0800[diff] [blame]106 method public boolean hasDeepLink(android.net.Uri deepLink);
107 method public boolean hasDeepLink(androidx.navigation.NavDeepLinkRequest deepLinkRequest);
108 method @CallSuper public void onInflate(android.content.Context context, android.util.AttributeSet attrs);
109 method protected static final <C> Class<? extends C> parseClassFromName(android.content.Context context, String name, Class<? extends C> expectedClassType);
110 method public final void putAction(@IdRes int actionId, @IdRes int destId);
111 method public final void putAction(@IdRes int actionId, androidx.navigation.NavAction action);
112 method public final void removeAction(@IdRes int actionId);
113 method public final void removeArgument(String argumentName);
114 method public final void setId(int id);
115 method public final void setLabel(CharSequence? p);
116 property public final java.util.Map<java.lang.String,androidx.navigation.NavArgument> arguments;
117 property @IdRes public final int id;
118 property public final CharSequence? label;
119 property public final String navigatorName;
120 property public final androidx.navigation.NavGraph? parent;
121 field public static final androidx.navigation.NavDestination.Companion Companion;
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]122 }
123
Jeremy Woods468f4f82021-02-27 01:47:53 -0800[diff] [blame]124 @kotlin.annotation.Retention(kotlin.annotation.AnnotationRetention) @kotlin.annotation.Target(allowedTargets={kotlin.annotation.AnnotationTarget, kotlin.annotation.AnnotationTarget}) public static @interface NavDestination.ClassType {
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]125 method public abstract Class<?> value();
Jeremy Woods468f4f82021-02-27 01:47:53 -0800[diff] [blame]126 property public abstract Class<?> value;
127 }
128
129 public static final class NavDestination.Companion {
130 method protected <C> Class<? extends C> parseClassFromName(android.content.Context context, String name, Class<? extends C> expectedClassType);
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]131 }
132
133 public interface NavDirections {
134 method @IdRes public int getActionId();
135 method public android.os.Bundle getArguments();
Jeremy Woodsd87afe72020-12-17 12:36:35 -0800[diff] [blame^]136 property @IdRes public abstract int actionId;
137 property public abstract android.os.Bundle arguments;
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]138 }
139
Jeremy Woods90988812021-02-27 01:55:41 -0800[diff] [blame]140 public class NavGraph extends androidx.navigation.NavDestination implements java.lang.Iterable<androidx.navigation.NavDestination> kotlin.jvm.internal.markers.KMappedMarker {
141 ctor public NavGraph(androidx.navigation.Navigator<? extends androidx.navigation.NavGraph> navGraphNavigator);
142 method public final void addAll(androidx.navigation.NavGraph other);
143 method public final void addDestination(androidx.navigation.NavDestination node);
144 method public final void addDestinations(java.util.Collection<? extends androidx.navigation.NavDestination> nodes);
145 method public final void addDestinations(androidx.navigation.NavDestination... nodes);
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]146 method public final void clear();
Jeremy Woods90988812021-02-27 01:55:41 -0800[diff] [blame]147 method public final androidx.navigation.NavDestination? findNode(@IdRes int resid);
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]148 method @IdRes public final int getStartDestination();
Jeremy Woods90988812021-02-27 01:55:41 -0800[diff] [blame]149 method public final java.util.Iterator<androidx.navigation.NavDestination> iterator();
150 method public final void remove(androidx.navigation.NavDestination node);
151 method public final void setStartDestination(int startDestId);
152 property @IdRes public final int startDestination;
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]153 }
154
155 @androidx.navigation.Navigator.Name("navigation") public class NavGraphNavigator extends androidx.navigation.Navigator<androidx.navigation.NavGraph> {
Jeremy Woods3d3603892021-01-21 13:26:47 -0800[diff] [blame]156 ctor public NavGraphNavigator(androidx.navigation.NavigatorProvider navigatorProvider);
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]157 method public androidx.navigation.NavGraph createDestination();
Jeremy Woods3d3603892021-01-21 13:26:47 -0800[diff] [blame]158 method public androidx.navigation.NavDestination? navigate(androidx.navigation.NavGraph destination, android.os.Bundle? args, androidx.navigation.NavOptions? navOptions, androidx.navigation.Navigator.Extras? navigatorExtras);
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]159 method public boolean popBackStack();
160 }
161
162 public final class NavOptions {
163 method @AnimRes @AnimatorRes public int getEnterAnim();
164 method @AnimRes @AnimatorRes public int getExitAnim();
165 method @AnimRes @AnimatorRes public int getPopEnterAnim();
166 method @AnimRes @AnimatorRes public int getPopExitAnim();
167 method @IdRes public int getPopUpTo();
168 method public boolean isPopUpToInclusive();
169 method public boolean shouldLaunchSingleTop();
Jeremy Woods3f759462021-01-21 14:28:05 -0800[diff] [blame]170 property @AnimRes @AnimatorRes public final int enterAnim;
171 property @AnimRes @AnimatorRes public final int exitAnim;
172 property @AnimRes @AnimatorRes public final int popEnterAnim;
173 property @AnimRes @AnimatorRes public final int popExitAnim;
174 property @IdRes public final int popUpTo;
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]175 }
176
177 public static final class NavOptions.Builder {
178 ctor public NavOptions.Builder();
179 method public androidx.navigation.NavOptions build();
Jeremy Woods3f759462021-01-21 14:28:05 -0800[diff] [blame]180 method public androidx.navigation.NavOptions.Builder setEnterAnim(@AnimRes @AnimatorRes int enterAnim);
181 method public androidx.navigation.NavOptions.Builder setExitAnim(@AnimRes @AnimatorRes int exitAnim);
182 method public androidx.navigation.NavOptions.Builder setLaunchSingleTop(boolean singleTop);
183 method public androidx.navigation.NavOptions.Builder setPopEnterAnim(@AnimRes @AnimatorRes int popEnterAnim);
184 method public androidx.navigation.NavOptions.Builder setPopExitAnim(@AnimRes @AnimatorRes int popExitAnim);
185 method public androidx.navigation.NavOptions.Builder setPopUpTo(@IdRes int destinationId, boolean inclusive);
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]186 }
187
188 public abstract class NavType<T> {
Jeremy Woods8f576172021-01-11 09:19:27 -0800[diff] [blame]189 method public static androidx.navigation.NavType<?> fromArgType(String? type, String? packageName);
190 method public abstract operator T? get(android.os.Bundle bundle, String key);
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]191 method public abstract String getName();
192 method public boolean isNullableAllowed();
Jeremy Woods8f576172021-01-11 09:19:27 -0800[diff] [blame]193 method public abstract T! parseValue(String value);
194 method public abstract void put(android.os.Bundle bundle, String key, T? value);
195 property public boolean isNullableAllowed;
196 property public abstract String name;
197 field public static final androidx.navigation.NavType<boolean[]> BoolArrayType;
198 field public static final androidx.navigation.NavType<java.lang.Boolean> BoolType;
199 field public static final androidx.navigation.NavType.Companion Companion;
200 field public static final androidx.navigation.NavType<float[]> FloatArrayType;
201 field public static final androidx.navigation.NavType<java.lang.Float> FloatType;
202 field public static final androidx.navigation.NavType<int[]> IntArrayType;
203 field public static final androidx.navigation.NavType<java.lang.Integer> IntType;
204 field public static final androidx.navigation.NavType<long[]> LongArrayType;
205 field public static final androidx.navigation.NavType<java.lang.Long> LongType;
206 field public static final androidx.navigation.NavType<java.lang.Integer> ReferenceType;
207 field public static final androidx.navigation.NavType<java.lang.String[]> StringArrayType;
208 field public static final androidx.navigation.NavType<java.lang.String> StringType;
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]209 }
210
Jeremy Woods8f576172021-01-11 09:19:27 -0800[diff] [blame]211 public static final class NavType.Companion {
212 method public androidx.navigation.NavType<?> fromArgType(String? type, String? packageName);
213 }
214
215 public static final class NavType.EnumType<D extends java.lang.Enum<?>> extends androidx.navigation.NavType.SerializableType<D> {
216 ctor public NavType.EnumType(Class<D> type);
217 property public String name;
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]218 }
219
220 public static final class NavType.ParcelableArrayType<D extends android.os.Parcelable> extends androidx.navigation.NavType<D[]> {
Jeremy Woods8f576172021-01-11 09:19:27 -0800[diff] [blame]221 ctor public NavType.ParcelableArrayType(Class<D> type);
222 method public D![]? get(android.os.Bundle bundle, String key);
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]223 method public String getName();
Jeremy Woods8f576172021-01-11 09:19:27 -0800[diff] [blame]224 method public D![] parseValue(String value);
225 method public void put(android.os.Bundle bundle, String key, D![]? value);
226 property public String name;
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]227 }
228
229 public static final class NavType.ParcelableType<D> extends androidx.navigation.NavType<D> {
Jeremy Woods8f576172021-01-11 09:19:27 -0800[diff] [blame]230 ctor public NavType.ParcelableType(Class<D> type);
231 method public D? get(android.os.Bundle bundle, String key);
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]232 method public String getName();
Jeremy Woods8f576172021-01-11 09:19:27 -0800[diff] [blame]233 method public D! parseValue(String value);
234 method public void put(android.os.Bundle bundle, String key, D? value);
235 property public String name;
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]236 }
237
238 public static final class NavType.SerializableArrayType<D extends java.io.Serializable> extends androidx.navigation.NavType<D[]> {
Jeremy Woods8f576172021-01-11 09:19:27 -0800[diff] [blame]239 ctor public NavType.SerializableArrayType(Class<D> type);
240 method public D![]? get(android.os.Bundle bundle, String key);
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]241 method public String getName();
Jeremy Woods8f576172021-01-11 09:19:27 -0800[diff] [blame]242 method public D![] parseValue(String value);
243 method public void put(android.os.Bundle bundle, String key, D![]? value);
244 property public String name;
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]245 }
246
247 public static class NavType.SerializableType<D extends java.io.Serializable> extends androidx.navigation.NavType<D> {
Jeremy Woods8f576172021-01-11 09:19:27 -0800[diff] [blame]248 ctor public NavType.SerializableType(Class<D> type);
249 method public D? get(android.os.Bundle bundle, String key);
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]250 method public String getName();
Jeremy Woods8f576172021-01-11 09:19:27 -0800[diff] [blame]251 method public D parseValue(String value);
252 method public void put(android.os.Bundle bundle, String key, D value);
253 property public String name;
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]254 }
255
256 public abstract class Navigator<D extends androidx.navigation.NavDestination> {
257 ctor public Navigator();
258 method public abstract D createDestination();
Jeremy Woods0660bae2021-01-21 13:40:09 -0800[diff] [blame]259 method public abstract androidx.navigation.NavDestination? navigate(D destination, android.os.Bundle? args, androidx.navigation.NavOptions? navOptions, androidx.navigation.Navigator.Extras? navigatorExtras);
260 method public void onRestoreState(android.os.Bundle savedState);
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]261 method public android.os.Bundle? onSaveState();
262 method public abstract boolean popBackStack();
263 }
264
265 public static interface Navigator.Extras {
266 }
267
Jeremy Woods0660bae2021-01-21 13:40:09 -0800[diff] [blame]268 @kotlin.annotation.Retention(kotlin.annotation.AnnotationRetention) @kotlin.annotation.Target(allowedTargets={kotlin.annotation.AnnotationTarget, kotlin.annotation.AnnotationTarget}) public static @interface Navigator.Name {
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]269 method public abstract String value();
Jeremy Woods0660bae2021-01-21 13:40:09 -0800[diff] [blame]270 property public abstract String value;
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]271 }
272
273 public class NavigatorProvider {
274 ctor public NavigatorProvider();
Jeremy Woods6eef0822021-01-21 14:17:34 -0800[diff] [blame]275 method public final androidx.navigation.Navigator<? extends androidx.navigation.NavDestination>? addNavigator(androidx.navigation.Navigator<? extends androidx.navigation.NavDestination> navigator);
276 method @CallSuper public androidx.navigation.Navigator<? extends androidx.navigation.NavDestination>? addNavigator(String name, androidx.navigation.Navigator<? extends androidx.navigation.NavDestination> navigator);
277 method public final <T extends androidx.navigation.Navigator<?>> T getNavigator(Class<T> navigatorClass);
278 method @CallSuper public <T extends androidx.navigation.Navigator<?>> T getNavigator(String name);
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]279 }
280
281}
282