{"payload":{"allShortcutsEnabled":false,"fileTree":{"_ng1_docs/1.0.0-rc.1/classes":{"items":[{"name":"common.queue.html","path":"_ng1_docs/1.0.0-rc.1/classes/common.queue.html","contentType":"file"},{"name":"core.glob.html","path":"_ng1_docs/1.0.0-rc.1/classes/core.glob.html","contentType":"file"},{"name":"core.globals.html","path":"_ng1_docs/1.0.0-rc.1/classes/core.globals.html","contentType":"file"},{"name":"core.uirouter.html","path":"_ng1_docs/1.0.0-rc.1/classes/core.uirouter.html","contentType":"file"},{"name":"core.uirouterpluginbase.html","path":"_ng1_docs/1.0.0-rc.1/classes/core.uirouterpluginbase.html","contentType":"file"},{"name":"ng1.ng1locationservices.html","path":"_ng1_docs/1.0.0-rc.1/classes/ng1.ng1locationservices.html","contentType":"file"},{"name":"ng1.ng1viewconfig.html","path":"_ng1_docs/1.0.0-rc.1/classes/ng1.ng1viewconfig.html","contentType":"file"},{"name":"ng1.stateprovider.html","path":"_ng1_docs/1.0.0-rc.1/classes/ng1.stateprovider.html","contentType":"file"},{"name":"params.param.html","path":"_ng1_docs/1.0.0-rc.1/classes/params.param.html","contentType":"file"},{"name":"params.paramtype.html","path":"_ng1_docs/1.0.0-rc.1/classes/params.paramtype.html","contentType":"file"},{"name":"params.paramtypes.html","path":"_ng1_docs/1.0.0-rc.1/classes/params.paramtypes.html","contentType":"file"},{"name":"params.stateparams.html","path":"_ng1_docs/1.0.0-rc.1/classes/params.stateparams.html","contentType":"file"},{"name":"path.pathfactory.html","path":"_ng1_docs/1.0.0-rc.1/classes/path.pathfactory.html","contentType":"file"},{"name":"path.pathnode.html","path":"_ng1_docs/1.0.0-rc.1/classes/path.pathnode.html","contentType":"file"},{"name":"resolve.resolvable.html","path":"_ng1_docs/1.0.0-rc.1/classes/resolve.resolvable.html","contentType":"file"},{"name":"resolve.resolvecontext.html","path":"_ng1_docs/1.0.0-rc.1/classes/resolve.resolvecontext.html","contentType":"file"},{"name":"resolve.uiinjectorimpl.html","path":"_ng1_docs/1.0.0-rc.1/classes/resolve.uiinjectorimpl.html","contentType":"file"},{"name":"state.state-1.html","path":"_ng1_docs/1.0.0-rc.1/classes/state.state-1.html","contentType":"file"},{"name":"state.statebuilder.html","path":"_ng1_docs/1.0.0-rc.1/classes/state.statebuilder.html","contentType":"file"},{"name":"state.statematcher.html","path":"_ng1_docs/1.0.0-rc.1/classes/state.statematcher.html","contentType":"file"},{"name":"state.statequeuemanager.html","path":"_ng1_docs/1.0.0-rc.1/classes/state.statequeuemanager.html","contentType":"file"},{"name":"state.stateregistry.html","path":"_ng1_docs/1.0.0-rc.1/classes/state.stateregistry.html","contentType":"file"},{"name":"state.stateservice.html","path":"_ng1_docs/1.0.0-rc.1/classes/state.stateservice.html","contentType":"file"},{"name":"state.targetstate.html","path":"_ng1_docs/1.0.0-rc.1/classes/state.targetstate.html","contentType":"file"},{"name":"trace.trace-1.html","path":"_ng1_docs/1.0.0-rc.1/classes/trace.trace-1.html","contentType":"file"},{"name":"transition.hookbuilder.html","path":"_ng1_docs/1.0.0-rc.1/classes/transition.hookbuilder.html","contentType":"file"},{"name":"transition.registeredhook.html","path":"_ng1_docs/1.0.0-rc.1/classes/transition.registeredhook.html","contentType":"file"},{"name":"transition.rejection.html","path":"_ng1_docs/1.0.0-rc.1/classes/transition.rejection.html","contentType":"file"},{"name":"transition.transition-1.html","path":"_ng1_docs/1.0.0-rc.1/classes/transition.transition-1.html","contentType":"file"},{"name":"transition.transitioneventtype.html","path":"_ng1_docs/1.0.0-rc.1/classes/transition.transitioneventtype.html","contentType":"file"},{"name":"transition.transitionservice.html","path":"_ng1_docs/1.0.0-rc.1/classes/transition.transitionservice.html","contentType":"file"},{"name":"url.baseurlrule.html","path":"_ng1_docs/1.0.0-rc.1/classes/url.baseurlrule.html","contentType":"file"},{"name":"url.urlmatcher.html","path":"_ng1_docs/1.0.0-rc.1/classes/url.urlmatcher.html","contentType":"file"},{"name":"url.urlmatcherfactory.html","path":"_ng1_docs/1.0.0-rc.1/classes/url.urlmatcherfactory.html","contentType":"file"},{"name":"url.urlrouter.html","path":"_ng1_docs/1.0.0-rc.1/classes/url.urlrouter.html","contentType":"file"},{"name":"url.urlrouterprovider.html","path":"_ng1_docs/1.0.0-rc.1/classes/url.urlrouterprovider.html","contentType":"file"},{"name":"url.urlrulefactory.html","path":"_ng1_docs/1.0.0-rc.1/classes/url.urlrulefactory.html","contentType":"file"},{"name":"url.urlservice.html","path":"_ng1_docs/1.0.0-rc.1/classes/url.urlservice.html","contentType":"file"},{"name":"view.templatefactory.html","path":"_ng1_docs/1.0.0-rc.1/classes/view.templatefactory.html","contentType":"file"},{"name":"view.viewservice.html","path":"_ng1_docs/1.0.0-rc.1/classes/view.viewservice.html","contentType":"file"}],"totalCount":40},"_ng1_docs/1.0.0-rc.1":{"items":[{"name":"assets","path":"_ng1_docs/1.0.0-rc.1/assets","contentType":"directory"},{"name":"classes","path":"_ng1_docs/1.0.0-rc.1/classes","contentType":"directory"},{"name":"enums","path":"_ng1_docs/1.0.0-rc.1/enums","contentType":"directory"},{"name":"interfaces","path":"_ng1_docs/1.0.0-rc.1/interfaces","contentType":"directory"},{"name":"modules","path":"_ng1_docs/1.0.0-rc.1/modules","contentType":"directory"},{"name":"files.json","path":"_ng1_docs/1.0.0-rc.1/files.json","contentType":"file"},{"name":"globals.html","path":"_ng1_docs/1.0.0-rc.1/globals.html","contentType":"file"},{"name":"index.html","path":"_ng1_docs/1.0.0-rc.1/index.html","contentType":"file"}],"totalCount":8},"_ng1_docs":{"items":[{"name":"0.2.10","path":"_ng1_docs/0.2.10","contentType":"directory"},{"name":"0.2.14","path":"_ng1_docs/0.2.14","contentType":"directory"},{"name":"0.2.15","path":"_ng1_docs/0.2.15","contentType":"directory"},{"name":"0.2.18","path":"_ng1_docs/0.2.18","contentType":"directory"},{"name":"0.2.8","path":"_ng1_docs/0.2.8","contentType":"directory"},{"name":"0.3.1","path":"_ng1_docs/0.3.1","contentType":"directory"},{"name":"0.3.2","path":"_ng1_docs/0.3.2","contentType":"directory"},{"name":"0.4.2","path":"_ng1_docs/0.4.2","contentType":"directory"},{"name":"1.0.0-alpha.1","path":"_ng1_docs/1.0.0-alpha.1","contentType":"directory"},{"name":"1.0.0-alpha.3","path":"_ng1_docs/1.0.0-alpha.3","contentType":"directory"},{"name":"1.0.0-alpha.5","path":"_ng1_docs/1.0.0-alpha.5","contentType":"directory"},{"name":"1.0.0-beta.1","path":"_ng1_docs/1.0.0-beta.1","contentType":"directory"},{"name":"1.0.0-beta.2","path":"_ng1_docs/1.0.0-beta.2","contentType":"directory"},{"name":"1.0.0-beta.3","path":"_ng1_docs/1.0.0-beta.3","contentType":"directory"},{"name":"1.0.0-rc.1","path":"_ng1_docs/1.0.0-rc.1","contentType":"directory"},{"name":"1.0.0","path":"_ng1_docs/1.0.0","contentType":"directory"},{"name":"1.0.10","path":"_ng1_docs/1.0.10","contentType":"directory"},{"name":"1.0.14","path":"_ng1_docs/1.0.14","contentType":"directory"},{"name":"1.0.16","path":"_ng1_docs/1.0.16","contentType":"directory"},{"name":"1.0.19","path":"_ng1_docs/1.0.19","contentType":"directory"},{"name":"1.0.20","path":"_ng1_docs/1.0.20","contentType":"directory"},{"name":"1.0.22","path":"_ng1_docs/1.0.22","contentType":"directory"},{"name":"1.0.23","path":"_ng1_docs/1.0.23","contentType":"directory"},{"name":"1.0.24","path":"_ng1_docs/1.0.24","contentType":"directory"},{"name":"latest","path":"_ng1_docs/latest","contentType":"directory"},{"name":"ngdoc_assets","path":"_ng1_docs/ngdoc_assets","contentType":"directory"},{"name":"add_redirects.sh","path":"_ng1_docs/add_redirects.sh","contentType":"file"},{"name":"create_metadata.sh","path":"_ng1_docs/create_metadata.sh","contentType":"file"},{"name":"index.html","path":"_ng1_docs/index.html","contentType":"file"},{"name":"paths_as_json_array.js","path":"_ng1_docs/paths_as_json_array.js","contentType":"file"},{"name":"process_docs.sh","path":"_ng1_docs/process_docs.sh","contentType":"file"},{"name":"process_legacy_docs.sh","path":"_ng1_docs/process_legacy_docs.sh","contentType":"file"},{"name":"process_typedoc_docs.sh","path":"_ng1_docs/process_typedoc_docs.sh","contentType":"file"},{"name":"versions.json","path":"_ng1_docs/versions.json","contentType":"file"}],"totalCount":34},"":{"items":[{"name":"_about","path":"_about","contentType":"directory"},{"name":"_core_docs","path":"_core_docs","contentType":"directory"},{"name":"_data","path":"_data","contentType":"directory"},{"name":"_guide","path":"_guide","contentType":"directory"},{"name":"_includes","path":"_includes","contentType":"directory"},{"name":"_layouts","path":"_layouts","contentType":"directory"},{"name":"_ng1","path":"_ng1","contentType":"directory"},{"name":"_ng1_docs","path":"_ng1_docs","contentType":"directory"},{"name":"_ng1_tutorial","path":"_ng1_tutorial","contentType":"directory"},{"name":"_ng2","path":"_ng2","contentType":"directory"},{"name":"_ng2_docs","path":"_ng2_docs","contentType":"directory"},{"name":"_ng2_tutorial","path":"_ng2_tutorial","contentType":"directory"},{"name":"_pages","path":"_pages","contentType":"directory"},{"name":"_posts","path":"_posts","contentType":"directory"},{"name":"_react","path":"_react","contentType":"directory"},{"name":"_react_docs","path":"_react_docs","contentType":"directory"},{"name":"_react_tutorial","path":"_react_tutorial","contentType":"directory"},{"name":"_resources","path":"_resources","contentType":"directory"},{"name":"assets","path":"assets","contentType":"directory"},{"name":"blog","path":"blog","contentType":"directory"},{"name":"images","path":"images","contentType":"directory"},{"name":".editorconfig","path":".editorconfig","contentType":"file"},{"name":".gitattributes","path":".gitattributes","contentType":"file"},{"name":".gitignore","path":".gitignore","contentType":"file"},{"name":"CHANGELOG.md","path":"CHANGELOG.md","contentType":"file"},{"name":"Gemfile","path":"Gemfile","contentType":"file"},{"name":"Gemfile.lock","path":"Gemfile.lock","contentType":"file"},{"name":"LICENSE","path":"LICENSE","contentType":"file"},{"name":"README.md","path":"README.md","contentType":"file"},{"name":"_config.yml","path":"_config.yml","contentType":"file"},{"name":"favicon.ico","path":"favicon.ico","contentType":"file"},{"name":"package.json","path":"package.json","contentType":"file"},{"name":"yarn.lock","path":"yarn.lock","contentType":"file"}],"totalCount":33}},"fileTreeProcessingTime":18.344922999999998,"foldersToFetch":[],"repo":{"id":62182623,"defaultBranch":"master","name":"ui-router.github.io","ownerLogin":"ui-router","currentUserCanPush":false,"isFork":true,"isEmpty":false,"createdAt":"2016-06-29T00:22:01.000Z","ownerAvatar":"https://avatars.githubusercontent.com/u/16856735?v=4","public":true,"private":false,"isOrgOwned":true},"symbolsExpanded":false,"treeExpanded":true,"refInfo":{"name":"master","listCacheKey":"v0:1513908236.0","canEdit":false,"refType":"branch","currentOid":"007c96a2f4a0cb5a63be423fad37292946a59b53"},"path":"_ng1_docs/1.0.0-rc.1/classes/core.uirouter.html","currentUser":null,"blob":{"rawLines":["---","redirect_from: /docs/1.0.0-rc.1/classes/core.uirouter.html","---","","","
","\t","\t","\t Creates a new UIRouter
object
Creates a new UIRouter
object
a LocationServices implementation
","\t\t\t\t\t\t\t\t\t\ta LocationConfig implementation
","\t\t\t\t\t\t\t\t\t\tGlobal router state
","\t\t\t\t\t\tGlobal router state
","\t\t\t\t\t\t\ta LocationConfig implementation
","\t\t\t\t\t\ta LocationConfig implementation
","\t\t\t\t\t\t\ta LocationServices implementation
","\t\t\t\t\t\ta LocationServices implementation
","\t\t\t\t\t\t\tProvides a registry for states, and related registration services
","\t\t\t\t\t\tProvides a registry for states, and related registration services
","\t\t\t\t\t\t\tProvides services related to states
","\t\t\t\t\t\tProvides services related to states
","\t\t\t\t\t\t\tProvides trace information to the console
","\t\t\t\t\t\tProvides trace information to the console
","\t\t\t\t\t\t\tProvides services related to Transitions
","\t\t\t\t\t\tProvides services related to Transitions
","\t\t\t\t\t\t\tDeprecated for public use. Use urlService instead.
","\t\t\t\t\t\tDeprecated for public use. Use urlService instead.
","\t\t\t\t\t\t\tDeprecated for public use. Use urlService instead.
","\t\t\t\t\t\tDeprecated for public use. Use urlService instead.
","\t\t\t\t\t\t\tProvides services related to the URL
","\t\t\t\t\t\tProvides services related to the URL
","\t\t\t\t\t\t\tProvides services related to ui-view synchronization
","\t\t\t\t\t\tProvides services related to ui-view synchronization
","\t\t\t\t\t\t\tRegisters an object to be notified when the router is disposed
","\t\t\t\t\t\tRegisters an object to be notified when the router is disposed
","\t\t\t\t\t\t\t\tDisposes this router instance
","\t\t\t\t\t\tDisposes this router instance
","\t\t\t\t\t\t\t\tWhen called, clears resources retained by the router by calling dispose(this)
on all","\t\t\t\t\t\t\t\tregistered disposable objects.
Or, if a disposable
object is provided, calls dispose(this)
on that object only.
(optional) the disposable to dispose
","\t\t\t\t\t\t\t\t\tReturns registered plugins
","\t\t\t\t\t\tReturns registered plugins
","\t\t\t\t\t\t\t\tReturns the registered plugin of the given pluginName
.","\t\t\t\t\t\t\t\tIf no pluginName
is given, returns all registered plugins
the named plugin (undefined if not found), or all plugins (if pluginName
is omitted)
Add plugin (as ES6 class)
","\t\t\t\t\t\tAdd plugin (as javascript constructor function)
","\t\t\t\t\t\tAdd plugin (as javascript factory function)
","\t\t\t\t\t\tAdd plugin (as ES6 class)
","\t\t\t\t\t\t\t\tThis method adds a UI-Router Plugin.","\t\t\t\t\t\t\t\tA plugin can enhance or change UI-Router behavior using any public API.
","\t\t\t\t\t\t\t\timport { MyCoolPlugin } from \"ui-router-cool-plugin\";","","var plugin = router.addPlugin(MyCoolPlugin);","
","\t\t\t\t\t\t\t\tA plugin is simply a class (or constructor function) which accepts a UIRouter instance and (optionally) an options object.
","\t\t\t\t\t\t\t\tThe plugin can implement its functionality using any of the public APIs of UIRouter.","\t\t\t\t\t\t\t\tFor example, it may configure router options or add a Transition Hook.
","\t\t\t\t\t\t\t\tThe plugin can then be published as a separate module.
","\t\t\t\t\t\t\t\texport class MyAuthPlugin implements UIRouterPlugin {"," constructor(router: UIRouter, options: any) {"," this.name = \"MyAuthPlugin\";"," let $transitions = router.transitionService;"," let $state = router.stateService;",""," let authCriteria = {"," to: (state) => state.data && state.data.requiresAuth"," };",""," function authHook(transition: Transition) {"," let authService = transition.injector().get('AuthService');"," if (!authService.isAuthenticated()) {"," return $state.target('login');"," }"," }",""," $transitions.onStart(authCriteria, authHook);"," }","}","
","\t\t\t\t\t\t\tone of:
","\t\t\t\t\t\t\t\t\t\t\t - a plugin class which implements <a href=\"../interfaces/core.uirouterplugin.html\">UIRouterPlugin</a>"," - a constructor function for a <a href=\"../interfaces/core.uirouterplugin.html\">UIRouterPlugin</a> which accepts a <a href=\"core.uirouter.html\">UIRouter</a> instance"," - a factory function which accepts a <a href=\"core.uirouter.html\">UIRouter</a> instance and returns a <a href=\"../interfaces/core.uirouterplugin.html\">UIRouterPlugin</a> instance","
","\t\t\t\t\t\t\t\t\t\toptions to pass to the plugin class/factory
","\t\t\t\t\t\t\t\t\t\tthe registered plugin instance
","\t\t\t\t\t\t\tAdd plugin (as javascript constructor function)
","\t\t\t\t\t\t\t\tThis method adds a UI-Router Plugin.","\t\t\t\t\t\t\t\tA plugin can enhance or change UI-Router behavior using any public API.
","\t\t\t\t\t\t\t\timport { MyCoolPlugin } from \"ui-router-cool-plugin\";","","var plugin = router.addPlugin(MyCoolPlugin);","
","\t\t\t\t\t\t\t\tA plugin is simply a class (or constructor function) which accepts a UIRouter instance and (optionally) an options object.
","\t\t\t\t\t\t\t\tThe plugin can implement its functionality using any of the public APIs of UIRouter.","\t\t\t\t\t\t\t\tFor example, it may configure router options or add a Transition Hook.
","\t\t\t\t\t\t\t\tThe plugin can then be published as a separate module.
","\t\t\t\t\t\t\t\texport class MyAuthPlugin implements UIRouterPlugin {"," constructor(router: UIRouter, options: any) {"," this.name = \"MyAuthPlugin\";"," let $transitions = router.transitionService;"," let $state = router.stateService;",""," let authCriteria = {"," to: (state) => state.data && state.data.requiresAuth"," };",""," function authHook(transition: Transition) {"," let authService = transition.injector().get('AuthService');"," if (!authService.isAuthenticated()) {"," return $state.target('login');"," }"," }",""," $transitions.onStart(authCriteria, authHook);"," }","}","
","\t\t\t\t\t\t\tone of:
","\t\t\t\t\t\t\t\t\t\t\t - a plugin class which implements <a href=\"../interfaces/core.uirouterplugin.html\">UIRouterPlugin</a>"," - a constructor function for a <a href=\"../interfaces/core.uirouterplugin.html\">UIRouterPlugin</a> which accepts a <a href=\"core.uirouter.html\">UIRouter</a> instance"," - a factory function which accepts a <a href=\"core.uirouter.html\">UIRouter</a> instance and returns a <a href=\"../interfaces/core.uirouterplugin.html\">UIRouterPlugin</a> instance","
","\t\t\t\t\t\t\t\t\t\toptions to pass to the plugin class/factory
","\t\t\t\t\t\t\t\t\t\tthe registered plugin instance
","\t\t\t\t\t\t\tAdd plugin (as javascript factory function)
","\t\t\t\t\t\t\t\tThis method adds a UI-Router Plugin.","\t\t\t\t\t\t\t\tA plugin can enhance or change UI-Router behavior using any public API.
","\t\t\t\t\t\t\t\timport { MyCoolPlugin } from \"ui-router-cool-plugin\";","","var plugin = router.addPlugin(MyCoolPlugin);","
","\t\t\t\t\t\t\t\tA plugin is simply a class (or constructor function) which accepts a UIRouter instance and (optionally) an options object.
","\t\t\t\t\t\t\t\tThe plugin can implement its functionality using any of the public APIs of UIRouter.","\t\t\t\t\t\t\t\tFor example, it may configure router options or add a Transition Hook.
","\t\t\t\t\t\t\t\tThe plugin can then be published as a separate module.
","\t\t\t\t\t\t\t\texport class MyAuthPlugin implements UIRouterPlugin {"," constructor(router: UIRouter, options: any) {"," this.name = \"MyAuthPlugin\";"," let $transitions = router.transitionService;"," let $state = router.stateService;",""," let authCriteria = {"," to: (state) => state.data && state.data.requiresAuth"," };",""," function authHook(transition: Transition) {"," let authService = transition.injector().get('AuthService');"," if (!authService.isAuthenticated()) {"," return $state.target('login');"," }"," }",""," $transitions.onStart(authCriteria, authHook);"," }","}","
","\t\t\t\t\t\t\tone of:
","\t\t\t\t\t\t\t\t\t\t\t - a plugin class which implements <a href=\"../interfaces/core.uirouterplugin.html\">UIRouterPlugin</a>"," - a constructor function for a <a href=\"../interfaces/core.uirouterplugin.html\">UIRouterPlugin</a> which accepts a <a href=\"core.uirouter.html\">UIRouter</a> instance"," - a factory function which accepts a <a href=\"core.uirouter.html\">UIRouter</a> instance and returns a <a href=\"../interfaces/core.uirouterplugin.html\">UIRouterPlugin</a> instance","
","\t\t\t\t\t\t\t\t\t\toptions to pass to the plugin class/factory
","\t\t\t\t\t\t\t\t\t\tthe registered plugin instance
","\t\t\t\t\t\t\tGenerated using TypeDoc
","
The master class used to instantiate an instance of UI-Router.
","\t\t\t\t\tUI-Router (for each specific framework) will create an instance of this class during bootstrap.","\t\t\t\t\tThis class instantiates and wires the UI-Router services together.
","\t\t\t\t\tAfter a new instance of the UIRouter class is created, it should be configured for your app.","\t\t\t\t\tFor instance, app states should be registered with the UIRouter.stateRegistry.
","\t\t\t\t\t","\t\t\t\t\t
Normally the framework code will bootstrap UI-Router.","\t\t\t\t\t\tIf you are bootstrapping UIRouter manually, tell it to monitor the URL by calling","\t\t\t\t\tUrlService.listen then UrlService.sync.
","\t\t\t\t