38 lines
3.2 KiB
HTML
Executable file
38 lines
3.2 KiB
HTML
Executable file
<a href="http://github.com/angular/angular.js/tree/v1.2.0rc1/src/ngCookies/cookies.js#L129" class="view-source btn btn-action"><i class="icon-zoom-in"> </i> View source</a><a href="http://github.com/angular/angular.js/edit/master/src/ngCookies/cookies.js" class="improve-docs btn btn-primary"><i class="icon-edit"> </i> Improve this doc</a><h1><code ng:non-bindable="">$cookieStore</code>
|
|
<div><span class="hint">service in module <code ng:non-bindable="">ngCookies</code>
|
|
</span>
|
|
</div>
|
|
</h1>
|
|
<div><h2 id="Description">Description</h2>
|
|
<div class="description"><div class="ngcookies-cookiestore-page"><p>Provides a key-value (string-object) storage, that is backed by session cookies.
|
|
Objects put or retrieved from this storage are automatically serialized or
|
|
deserialized by angular's toJson/fromJson.</p>
|
|
<p>Requires the <a href="api/ngCookies"><code>ngCookies</code></a> module to be installed.</p>
|
|
</div></div>
|
|
<h2 id="Dependencies">Dependencies</h2>
|
|
<ul class="dependencies"><li><code ng:non-bindable=""><a href="api/ng.$cookies">$cookies</a></code>
|
|
</li>
|
|
</ul>
|
|
<div class="member method"><h2 id="Methods">Methods</h2>
|
|
<ul class="methods"><li><h3 id="get">get(key)</h3>
|
|
<div class="get"><div class="ngcookies-cookiestore-get-page"><p>Returns the value of given cookie key</p>
|
|
</div><h5 id="parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>key</td><td><a href="" class="label type-hint type-hint-string">string</a></td><td><div class="ngcookies-cookiestore-get-page"><p>Id to use for lookup.</p>
|
|
</div></td></tr></tbody></table><h5 id="returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-object">Object</a></td><td><div class="ngcookies-cookiestore-get-page"><p>Deserialized cookie value.</p>
|
|
</div></td></tr></table></div>
|
|
</li>
|
|
<li><h3 id="put">put(key, value)</h3>
|
|
<div class="put"><div class="ngcookies-cookiestore-put-page"><p>Sets a value for given cookie key</p>
|
|
</div><h5 id="parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>key</td><td><a href="" class="label type-hint type-hint-string">string</a></td><td><div class="ngcookies-cookiestore-put-page"><p>Id for the <code>value</code>.</p>
|
|
</div></td></tr><tr><td>value</td><td><a href="" class="label type-hint type-hint-object">Object</a></td><td><div class="ngcookies-cookiestore-put-page"><p>Value to be stored.</p>
|
|
</div></td></tr></tbody></table></div>
|
|
</li>
|
|
<li><h3 id="remove">remove(key)</h3>
|
|
<div class="remove"><div class="ngcookies-cookiestore-remove-page"><p>Remove given cookie</p>
|
|
</div><h5 id="parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>key</td><td><a href="" class="label type-hint type-hint-string">string</a></td><td><div class="ngcookies-cookiestore-remove-page"><p>Id of the key-value pair to delete.</p>
|
|
</div></td></tr></tbody></table></div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<h2 id="Example">Example</h2>
|
|
<div class="example"></div>
|
|
</div>
|