Skip to content

Commit 0ad8de2

Browse files
rohitmishra209rohitmishra209
committed
updated in reference doc
1 parent c543e03 commit 0ad8de2

File tree

77 files changed

+24599
-114
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

77 files changed

+24599
-114
lines changed

‎LICENSE.txt‎

100644100755
File mode changed.

‎config.js‎

100644100755
File mode changed.

‎docs-config.json‎

100644100755
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
]
2020
},
2121
"tags": {
22-
"dictionaries": ["jsdoc", "closure"]
22+
"dictionaries": ["jsdoc", "closure"],
23+
"allowUnknownTags": true
2324
}
2425
}

‎js-sdk-reference.zip‎

619 KB
Binary file not shown.

‎js-sdk-reference_old/README.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Generating Contentstack SDK Docs
2+
To generate api reference documentation use the following command under the root directory.
3+
## Prerequisite
4+
JSDoc supports Node.js 4.2.0 and later. You can install JSDoc globally or in your project's node_modules folder.
5+
To install the latest version on npm globally (may require sudo; learn how to fix this):
6+
7+
```npm install -g jsdoc```
8+
9+
To install the latest version on npm locally and save it in your package's package.json file:
10+
11+
```npm install --save-dev jsdoc```
12+
13+
## Generate documentation
14+
15+
```jsdoc -c path/to/config/file```

‎js-sdk-reference_old/Result.html‎

Lines changed: 221 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,221 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<title>Result - Documentation</title>
6+
7+
<script src="scripts/prettify/prettify.js"></script>
8+
<script src="scripts/prettify/lang-css.js"></script>
9+
<!--[if lt IE 9]>
10+
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11+
<![endif]-->
12+
<link rel="canonical" href="https://www.contentstack.com/docs/platforms/java/api-reference/">
13+
<link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
14+
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
15+
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
16+
</head>
17+
<body>
18+
19+
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
20+
<label for="nav-trigger" class="navicon-button x">
21+
<div class="navicon"></div>
22+
</label>
23+
24+
<label for="nav-trigger" class="overlay"></label>
25+
26+
<nav>
27+
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Result.html">Result</a></li></ul><h3>Global</h3><ul><li><a href="global.html#Contentstack">Contentstack</a></li><li><a href="global.html#CachePolicy">CachePolicy</a></li><li><a href="global.html#Stack">Stack</a></li><li><a href="global.html#setPort">setPort</a></li><li><a href="global.html#setProtocol">setProtocol</a></li><li><a href="global.html#setHost">setHost</a></li><li><a href="global.html#setCachePolicy">setCachePolicy</a></li><li><a href="global.html#setCacheProvider">setCacheProvider</a></li><li><a href="global.html#getCacheProvider">getCacheProvider</a></li><li><a href="global.html#ContentType">ContentType</a></li><li><a href="global.html#Entry">Entry</a></li><li><a href="global.html#Assets">Assets</a></li><li><a href="global.html#Query">Query</a></li><li><a href="global.html#sync">sync</a></li><li><a href="global.html#imageTransform">imageTransform</a></li><li><a href="global.html#only">only</a></li><li><a href="global.html#except">except</a></li><li><a href="global.html#includeReference">includeReference</a></li><li><a href="global.html#language">language</a></li><li><a href="global.html#addQuery">addQuery</a></li><li><a href="global.html#includeSchema">includeSchema</a></li><li><a href="global.html#includeContentType">includeContentType</a></li><li><a href="global.html#includeOwner">includeOwner</a></li><li><a href="global.html#toJSON">toJSON</a></li><li><a href="global.html#AddParam">AddParam</a></li><li><a href="global.html#fetch">fetch</a></li><li><a href="global.html#lessThan">lessThan</a></li><li><a href="global.html#lessThanOrEqualTo">lessThanOrEqualTo</a></li><li><a href="global.html#greaterThan">greaterThan</a></li><li><a href="global.html#greaterThanOrEqualTo">greaterThanOrEqualTo</a></li><li><a href="global.html#notEqualTo">notEqualTo</a></li><li><a href="global.html#containedIn">containedIn</a></li><li><a href="global.html#notContainedIn">notContainedIn</a></li><li><a href="global.html#exists">exists</a></li><li><a href="global.html#notExists">notExists</a></li><li><a href="global.html#ascending">ascending</a></li><li><a href="global.html#descending">descending</a></li><li><a href="global.html#skip">skip</a></li><li><a href="global.html#limit">limit</a></li><li><a href="global.html#or">or</a></li><li><a href="global.html#and">and</a></li><li><a href="global.html#where">where</a></li><li><a href="global.html#count">count</a></li><li><a href="global.html#query">query</a></li><li><a href="global.html#tags">tags</a></li><li><a href="global.html#includeCount">includeCount</a></li><li><a href="global.html#getQuery">getQuery</a></li><li><a href="global.html#regex">regex</a></li><li><a href="global.html#search">search</a></li><li><a href="global.html#find">find</a></li><li><a href="global.html#findOne">findOne</a></li><li><a href="global.html#get">get</a></li><li><a href="global.html#getDownloadUrl">getDownloadUrl</a></li></ul>
28+
</nav>
29+
30+
<div id="main">
31+
32+
<h1 class="page-title">Result</h1>
33+
34+
35+
36+
37+
38+
39+
<section>
40+
41+
<header>
42+
43+
<h2>
44+
Result
45+
</h2>
46+
47+
48+
</header>
49+
50+
<article>
51+
<div class="container-overview">
52+
53+
54+
55+
56+
57+
58+
<h4 class="name" id="Result"><span class="type-signature"></span>new Result<span class="signature">(object)</span><span class="type-signature"> &rarr; {<a href="Result.html">Result</a>}</span></h4>
59+
60+
61+
<p class="summary">Creates an instance of `Result`.</p>
62+
63+
64+
65+
66+
<div class="description">
67+
An initializer is responsible for creating Result object.
68+
</div>
69+
70+
71+
72+
73+
74+
75+
76+
77+
78+
<h5>Parameters:</h5>
79+
80+
81+
<table class="params">
82+
<thead>
83+
<tr>
84+
85+
<th>Name</th>
86+
87+
88+
89+
90+
91+
92+
<th class="last">Description</th>
93+
</tr>
94+
</thead>
95+
96+
<tbody>
97+
98+
99+
<tr>
100+
101+
<td class="name"><code>object</code></td>
102+
103+
104+
105+
106+
107+
108+
<td class="description last">API result object</td>
109+
</tr>
110+
111+
112+
</tbody>
113+
</table>
114+
115+
116+
117+
118+
119+
120+
<dl class="details">
121+
122+
123+
124+
125+
126+
127+
128+
129+
130+
131+
132+
133+
134+
135+
136+
137+
138+
139+
140+
141+
142+
143+
144+
145+
146+
147+
148+
149+
150+
151+
</dl>
152+
153+
154+
155+
156+
157+
158+
159+
160+
161+
162+
163+
164+
165+
<h5>Examples</h5>
166+
167+
<pre class="prettyprint"><code>blogEntry.then(function (result) {
168+
// sucess function
169+
},function (error) {
170+
// error function
171+
})</code></pre>
172+
173+
<pre class="prettyprint"><code>assetQuery.then(function (result) {
174+
// sucess function
175+
},function (error) {
176+
// error function
177+
})</code></pre>
178+
179+
180+
181+
182+
</div>
183+
184+
185+
186+
187+
188+
189+
190+
191+
192+
193+
194+
195+
196+
197+
198+
199+
200+
201+
</article>
202+
203+
</section>
204+
205+
206+
207+
208+
</div>
209+
210+
<br class="clear">
211+
212+
<footer>
213+
<div class="inner-content center">
214+
<span class="copy-right"><a href="mailto:support-contentstack@built.io" target="_self">support-contentstack@built.io</a> | © 2017 Contentstack. All rights reserved.</span>
215+
</div>
216+
</footer>
217+
218+
<script>prettyPrint();</script>
219+
<script src="scripts/linenumber.js"></script>
220+
</body>
221+
</html>

