angular-resource-url-type-factory
Version:
A factory used to build ui-router URL types that fetch data from RESTful APIs.
5 lines • 6.8 kB
HTML
<html>
<head>
<meta charset="utf-8">
<title>JSDoc: ResourceUrlTypeFactoryService</title>
<link href="css/prettify-tomorrow.css" type="text/css" rel="stylesheet">
<link href="css/site.css" type="text/css" rel="stylesheet">
</head>
<body ng-app="">
<nav id="toc">
<input placeholder="Filter" id="filter-input" class="col12 block field" type="text">
<div class="nav-wrapper">
<h2><a href="index.html">Index</a></h2>
<ul class="module">
<!-- undefined -->
<h2 class="module">
<a chref="" ng-click="moduleundefined = !moduleundefined">
module: undefined
</a>
<i ng-cloak="" ng-show="moduleundefined">+</i>
</h2>
<li id="undefined" ng-hide="moduleundefined">
<ul class="group">
<h2>
<a href="" ng-click="undefinedfactory = !undefinedfactory">
factory
</a>
<i ng-cloak="" ng-show="undefinedfactory">+</i>
</h2>
<ul ng-hide="undefinedfactory">
<li>
<a href="ResourceUrlTypeFactoryService.html">ResourceUrlTypeFactoryService</a>
</li>
</ul>
</ul><ul class="group">
<h2>
<a href="" ng-click="undefinedprovider = !undefinedprovider">
provider
</a>
<i ng-cloak="" ng-show="undefinedprovider">+</i>
</h2>
<ul ng-hide="undefinedprovider">
<li>
<a href="ResourceUrlTypeFactoryServiceProvider.html">ResourceUrlTypeFactoryServiceProvider</a>
</li>
</ul>
</ul>
</li>
</ul>
</div>
</nav>
<div id="content" class="page-wrap">
<h3 style="float:right; color:#ccc">
Angular factory
</h3>
<h1 class="title">
ResourceUrlTypeFactoryService
<a class="name-link signature-attributes" href="source/ResourceUrlTypeFactoryService.html#line96">source</a>
</h1>
<div id="main" class="big-container">
<!-- source code html -->
<!-- index.html -->
<!-- class files -->
<div>
<div><div class="container-overview">
<ul class="chips">
</ul>
<div class="clearfix"></div>
<div class="description">
<h4>Description</h4>
<p>Gets the actual service object</p>
</div>
<div class="details"></div>
</div>
<div class="functions">
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<a href="source/ResourceUrlTypeFactoryService.html#line117" class="name-link" id="getPromise">
<h4 class="name">
getPromise
<span class="type-signature">
-> Promise
</span>
</h4>
</a>
</dt>
<dd>
<div class="description">
<span>
<p>Get a promise of the given object. Returns the object itself if we pass a promise, returns
the <code>$promise</code> attribute if we pass a resource instance, and returns a resolved promise for the
passed object on anything else.</p>
</span>
</div>
<div>
<h4>Returns</h4>
<table class="params">
<thead>
<tr><th>Type</th><th class="last">Description</th></tr>
</thead>
<tbody>
<tr>
<td class="type">
<span class="param-type">
<a href="Promise.html">Promise</a>
</span>
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl><dl>
<dt>
<a href="source/ResourceUrlTypeFactoryService.html#line145" class="name-link" id="self.getParams">
<h4 class="name">
self.getParams
<span class="type-signature">
-> String[]
</span>
</h4>
</a>
</dt>
<dd>
<div class="description">
<span>
<p>Gets the param names that are resource url type factory types for the
given param definitions.</p>
</span>
</div>
<div>
<h4>Returns</h4>
<table class="params">
<thead>
<tr><th>Type</th><th class="last">Description</th></tr>
</thead>
<tbody>
<tr>
<td class="type">
<span class="param-type">
String[]
</span>
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl><dl>
<dt>
<a href="source/ResourceUrlTypeFactoryService.html#line134" class="name-link" id="self.getTypeNames">
<h4 class="name">
self.getTypeNames
<span class="type-signature">
-> String[]
</span>
</h4>
</a>
</dt>
<dd>
<div class="description">
<span>
<p>Returns a list of names for all registered types.</p>
</span>
</div>
<div>
<h4>Returns</h4>
<table class="params">
<thead>
<tr><th>Type</th><th class="last">Description</th></tr>
</thead>
<tbody>
<tr>
<td class="type">
<span class="param-type">
String[]
</span>
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl><dl>
<dt>
<a href="source/ResourceUrlTypeFactoryService.html#line170" class="name-link" id="self.registerTransition">
<h4 class="name">
self.registerTransition
</h4>
</a>
</dt>
<dd>
<div class="description">
<span>
<p>Registers a ui-router transition handler for the registered types above. The transition
will wait for the promises to resolve before the routing finishes.</p>
</span>
</div>
</dd>
</dl>
</div></div>
</div>
</div>
<footer style="clear:both">
Documentation generated by
<a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a>
using
<a href="https://github.com/allenhwkim/angular-jsdoc">Angular-JSDoc template</a>
</footer>
</div>
<script src="js/prettify.js"></script>
<script src="js/angular.min.js"></script>
<script src="js/site.js"></script>
<!--%= prettyJson %-->
<script>
prettyPrint();
var lineNo = window.location.hash.match(/#line([0-9]+)$/);
lineNo && document.querySelector("ol li:nth-child("+(lineNo[1])+")").scrollIntoView();
</script>
</body>
</html>