[go: nahoru, domu]
Google Git
Sign in
android / platform / frameworks / support / df16e2452d8333af236a9e5203b396b98f1056be / . / navigation / navigation-common / api / restricted_current.txt
blob: d136e44f5affdf38db923e0fa3c6256af63722c4 [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 {
Jeremy Woods9b91a842020-12-17 12:58:47 -0800[diff] [blame]5 ctor public ActionOnlyNavDirections(int actionId);
6 method public int component1();
7 method public androidx.navigation.ActionOnlyNavDirections copy(int actionId);
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]8 method public int getActionId();
9 method public android.os.Bundle getArguments();
Jeremy Woods9b91a842020-12-17 12:58:47 -0800[diff] [blame]10 property public int actionId;
11 property public android.os.Bundle arguments;
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]12 }
13
Jeremy Woods69c7fbc2021-04-01 17:36:53 -0700[diff] [blame]14 @androidx.navigation.NavOptionsDsl public final class AnimBuilder {
15 ctor public AnimBuilder();
16 method public int getEnter();
17 method public int getExit();
18 method public int getPopEnter();
19 method public int getPopExit();
20 method public void setEnter(int p);
21 method public void setExit(int p);
22 method public void setPopEnter(int p);
23 method public void setPopExit(int p);
24 property public final int enter;
25 property public final int exit;
26 property public final int popEnter;
27 property public final int popExit;
28 }
29
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]30 public interface FloatingWindow {
31 }
32
33 public final class NavAction {
Jeremy Woods71e5fe52021-01-21 12:15:01 -0800[diff] [blame]34 ctor public NavAction(@IdRes int destinationId, optional androidx.navigation.NavOptions? navOptions, optional android.os.Bundle? defaultArguments);
35 ctor public NavAction(@IdRes int destinationId, optional androidx.navigation.NavOptions? navOptions);
36 ctor public NavAction(@IdRes int destinationId);
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]37 method public android.os.Bundle? getDefaultArguments();
38 method public int getDestinationId();
39 method public androidx.navigation.NavOptions? getNavOptions();
Jeremy Woods71e5fe52021-01-21 12:15:01 -0800[diff] [blame]40 method public void setDefaultArguments(android.os.Bundle? p);
41 method public void setNavOptions(androidx.navigation.NavOptions? p);
42 property public final android.os.Bundle? defaultArguments;
43 property public final int destinationId;
44 property public final androidx.navigation.NavOptions? navOptions;
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]45 }
46
Jeremy Woods69c7fbc2021-04-01 17:36:53 -0700[diff] [blame]47 @androidx.navigation.NavDestinationDsl public final class NavActionBuilder {
48 ctor public NavActionBuilder();
49 method public java.util.Map<java.lang.String,java.lang.Object> getDefaultArguments();
50 method public int getDestinationId();
51 method public void navOptions(kotlin.jvm.functions.Function1<? super androidx.navigation.NavOptionsBuilder,kotlin.Unit> optionsBuilder);
52 method public void setDestinationId(int p);
53 property public final java.util.Map<java.lang.String,java.lang.Object> defaultArguments;
54 property public final int destinationId;
55 }
56
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]57 public interface NavArgs {
58 }
59
Jeremy Woods69c7fbc2021-04-01 17:36:53 -0700[diff] [blame]60 public final class NavArgsLazy<Args extends androidx.navigation.NavArgs> implements kotlin.Lazy<Args> {
61 ctor public NavArgsLazy(kotlin.reflect.KClass<Args> navArgsClass, kotlin.jvm.functions.Function0<android.os.Bundle> argumentProducer);
62 method public Args getValue();
63 method public boolean isInitialized();
64 property public Args value;
65 }
66
67 public final class NavArgsLazyKt {
68 }
69
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]70 public final class NavArgument {
71 method public Object? getDefaultValue();
Jeremy Woodsc96f0862021-02-27 01:40:50 -0800[diff] [blame]72 method public androidx.navigation.NavType<java.lang.Object> getType();
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]73 method public boolean isDefaultValuePresent();
74 method public boolean isNullable();
Jeremy Woodsc96f0862021-02-27 01:40:50 -0800[diff] [blame]75 property public final Object? defaultValue;
76 property public final boolean isDefaultValuePresent;
77 property public final boolean isNullable;
78 property public final androidx.navigation.NavType<java.lang.Object> type;
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]79 }
80
81 public static final class NavArgument.Builder {
82 ctor public NavArgument.Builder();
83 method public androidx.navigation.NavArgument build();
Jeremy Woodsc96f0862021-02-27 01:40:50 -0800[diff] [blame]84 method public androidx.navigation.NavArgument.Builder setDefaultValue(Object? defaultValue);
85 method public androidx.navigation.NavArgument.Builder setIsNullable(boolean isNullable);
86 method public <T> androidx.navigation.NavArgument.Builder setType(androidx.navigation.NavType<T> type);
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]87 }
88
Jeremy Woods69c7fbc2021-04-01 17:36:53 -0700[diff] [blame]89 @androidx.navigation.NavDestinationDsl public final class NavArgumentBuilder {
90 ctor public NavArgumentBuilder();
91 method public androidx.navigation.NavArgument build();
92 method public Object? getDefaultValue();
93 method public boolean getNullable();
94 method public androidx.navigation.NavType<?> getType();
95 method public void setDefaultValue(Object? value);
96 method public void setNullable(boolean value);
97 method public void setType(androidx.navigation.NavType<?> value);
98 property public final Object? defaultValue;
99 property public final boolean nullable;
100 property public final androidx.navigation.NavType<?> type;
101 }
102
Ian Lakef57cd372021-04-21 15:52:15 -0700[diff] [blame]103 public final class NavBackStackEntry implements androidx.lifecycle.HasDefaultViewModelProviderFactory androidx.lifecycle.LifecycleOwner androidx.savedstate.SavedStateRegistryOwner androidx.lifecycle.ViewModelStoreOwner {
104 method public android.os.Bundle? getArguments();
105 method public androidx.lifecycle.ViewModelProvider.Factory getDefaultViewModelProviderFactory();
106 method public androidx.navigation.NavDestination getDestination();
107 method public androidx.lifecycle.Lifecycle getLifecycle();
108 method public androidx.lifecycle.SavedStateHandle getSavedStateHandle();
109 method public androidx.savedstate.SavedStateRegistry getSavedStateRegistry();
110 method public androidx.lifecycle.ViewModelStore getViewModelStore();
111 property public final android.os.Bundle? arguments;
112 property public final androidx.navigation.NavDestination destination;
113 property public final androidx.lifecycle.SavedStateHandle savedStateHandle;
114 }
115
Jeremy Woods1b403fb2020-04-06 17:56:22 -0700[diff] [blame]116 public final class NavDeepLink {
117 method public String? getAction();
118 method public String? getMimeType();
Jeremy Woods23c2ef92020-04-21 08:58:11 -0700[diff] [blame]119 method public String? getUriPattern();
Jeremy Woods125c6fc2021-01-07 18:38:12 -0800[diff] [blame]120 property public final String? action;
121 property public final String? mimeType;
122 property public final String? uriPattern;
Jeremy Woods1b403fb2020-04-06 17:56:22 -0700[diff] [blame]123 }
124
125 public static final class NavDeepLink.Builder {
126 method public androidx.navigation.NavDeepLink build();
Jeremy Woods125c6fc2021-01-07 18:38:12 -0800[diff] [blame]127 method public static androidx.navigation.NavDeepLink.Builder fromAction(String action);
128 method public static androidx.navigation.NavDeepLink.Builder fromMimeType(String mimeType);
129 method public static androidx.navigation.NavDeepLink.Builder fromUriPattern(String uriPattern);
130 method public androidx.navigation.NavDeepLink.Builder setAction(String action);
131 method public androidx.navigation.NavDeepLink.Builder setMimeType(String mimeType);
132 method public androidx.navigation.NavDeepLink.Builder setUriPattern(String uriPattern);
Jeremy Woods1b403fb2020-04-06 17:56:22 -0700[diff] [blame]133 }
134
Jeremy Woods69c7fbc2021-04-01 17:36:53 -0700[diff] [blame]135 @kotlin.DslMarker public @interface NavDeepLinkDsl {
136 }
137
138 @androidx.navigation.NavDeepLinkDsl public final class NavDeepLinkDslBuilder {
139 ctor public NavDeepLinkDslBuilder();
140 method public String? getAction();
141 method public String? getMimeType();
142 method public String? getUriPattern();
143 method public void setAction(String? p);
144 method public void setMimeType(String? p);
145 method public void setUriPattern(String? p);
146 property public final String? action;
147 property public final String? mimeType;
148 property public final String? uriPattern;
149 }
150
151 public final class NavDeepLinkDslBuilderKt {
152 method public static androidx.navigation.NavDeepLink navDeepLink(kotlin.jvm.functions.Function1<? super androidx.navigation.NavDeepLinkDslBuilder,kotlin.Unit> deepLinkBuilder);
153 }
154
Jeremy Woods1b403fb2020-04-06 17:56:22 -0700[diff] [blame]155 public class NavDeepLinkRequest {
156 method public String? getAction();
157 method public String? getMimeType();
158 method public android.net.Uri? getUri();
Jeremy Woods444c6cf2021-01-07 22:38:44 -0800[diff] [blame]159 property public String? action;
160 property public String? mimeType;
161 property public android.net.Uri? uri;
Jeremy Woods1b403fb2020-04-06 17:56:22 -0700[diff] [blame]162 }
163
164 public static final class NavDeepLinkRequest.Builder {
165 method public androidx.navigation.NavDeepLinkRequest build();
Jeremy Woods444c6cf2021-01-07 22:38:44 -0800[diff] [blame]166 method public static androidx.navigation.NavDeepLinkRequest.Builder fromAction(String action);
167 method public static androidx.navigation.NavDeepLinkRequest.Builder fromMimeType(String mimeType);
168 method public static androidx.navigation.NavDeepLinkRequest.Builder fromUri(android.net.Uri uri);
169 method public androidx.navigation.NavDeepLinkRequest.Builder setAction(String action);
170 method public androidx.navigation.NavDeepLinkRequest.Builder setMimeType(String mimeType);
171 method public androidx.navigation.NavDeepLinkRequest.Builder setUri(android.net.Uri uri);
172 field public static final androidx.navigation.NavDeepLinkRequest.Builder.Companion Companion;
173 }
174
175 public static final class NavDeepLinkRequest.Builder.Companion {
176 method public androidx.navigation.NavDeepLinkRequest.Builder fromAction(String action);
177 method public androidx.navigation.NavDeepLinkRequest.Builder fromMimeType(String mimeType);
178 method public androidx.navigation.NavDeepLinkRequest.Builder fromUri(android.net.Uri uri);
Jeremy Woods1b403fb2020-04-06 17:56:22 -0700[diff] [blame]179 }
180
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]181 public class NavDestination {
Jeremy Woods468f4f82021-02-27 01:47:53 -0800[diff] [blame]182 ctor public NavDestination(String navigatorName);
183 ctor public NavDestination(androidx.navigation.Navigator<? extends androidx.navigation.NavDestination> navigator);
184 method public final void addArgument(String argumentName, androidx.navigation.NavArgument argument);
185 method public final void addDeepLink(String uriPattern);
186 method public final void addDeepLink(androidx.navigation.NavDeepLink navDeepLink);
187 method public final androidx.navigation.NavAction? getAction(@IdRes int id);
188 method public final java.util.Map<java.lang.String,androidx.navigation.NavArgument> getArguments();
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]189 method @IdRes public final int getId();
190 method public final CharSequence? getLabel();
191 method public final String getNavigatorName();
192 method public final androidx.navigation.NavGraph? getParent();
Jeremy Woods51769b72021-03-31 10:59:25 -0700[diff] [blame]193 method public final String? getRoute();
Jeremy Woods468f4f82021-02-27 01:47:53 -0800[diff] [blame]194 method public boolean hasDeepLink(android.net.Uri deepLink);
195 method public boolean hasDeepLink(androidx.navigation.NavDeepLinkRequest deepLinkRequest);
196 method @CallSuper public void onInflate(android.content.Context context, android.util.AttributeSet attrs);
197 method protected static final <C> Class<? extends C> parseClassFromName(android.content.Context context, String name, Class<? extends C> expectedClassType);
198 method public final void putAction(@IdRes int actionId, @IdRes int destId);
199 method public final void putAction(@IdRes int actionId, androidx.navigation.NavAction action);
200 method public final void removeAction(@IdRes int actionId);
201 method public final void removeArgument(String argumentName);
202 method public final void setId(int id);
203 method public final void setLabel(CharSequence? p);
Jeremy Woods51769b72021-03-31 10:59:25 -0700[diff] [blame]204 method public final void setRoute(String? route);
Jeremy Woods468f4f82021-02-27 01:47:53 -0800[diff] [blame]205 property public final java.util.Map<java.lang.String,androidx.navigation.NavArgument> arguments;
206 property @IdRes public final int id;
207 property public final CharSequence? label;
208 property public final String navigatorName;
209 property public final androidx.navigation.NavGraph? parent;
Jeremy Woods51769b72021-03-31 10:59:25 -0700[diff] [blame]210 property public final String? route;
Jeremy Woods468f4f82021-02-27 01:47:53 -0800[diff] [blame]211 field public static final androidx.navigation.NavDestination.Companion Companion;
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]212 }
213
Jeremy Woods468f4f82021-02-27 01:47:53 -0800[diff] [blame]214 @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]215 method public abstract Class<?> value();
Jeremy Woods468f4f82021-02-27 01:47:53 -0800[diff] [blame]216 property public abstract Class<?> value;
217 }
218
219 public static final class NavDestination.Companion {
220 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]221 }
222
Jeremy Woods69c7fbc2021-04-01 17:36:53 -0700[diff] [blame]223 @androidx.navigation.NavDestinationDsl public class NavDestinationBuilder<D extends androidx.navigation.NavDestination> {
224 ctor public NavDestinationBuilder(androidx.navigation.Navigator<? extends D> navigator, @IdRes int id);
Jeremy Woodsdf16e242021-04-05 17:19:54 -0700[diff] [blame^]225 ctor public NavDestinationBuilder(androidx.navigation.Navigator<? extends D> navigator, String route);
Jeremy Woods69c7fbc2021-04-01 17:36:53 -0700[diff] [blame]226 method public final void action(int actionId, kotlin.jvm.functions.Function1<? super androidx.navigation.NavActionBuilder,kotlin.Unit> actionBuilder);
227 method public final void argument(String name, kotlin.jvm.functions.Function1<? super androidx.navigation.NavArgumentBuilder,kotlin.Unit> argumentBuilder);
228 method public D build();
229 method public final void deepLink(String uriPattern);
230 method public final void deepLink(kotlin.jvm.functions.Function1<? super androidx.navigation.NavDeepLinkDslBuilder,kotlin.Unit> navDeepLink);
231 method public final int getId();
232 method public final CharSequence? getLabel();
233 method protected final androidx.navigation.Navigator<? extends D> getNavigator();
Jeremy Woodsdf16e242021-04-05 17:19:54 -0700[diff] [blame^]234 method public final String? getRoute();
Jeremy Woods69c7fbc2021-04-01 17:36:53 -0700[diff] [blame]235 method public final void setLabel(CharSequence? p);
236 property public final int id;
237 property public final CharSequence? label;
238 property protected final androidx.navigation.Navigator<? extends D> navigator;
Jeremy Woodsdf16e242021-04-05 17:19:54 -0700[diff] [blame^]239 property public final String? route;
Jeremy Woods69c7fbc2021-04-01 17:36:53 -0700[diff] [blame]240 }
241
242 @kotlin.DslMarker public @interface NavDestinationDsl {
243 }
244
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]245 public interface NavDirections {
246 method @IdRes public int getActionId();
247 method public android.os.Bundle getArguments();
Jeremy Woodsd87afe72020-12-17 12:36:35 -0800[diff] [blame]248 property @IdRes public abstract int actionId;
249 property public abstract android.os.Bundle arguments;
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]250 }
251
Jeremy Woods90988812021-02-27 01:55:41 -0800[diff] [blame]252 public class NavGraph extends androidx.navigation.NavDestination implements java.lang.Iterable<androidx.navigation.NavDestination> kotlin.jvm.internal.markers.KMappedMarker {
253 ctor public NavGraph(androidx.navigation.Navigator<? extends androidx.navigation.NavGraph> navGraphNavigator);
254 method public final void addAll(androidx.navigation.NavGraph other);
255 method public final void addDestination(androidx.navigation.NavDestination node);
256 method public final void addDestinations(java.util.Collection<? extends androidx.navigation.NavDestination> nodes);
257 method public final void addDestinations(androidx.navigation.NavDestination... nodes);
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]258 method public final void clear();
Jeremy Woods90988812021-02-27 01:55:41 -0800[diff] [blame]259 method public final androidx.navigation.NavDestination? findNode(@IdRes int resid);
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]260 method @IdRes public final int getStartDestination();
Jeremy Woods90988812021-02-27 01:55:41 -0800[diff] [blame]261 method public final java.util.Iterator<androidx.navigation.NavDestination> iterator();
262 method public final void remove(androidx.navigation.NavDestination node);
263 method public final void setStartDestination(int startDestId);
264 property @IdRes public final int startDestination;
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]265 }
266
Jeremy Woods69c7fbc2021-04-01 17:36:53 -0700[diff] [blame]267 @androidx.navigation.NavDestinationDsl public class NavGraphBuilder extends androidx.navigation.NavDestinationBuilder<androidx.navigation.NavGraph> {
268 ctor public NavGraphBuilder(androidx.navigation.NavigatorProvider provider, @IdRes int id, @IdRes int startDestination);
269 method public final void addDestination(androidx.navigation.NavDestination destination);
270 method public androidx.navigation.NavGraph build();
271 method public final <D extends androidx.navigation.NavDestination> void destination(androidx.navigation.NavDestinationBuilder<? extends D> navDestination);
272 method public final androidx.navigation.NavigatorProvider getProvider();
273 method public final operator void unaryPlus(androidx.navigation.NavDestination);
274 property public final androidx.navigation.NavigatorProvider provider;
275 }
276
277 public final class NavGraphBuilderKt {
278 method public static inline androidx.navigation.NavGraph navigation(androidx.navigation.NavigatorProvider, optional @IdRes int id, @IdRes int startDestination, kotlin.jvm.functions.Function1<? super androidx.navigation.NavGraphBuilder,kotlin.Unit> builder);
279 method public static inline void navigation(androidx.navigation.NavGraphBuilder, @IdRes int id, @IdRes int startDestination, kotlin.jvm.functions.Function1<? super androidx.navigation.NavGraphBuilder,kotlin.Unit> builder);
280 }
281
Aurimas Liutikas38fff362021-04-01 15:43:54 -0700[diff] [blame]282 public final class NavGraphKt {
283 method public static operator boolean contains(androidx.navigation.NavGraph, @IdRes int id);
284 method public static inline operator androidx.navigation.NavDestination get(androidx.navigation.NavGraph, @IdRes int id);
285 method public static inline operator void minusAssign(androidx.navigation.NavGraph, androidx.navigation.NavDestination node);
286 method public static inline operator void plusAssign(androidx.navigation.NavGraph, androidx.navigation.NavDestination node);
287 method public static inline operator void plusAssign(androidx.navigation.NavGraph, androidx.navigation.NavGraph other);
288 }
289
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]290 @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]291 ctor public NavGraphNavigator(androidx.navigation.NavigatorProvider navigatorProvider);
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]292 method public androidx.navigation.NavGraph createDestination();
Jeremy Woods3d3603892021-01-21 13:26:47 -0800[diff] [blame]293 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]294 }
295
296 public final class NavOptions {
297 method @AnimRes @AnimatorRes public int getEnterAnim();
298 method @AnimRes @AnimatorRes public int getExitAnim();
299 method @AnimRes @AnimatorRes public int getPopEnterAnim();
300 method @AnimRes @AnimatorRes public int getPopExitAnim();
301 method @IdRes public int getPopUpTo();
302 method public boolean isPopUpToInclusive();
303 method public boolean shouldLaunchSingleTop();
Ian Lakeb3588b92021-04-05 15:51:01 -0700[diff] [blame]304 method public boolean shouldPopUpToSaveState();
305 method public boolean shouldRestoreState();
Jeremy Woods3f759462021-01-21 14:28:05 -0800[diff] [blame]306 property @AnimRes @AnimatorRes public final int enterAnim;
307 property @AnimRes @AnimatorRes public final int exitAnim;
308 property @AnimRes @AnimatorRes public final int popEnterAnim;
309 property @AnimRes @AnimatorRes public final int popExitAnim;
310 property @IdRes public final int popUpTo;
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]311 }
312
313 public static final class NavOptions.Builder {
314 ctor public NavOptions.Builder();
315 method public androidx.navigation.NavOptions build();
Jeremy Woods3f759462021-01-21 14:28:05 -0800[diff] [blame]316 method public androidx.navigation.NavOptions.Builder setEnterAnim(@AnimRes @AnimatorRes int enterAnim);
317 method public androidx.navigation.NavOptions.Builder setExitAnim(@AnimRes @AnimatorRes int exitAnim);
318 method public androidx.navigation.NavOptions.Builder setLaunchSingleTop(boolean singleTop);
319 method public androidx.navigation.NavOptions.Builder setPopEnterAnim(@AnimRes @AnimatorRes int popEnterAnim);
320 method public androidx.navigation.NavOptions.Builder setPopExitAnim(@AnimRes @AnimatorRes int popExitAnim);
Ian Lakeb3588b92021-04-05 15:51:01 -0700[diff] [blame]321 method public androidx.navigation.NavOptions.Builder setPopUpTo(@IdRes int destinationId, boolean inclusive, optional boolean saveState);
Jeremy Woods3f759462021-01-21 14:28:05 -0800[diff] [blame]322 method public androidx.navigation.NavOptions.Builder setPopUpTo(@IdRes int destinationId, boolean inclusive);
Ian Lakeb3588b92021-04-05 15:51:01 -0700[diff] [blame]323 method public androidx.navigation.NavOptions.Builder setRestoreState(boolean restoreState);
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]324 }
325
Jeremy Woods69c7fbc2021-04-01 17:36:53 -0700[diff] [blame]326 @androidx.navigation.NavOptionsDsl public final class NavOptionsBuilder {
327 ctor public NavOptionsBuilder();
328 method public void anim(kotlin.jvm.functions.Function1<? super androidx.navigation.AnimBuilder,kotlin.Unit> animBuilder);
329 method public boolean getLaunchSingleTop();
330 method public int getPopUpTo();
Ian Lakeb3588b92021-04-05 15:51:01 -0700[diff] [blame]331 method public boolean getRestoreState();
Jeremy Woods69c7fbc2021-04-01 17:36:53 -0700[diff] [blame]332 method public void popUpTo(@IdRes int id, kotlin.jvm.functions.Function1<? super androidx.navigation.PopUpToBuilder,kotlin.Unit> popUpToBuilder);
333 method public void setLaunchSingleTop(boolean p);
334 method public void setPopUpTo(int value);
Ian Lakeb3588b92021-04-05 15:51:01 -0700[diff] [blame]335 method public void setRestoreState(boolean p);
Jeremy Woods69c7fbc2021-04-01 17:36:53 -0700[diff] [blame]336 property public final boolean launchSingleTop;
337 property public final int popUpTo;
Ian Lakeb3588b92021-04-05 15:51:01 -0700[diff] [blame]338 property public final boolean restoreState;
Jeremy Woods69c7fbc2021-04-01 17:36:53 -0700[diff] [blame]339 }
340
341 public final class NavOptionsBuilderKt {
342 method public static androidx.navigation.NavOptions navOptions(kotlin.jvm.functions.Function1<? super androidx.navigation.NavOptionsBuilder,kotlin.Unit> optionsBuilder);
343 }
344
345 @kotlin.DslMarker public @interface NavOptionsDsl {
346 }
347
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]348 public abstract class NavType<T> {
Jeremy Woods8f576172021-01-11 09:19:27 -0800[diff] [blame]349 method public static androidx.navigation.NavType<?> fromArgType(String? type, String? packageName);
350 method public abstract operator T? get(android.os.Bundle bundle, String key);
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]351 method public abstract String getName();
352 method public boolean isNullableAllowed();
Jeremy Woods8f576172021-01-11 09:19:27 -0800[diff] [blame]353 method public abstract T! parseValue(String value);
354 method public abstract void put(android.os.Bundle bundle, String key, T? value);
355 property public boolean isNullableAllowed;
356 property public abstract String name;
357 field public static final androidx.navigation.NavType<boolean[]> BoolArrayType;
358 field public static final androidx.navigation.NavType<java.lang.Boolean> BoolType;
359 field public static final androidx.navigation.NavType.Companion Companion;
360 field public static final androidx.navigation.NavType<float[]> FloatArrayType;
361 field public static final androidx.navigation.NavType<java.lang.Float> FloatType;
362 field public static final androidx.navigation.NavType<int[]> IntArrayType;
363 field public static final androidx.navigation.NavType<java.lang.Integer> IntType;
364 field public static final androidx.navigation.NavType<long[]> LongArrayType;
365 field public static final androidx.navigation.NavType<java.lang.Long> LongType;
366 field public static final androidx.navigation.NavType<java.lang.Integer> ReferenceType;
367 field public static final androidx.navigation.NavType<java.lang.String[]> StringArrayType;
368 field public static final androidx.navigation.NavType<java.lang.String> StringType;
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]369 }
370
Jeremy Woods8f576172021-01-11 09:19:27 -0800[diff] [blame]371 public static final class NavType.Companion {
372 method public androidx.navigation.NavType<?> fromArgType(String? type, String? packageName);
373 }
374
375 public static final class NavType.EnumType<D extends java.lang.Enum<?>> extends androidx.navigation.NavType.SerializableType<D> {
376 ctor public NavType.EnumType(Class<D> type);
377 property public String name;
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]378 }
379
380 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]381 ctor public NavType.ParcelableArrayType(Class<D> type);
382 method public D![]? get(android.os.Bundle bundle, String key);
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]383 method public String getName();
Jeremy Woods8f576172021-01-11 09:19:27 -0800[diff] [blame]384 method public D![] parseValue(String value);
385 method public void put(android.os.Bundle bundle, String key, D![]? value);
386 property public String name;
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]387 }
388
389 public static final class NavType.ParcelableType<D> extends androidx.navigation.NavType<D> {
Jeremy Woods8f576172021-01-11 09:19:27 -0800[diff] [blame]390 ctor public NavType.ParcelableType(Class<D> type);
391 method public D? get(android.os.Bundle bundle, String key);
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]392 method public String getName();
Jeremy Woods8f576172021-01-11 09:19:27 -0800[diff] [blame]393 method public D! parseValue(String value);
394 method public void put(android.os.Bundle bundle, String key, D? value);
395 property public String name;
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]396 }
397
398 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]399 ctor public NavType.SerializableArrayType(Class<D> type);
400 method public D![]? get(android.os.Bundle bundle, String key);
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]401 method public String getName();
Jeremy Woods8f576172021-01-11 09:19:27 -0800[diff] [blame]402 method public D![] parseValue(String value);
403 method public void put(android.os.Bundle bundle, String key, D![]? value);
404 property public String name;
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]405 }
406
407 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]408 ctor public NavType.SerializableType(Class<D> type);
409 method public D? get(android.os.Bundle bundle, String key);
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]410 method public String getName();
Jeremy Woods8f576172021-01-11 09:19:27 -0800[diff] [blame]411 method public D parseValue(String value);
412 method public void put(android.os.Bundle bundle, String key, D value);
413 property public String name;
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]414 }
415
416 public abstract class Navigator<D extends androidx.navigation.NavDestination> {
417 ctor public Navigator();
418 method public abstract D createDestination();
Ian Lake4ab8db72021-04-23 14:25:17 -0700[diff] [blame]419 method protected final androidx.navigation.NavigatorState getState();
Ian Lakeff14ae52021-04-22 13:12:35 -0700[diff] [blame]420 method public final boolean isAttached();
Ian Lake5c911ea2021-04-26 17:04:31 -0700[diff] [blame]421 method public void navigate(java.util.List<androidx.navigation.NavBackStackEntry> entries, androidx.navigation.NavOptions? navOptions, androidx.navigation.Navigator.Extras? navigatorExtras);
422 method public androidx.navigation.NavDestination? navigate(D destination, android.os.Bundle? args, androidx.navigation.NavOptions? navOptions, androidx.navigation.Navigator.Extras? navigatorExtras);
Ian Lake4ab8db72021-04-23 14:25:17 -0700[diff] [blame]423 method @CallSuper public void onAttach(androidx.navigation.NavigatorState state);
Ian Lake5c911ea2021-04-26 17:04:31 -0700[diff] [blame]424 method public void onLaunchSingleTop(androidx.navigation.NavBackStackEntry backStackEntry);
Jeremy Woods0660bae2021-01-21 13:40:09 -0800[diff] [blame]425 method public void onRestoreState(android.os.Bundle savedState);
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]426 method public android.os.Bundle? onSaveState();
Ian Lake5c911ea2021-04-26 17:04:31 -0700[diff] [blame]427 method public void popBackStack(androidx.navigation.NavBackStackEntry popUpTo, boolean savedState);
428 method public boolean popBackStack();
Ian Lakeff14ae52021-04-22 13:12:35 -0700[diff] [blame]429 property public final boolean isAttached;
Ian Lake4ab8db72021-04-23 14:25:17 -0700[diff] [blame]430 property protected final androidx.navigation.NavigatorState state;
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]431 }
432
433 public static interface Navigator.Extras {
434 }
435
Jeremy Woods0660bae2021-01-21 13:40:09 -0800[diff] [blame]436 @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]437 method public abstract String value();
Jeremy Woods0660bae2021-01-21 13:40:09 -0800[diff] [blame]438 property public abstract String value;
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]439 }
440
441 public class NavigatorProvider {
442 ctor public NavigatorProvider();
Jeremy Woods6eef0822021-01-21 14:17:34 -0800[diff] [blame]443 method public final androidx.navigation.Navigator<? extends androidx.navigation.NavDestination>? addNavigator(androidx.navigation.Navigator<? extends androidx.navigation.NavDestination> navigator);
444 method @CallSuper public androidx.navigation.Navigator<? extends androidx.navigation.NavDestination>? addNavigator(String name, androidx.navigation.Navigator<? extends androidx.navigation.NavDestination> navigator);
445 method public final <T extends androidx.navigation.Navigator<?>> T getNavigator(Class<T> navigatorClass);
446 method @CallSuper public <T extends androidx.navigation.Navigator<?>> T getNavigator(String name);
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]447 }
448
Aurimas Liutikas38fff362021-04-01 15:43:54 -0700[diff] [blame]449 public final class NavigatorProviderKt {
450 method public static inline operator <T extends androidx.navigation.Navigator<? extends androidx.navigation.NavDestination>> T get(androidx.navigation.NavigatorProvider, String name);
451 method public static inline operator <T extends androidx.navigation.Navigator<? extends androidx.navigation.NavDestination>> T get(androidx.navigation.NavigatorProvider, kotlin.reflect.KClass<T> clazz);
452 method public static inline operator void plusAssign(androidx.navigation.NavigatorProvider, androidx.navigation.Navigator<? extends androidx.navigation.NavDestination> navigator);
453 method public static inline operator androidx.navigation.Navigator<? extends androidx.navigation.NavDestination>? set(androidx.navigation.NavigatorProvider, String name, androidx.navigation.Navigator<? extends androidx.navigation.NavDestination> navigator);
454 }
455
Ian Lake4ab8db72021-04-23 14:25:17 -0700[diff] [blame]456 public abstract class NavigatorState {
457 ctor public NavigatorState();
458 method public void add(androidx.navigation.NavBackStackEntry backStackEntry);
459 method public abstract androidx.navigation.NavBackStackEntry createBackStackEntry(androidx.navigation.NavDestination destination, android.os.Bundle? arguments);
460 method public final kotlinx.coroutines.flow.StateFlow<java.util.List<androidx.navigation.NavBackStackEntry>> getBackStack();
461 method public void pop(androidx.navigation.NavBackStackEntry popUpTo, boolean saveState);
462 property public final kotlinx.coroutines.flow.StateFlow<java.util.List<androidx.navigation.NavBackStackEntry>> backStack;
463 }
464
Jeremy Woods69c7fbc2021-04-01 17:36:53 -0700[diff] [blame]465 @androidx.navigation.NavOptionsDsl public final class PopUpToBuilder {
466 ctor public PopUpToBuilder();
467 method public boolean getInclusive();
Ian Lakeb3588b92021-04-05 15:51:01 -0700[diff] [blame]468 method public boolean getSaveState();
Jeremy Woods69c7fbc2021-04-01 17:36:53 -0700[diff] [blame]469 method public void setInclusive(boolean p);
Ian Lakeb3588b92021-04-05 15:51:01 -0700[diff] [blame]470 method public void setSaveState(boolean p);
Jeremy Woods69c7fbc2021-04-01 17:36:53 -0700[diff] [blame]471 property public final boolean inclusive;
Ian Lakeb3588b92021-04-05 15:51:01 -0700[diff] [blame]472 property public final boolean saveState;
Jeremy Woods69c7fbc2021-04-01 17:36:53 -0700[diff] [blame]473 }
474
Jeff Gastone6a3a042019-07-01 18:23:37 -0400[diff] [blame]475}
476