‎js-sdk-reference_old/contentstack.js.html‎

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<title>contentstack.js - Documentation</title>
6+
7+
<script src="scripts/prettify/prettify.js"></script>
8+
<script src="scripts/prettify/lang-css.js"></script>
9+
<!--[if lt IE 9]>
10+
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11+
<![endif]-->
12+
<link rel="canonical" href="https://www.contentstack.com/docs/platforms/java/api-reference/">
13+
<link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
14+
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
15+
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
16+
</head>
17+
<body>
18+
19+
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
20+
<label for="nav-trigger" class="navicon-button x">
21+
<div class="navicon"></div>
22+
</label>
23+
24+
<label for="nav-trigger" class="overlay"></label>
25+
26+
<nav>
27+
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Result.html">Result</a></li></ul><h3>Global</h3><ul><li><a href="global.html#Contentstack">Contentstack</a></li><li><a href="global.html#CachePolicy">CachePolicy</a></li><li><a href="global.html#Stack">Stack</a></li><li><a href="global.html#setPort">setPort</a></li><li><a href="global.html#setProtocol">setProtocol</a></li><li><a href="global.html#setHost">setHost</a></li><li><a href="global.html#setCachePolicy">setCachePolicy</a></li><li><a href="global.html#setCacheProvider">setCacheProvider</a></li><li><a href="global.html#getCacheProvider">getCacheProvider</a></li><li><a href="global.html#ContentType">ContentType</a></li><li><a href="global.html#Entry">Entry</a></li><li><a href="global.html#Assets">Assets</a></li><li><a href="global.html#Query">Query</a></li><li><a href="global.html#sync">sync</a></li><li><a href="global.html#imageTransform">imageTransform</a></li><li><a href="global.html#only">only</a></li><li><a href="global.html#except">except</a></li><li><a href="global.html#includeReference">includeReference</a></li><li><a href="global.html#language">language</a></li><li><a href="global.html#addQuery">addQuery</a></li><li><a href="global.html#includeSchema">includeSchema</a></li><li><a href="global.html#includeContentType">includeContentType</a></li><li><a href="global.html#includeOwner">includeOwner</a></li><li><a href="global.html#toJSON">toJSON</a></li><li><a href="global.html#AddParam">AddParam</a></li><li><a href="global.html#fetch">fetch</a></li><li><a href="global.html#lessThan">lessThan</a></li><li><a href="global.html#lessThanOrEqualTo">lessThanOrEqualTo</a></li><li><a href="global.html#greaterThan">greaterThan</a></li><li><a href="global.html#greaterThanOrEqualTo">greaterThanOrEqualTo</a></li><li><a href="global.html#notEqualTo">notEqualTo</a></li><li><a href="global.html#containedIn">containedIn</a></li><li><a href="global.html#notContainedIn">notContainedIn</a></li><li><a href="global.html#exists">exists</a></li><li><a href="global.html#notExists">notExists</a></li><li><a href="global.html#ascending">ascending</a></li><li><a href="global.html#descending">descending</a></li><li><a href="global.html#skip">skip</a></li><li><a href="global.html#limit">limit</a></li><li><a href="global.html#or">or</a></li><li><a href="global.html#and">and</a></li><li><a href="global.html#where">where</a></li><li><a href="global.html#count">count</a></li><li><a href="global.html#query">query</a></li><li><a href="global.html#tags">tags</a></li><li><a href="global.html#includeCount">includeCount</a></li><li><a href="global.html#getQuery">getQuery</a></li><li><a href="global.html#regex">regex</a></li><li><a href="global.html#search">search</a></li><li><a href="global.html#find">find</a></li><li><a href="global.html#findOne">findOne</a></li><li><a href="global.html#get">get</a></li><li><a href="global.html#getDownloadUrl">getDownloadUrl</a></li></ul>
28+
</nav>
29+
30+
<div id="main">
31+
32+
<h1 class="page-title">contentstack.js</h1>
33+
34+
35+
36+
37+
38+
39+
<section>
40+
<article>
41+
<pre class="prettyprint source linenums"><code>import Stack from "./stack";
42+
import CacheProvider from './cache-provider/index';
43+
44+
/**
45+
* @method Contentstack
46+
* @description Creates an instance of `Contentstack`.
47+
* @api public
48+
*/
49+
class Contentstack {
50+
51+
constructor(){
52+
/**
53+
* @constant CachePolicy
54+
* @description CachePolicy contains different cache policies constants.
55+
* @example
56+
* Contentstack.CachePolicy.IGNORE_CACHE
57+
* Contentstack.CachePolicy.ONLY_NETWORK
58+
* Contentstack.CachePolicy.CACHE_ELSE_NETWORK
59+
* Contentstack.CachePolicy.NETWORK_ELSE_CACHE
60+
* Contentstack.CachePolicy.CACHE_THEN_NETWORK
61+
*/
62+
this.CachePolicy = CacheProvider.policies;
63+
}
64+
65+
/**
66+
* @method Stack
67+
* @description Initialize an instance of ‘Stack’
68+
* @api public
69+
* @example
70+
*var Stack = Contentstack.Stack('api_key', 'delivery_token', 'environment');
71+
OR
72+
*var Stack = Contentstack.Stack({
73+
* 'api_key':'stack_api_key',
74+
* 'access_token':'stack_delivery_token',
75+
* 'environment':'environment_name'
76+
* });
77+
*
78+
* @returns {Stack}
79+
*/
80+
Stack(...stack_arguments){
81+
return new Stack(...stack_arguments);
82+
}
83+
}
84+
85+
module.exports = new Contentstack();
86+
</code></pre>
87+
</article>
88+
</section>
89+
90+
91+
92+
93+
</div>
94+
95+
<br class="clear">
96+
97+
<footer>
98+
<div class="inner-content center">
99+
<span class="copy-right"><a href="mailto:support-contentstack@built.io" target="_self">support-contentstack@built.io</a> | © 2017 Contentstack. All rights reserved.</span>
100+
</div>
101+
</footer>
102+
103+
<script>prettyPrint();</script>
104+
<script src="scripts/linenumber.js"></script>
105+
</body>
106+
</html>

‎js-sdk-reference_old/fonts/OpenSans-Bold-webfont.eot‎

19.1 KB
Binary file not shown.

0 commit comments

Comments
 (0)