Skip to content

Commit 6fcf5cc

Browse files
Added new Query support of MultiCtReference
1 parent 4824270 commit 6fcf5cc

25 files changed

+527
-110
lines changed

config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
const config = {
22
protocol: "https",
3-
host: "cdn.contentstack.io",
3+
host: "stag-cdn.contentstack.io",
44
port: 443,
55
version: "v3",
66
urls: {

contentstack-templates/tmpl/layout.tmpl

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,22 @@
99
<!--[if lt IE 9]>
1010
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
1111
<![endif]-->
12+
<link rel="canonical" href="https://www.contentstack.com/docs/platforms/java/api-reference/">
1213
<link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
1314
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
1415
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
16+
<!-- Google Tag Manager -->
17+
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
18+
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
19+
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
20+
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
21+
})(window,document,'script','dataLayer','GTM-WGP99J7');</script>
22+
<!-- End Google Tag Manager -->
1523
</head>
1624
<body>
17-
25+
<!-- Google Tag Manager (noscript) -->
26+
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-WGP99J7" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
27+
<!-- End Google Tag Manager (noscript) -->
1828
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
1929
<label for="nav-trigger" class="navicon-button x">
2030
<div class="navicon"></div>

dist/node/contentstack.js

Lines changed: 75 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -906,9 +906,16 @@ var Stack = function () {
906906
/**
907907
* @method fetch
908908
* @memberOf Stack
909-
* @param {String} uid - uid of the entry
910-
* @description An initializer is responsible for creating Entry object
911-
* @returns {Entry}
909+
* @description This method returns the complete information of a specific content type.
910+
* @example
911+
* let single_contenttype = Stack.ContentType(content_type_uid).fetch()
912+
* single_contenttype
913+
* .then(function(result) {
914+
* // 'result' is a single contentType information.
915+
* }).catch((error) => {
916+
* console.log(error)
917+
* });
918+
* @returns {ContentType}
912919
* @instance
913920
*/
914921

@@ -931,7 +938,23 @@ var Stack = function () {
931938
* @method Assets
932939
* @memberOf Stack
933940
* @param {String} uid - uid of the asset
934-
* @description Retrieves the asset based on the specified UID
941+
* @description Retrieves all assets of a stack by default. To retrieve a single asset, specify its UID.
942+
* @example
943+
* let data = Stack.Assets('bltsomething123').toJSON().fetch()
944+
* data
945+
* .then(function(result) {
946+
* // ‘result’ is a single asset object of specified uid
947+
* }, function(error) {
948+
* // error function
949+
* })
950+
* @example
951+
* let data = Stack.Assets().toJSON().find()
952+
* data
953+
* .then(function(result) {
954+
* // ‘result’ will display all assets present in stack
955+
* }, function(error) {
956+
* // error function
957+
* })
935958
* @returns {Assets}
936959
* @instance
937960
*/
@@ -999,10 +1022,10 @@ var Stack = function () {
9991022
/**
10001023
* @method getContentTypes
10011024
* @memberOf Stack
1002-
* @description getContentTypes get all the ContentTypes.
1025+
* @description This method returns comprehensive information of all the content types of a particular stack in your account.
10031026
* @example Stack.getContentTypes()
10041027
* @example
1005-
* let data = Stack.getLastActivites()
1028+
* let data = Stack.getContentTypes()
10061029
* data
10071030
* .then(function(result) {
10081031
* // 'result' is list of contentTypes.
@@ -1535,7 +1558,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
15351558
function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } else { var newObj = {}; if (obj != null) { for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) newObj[key] = obj[key]; } } newObj.default = obj; return newObj; } }
15361559

15371560
//JS SDK version
1538-
var version = '3.5.2';
1561+
var version = '3.6.0';
15391562
var environment = void 0,
15401563
api_key = void 0;
15411564

@@ -1979,6 +2002,23 @@ var Entry = function () {
19792002
return this;
19802003
}
19812004

2005+
/**
2006+
* @method includeReferenceContentTypeUid
2007+
* @memberOf Entry
2008+
* @deprecated since verion 3.6.0
2009+
* @description Include Reference Content Type Uid of the current content type details.
2010+
* @example Stack.ContentType("contentType_uid").Entry("entry_uid").includeReferenceContentt().fetch()
2011+
* @returns {Entry}
2012+
* @instance
2013+
*/
2014+
2015+
}, {
2016+
key: "IncludeReferenceContentTypeUID",
2017+
value: function IncludeReferenceContentTypeUID() {
2018+
this._query['include_reference_content_type_uid'] = true;
2019+
return this;
2020+
}
2021+
19822022
/**
19832023
* @method includeContentType
19842024
* @memberOf Entry
@@ -2646,6 +2686,23 @@ var Query = function (_Entry) {
26462686
}
26472687
}
26482688

2689+
/**
2690+
* @method includeReferenceContentTypeUid
2691+
* @memberOf Entry
2692+
* @deprecated since verion 3.6.1
2693+
* @description Include Reference Content Type Uid of the current content type schema.
2694+
* @example Stack.ContentType("contentType_uid").Query().IncludeReferenceContentTypeUID().find()
2695+
* @returns {Entry}
2696+
* @instance
2697+
*/
2698+
2699+
}, {
2700+
key: 'includeReferenceContentTypeUID',
2701+
value: function includeReferenceContentTypeUID() {
2702+
this._query['include_reference_content_type_uid'] = true;
2703+
return this;
2704+
}
2705+
26492706
/**
26502707
* @method includeCount
26512708
* @memberOf Query
@@ -2832,6 +2889,7 @@ var Query = function (_Entry) {
28322889
query: this._query
28332890
}
28342891
};
2892+
28352893
return Utils.sendRequest(this);
28362894
}
28372895
}]);
@@ -2871,7 +2929,7 @@ Object.defineProperty(exports, "__esModule", {
28712929
});
28722930
var config = {
28732931
protocol: "https",
2874-
host: "cdn.contentstack.io",
2932+
host: "stag-cdn.contentstack.io",
28752933
port: 443,
28762934
version: "v3",
28772935
urls: {
@@ -7563,7 +7621,7 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Cons
75637621
* @class
75647622
Assets
75657623
* @summary Creates an instance of `Assets`.
7566-
* @description Retrieves the asset based on the specified UID
7624+
* @description Retrieves all assets of a stack by default. To retrieve a single asset, specify its UID.
75677625
* @param {String} uid - uid of asset you want to retrieve
75687626
* @example
75697627
* let data = Stack.Assets('bltsomething123').toJSON().fetch()
@@ -7573,6 +7631,14 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Cons
75737631
* }, function(error) {
75747632
* // error function
75757633
* })
7634+
* @example
7635+
* let data = Stack.Assets().toJSON().find()
7636+
* data
7637+
* .then(function(result) {
7638+
* // ‘result’ will display all assets present in stack
7639+
* }, function(error) {
7640+
* // error function
7641+
* })
75767642
* @returns {Assets}
75777643
* @instance
75787644
*/

examples/node/contentstack-demo.js

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ class ContentstackDemo {
2424
*/
2525
getEntries(contentTypeUid) {
2626
contentTypeUid = contentTypeUid || 'source'
27-
return this.Stack.ContentType(contentTypeUid).Query().includeReference('secondary_section.reference.reference').find()
27+
return this.Stack.ContentType("source").Query().includeSchema().IncludeReferenceContentTypeUID().find()
2828
}
2929

3030
/**
@@ -61,11 +61,6 @@ class ContentstackDemo {
6161
return this.Stack.getContentType(uid)
6262
}
6363

64-
65-
66-
67-
68-
6964
/**
7065
* fetchEntry
7166
* @description : fetchEntry is used to get the specified uid entry

examples/node/index.js

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,11 @@
22

33
const ContentstackDemo = require('./contentstack-demo.js')
44

5-
//const Demo = new ContentstackDemo({ 'api_key': "blt292960b854e5170e", 'access_token': "blt468d2af41a0f061c", 'environment': "development"})
65
const Demo = new ContentstackDemo({ 'api_key': "", 'access_token': "", 'environment': ""})
76

87

98
//get all the entries
10-
Demo.getContentTypedemo()
9+
Demo.getEntries()
1110
.then(function(result, err) {
1211
// console.log("Result>>>>>>>>>>>>>>>")
1312
try {

js-sdk-reference/Assets.html

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
<label for="nav-trigger" class="overlay"></label>
3434

3535
<nav>
36-
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Contentstack.html">Contentstack</a><ul class='methods'><li data-type='method'><a href="Contentstack.html#Stack">Stack</a></li></ul></li><li><a href="Stack.html">Stack</a><ul class='methods'><li data-type='method'><a href="Stack.html#setPort">setPort</a></li><li data-type='method'><a href="Stack.html#setProtocol">setProtocol</a></li><li data-type='method'><a href="Stack.html#setHost">setHost</a></li><li data-type='method'><a href="Stack.html#setCachePolicy">setCachePolicy</a></li><li data-type='method'><a href="Stack.html#setCacheProvider">setCacheProvider</a></li><li data-type='method'><a href="Stack.html#clearByQuery">clearByQuery</a></li><li data-type='method'><a href="Stack.html#clearByContentType">clearByContentType</a></li><li data-type='method'><a href="Stack.html#clearAll">clearAll</a></li><li data-type='method'><a href="Stack.html#getCacheProvider">getCacheProvider</a></li><li data-type='method'><a href="Stack.html#ContentType">ContentType</a></li><li data-type='method'><a href="Stack.html#Entry">Entry</a></li><li data-type='method'><a href="Stack.html#fetch">fetch</a></li><li data-type='method'><a href="Stack.html#Assets">Assets</a></li><li data-type='method'><a href="Stack.html#Query">Query</a></li><li data-type='method'><a href="Stack.html#getLastActivites">getLastActivites</a></li><li data-type='method'><a href="Stack.html#getContentTypes">getContentTypes</a></li><li data-type='method'><a href="Stack.html#sync">sync</a></li><li data-type='method'><a href="Stack.html#imageTransform">imageTransform</a></li></ul></li><li><a href="Assets.html">Assets</a><ul class='methods'><li data-type='method'><a href="Assets.html#toJSON">toJSON</a></li><li data-type='method'><a href="Assets.html#addParam">addParam</a></li><li data-type='method'><a href="Assets.html#fetch">fetch</a></li></ul></li><li><a href="Entry.html">Entry</a><ul class='methods'><li data-type='method'><a href="Entry.html#only">only</a></li><li data-type='method'><a href="Entry.html#except">except</a></li><li data-type='method'><a href="Entry.html#includeReference">includeReference</a></li><li data-type='method'><a href="Entry.html#language">language</a></li><li data-type='method'><a href="Entry.html#addQuery">addQuery</a></li><li data-type='method'><a href="Entry.html#includeSchema">includeSchema</a></li><li data-type='method'><a href="Entry.html#includeContentType">includeContentType</a></li><li data-type='method'><a href="Entry.html#includeOwner">includeOwner</a></li><li data-type='method'><a href="Entry.html#toJSON">toJSON</a></li><li data-type='method'><a href="Entry.html#addParam">addParam</a></li><li data-type='method'><a href="Entry.html#fetch">fetch</a></li></ul></li><li><a href="Query.html">Query</a><ul class='methods'><li data-type='method'><a href="Query.html#lessThan">lessThan</a></li><li data-type='method'><a href="Query.html#lessThanOrEqualTo">lessThanOrEqualTo</a></li><li data-type='method'><a href="Query.html#greaterThan">greaterThan</a></li><li data-type='method'><a href="Query.html#greaterThanOrEqualTo">greaterThanOrEqualTo</a></li><li data-type='method'><a href="Query.html#notEqualTo">notEqualTo</a></li><li data-type='method'><a href="Query.html#containedIn">containedIn</a></li><li data-type='method'><a href="Query.html#notContainedIn">notContainedIn</a></li><li data-type='method'><a href="Query.html#exists">exists</a></li><li data-type='method'><a href="Query.html#notExists">notExists</a></li><li data-type='method'><a href="Query.html#ascending">ascending</a></li><li data-type='method'><a href="Query.html#descending">descending</a></li><li data-type='method'><a href="Query.html#beforeUid">beforeUid</a></li><li data-type='method'><a href="Query.html#afterUid">afterUid</a></li><li data-type='method'><a href="Query.html#skip">skip</a></li><li data-type='method'><a href="Query.html#limit">limit</a></li><li data-type='method'><a href="Query.html#or">or</a></li><li data-type='method'><a href="Query.html#and">and</a></li><li data-type='method'><a href="Query.html#where">where</a></li><li data-type='method'><a href="Query.html#count">count</a></li><li data-type='method'><a href="Query.html#query">query</a></li><li data-type='method'><a href="Query.html#tags">tags</a></li><li data-type='method'><a href="Query.html#includeCount">includeCount</a></li><li data-type='method'><a href="Query.html#addParam">addParam</a></li><li data-type='method'><a href="Query.html#getQuery">getQuery</a></li><li data-type='method'><a href="Query.html#regex">regex</a></li><li data-type='method'><a href="Query.html#search">search</a></li><li data-type='method'><a href="Query.html#find">find</a></li><li data-type='method'><a href="Query.html#findOne">findOne</a></li></ul></li><li><a href="Result.html">Result</a><ul class='methods'><li data-type='method'><a href="Result.html#toJSON">toJSON</a></li><li data-type='method'><a href="Result.html#get">get</a></li><li data-type='method'><a href="Result.html#getDownloadUrl">getDownloadUrl</a></li></ul></li></ul>
36+
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Contentstack.html">Contentstack</a><ul class='methods'><li data-type='method'><a href="Contentstack.html#Stack">Stack</a></li></ul></li><li><a href="Stack.html">Stack</a><ul class='methods'><li data-type='method'><a href="Stack.html#setPort">setPort</a></li><li data-type='method'><a href="Stack.html#setProtocol">setProtocol</a></li><li data-type='method'><a href="Stack.html#setHost">setHost</a></li><li data-type='method'><a href="Stack.html#setCachePolicy">setCachePolicy</a></li><li data-type='method'><a href="Stack.html#setCacheProvider">setCacheProvider</a></li><li data-type='method'><a href="Stack.html#clearByQuery">clearByQuery</a></li><li data-type='method'><a href="Stack.html#clearByContentType">clearByContentType</a></li><li data-type='method'><a href="Stack.html#clearAll">clearAll</a></li><li data-type='method'><a href="Stack.html#getCacheProvider">getCacheProvider</a></li><li data-type='method'><a href="Stack.html#ContentType">ContentType</a></li><li data-type='method'><a href="Stack.html#Entry">Entry</a></li><li data-type='method'><a href="Stack.html#fetch">fetch</a></li><li data-type='method'><a href="Stack.html#Assets">Assets</a></li><li data-type='method'><a href="Stack.html#Query">Query</a></li><li data-type='method'><a href="Stack.html#getLastActivites">getLastActivites</a></li><li data-type='method'><a href="Stack.html#getContentTypes">getContentTypes</a></li><li data-type='method'><a href="Stack.html#sync">sync</a></li><li data-type='method'><a href="Stack.html#imageTransform">imageTransform</a></li></ul></li><li><a href="Assets.html">Assets</a><ul class='methods'><li data-type='method'><a href="Assets.html#toJSON">toJSON</a></li><li data-type='method'><a href="Assets.html#addParam">addParam</a></li><li data-type='method'><a href="Assets.html#fetch">fetch</a></li></ul></li><li><a href="Entry.html">Entry</a><ul class='methods'><li data-type='method'><a href="Entry.html#only">only</a></li><li data-type='method'><a href="Entry.html#except">except</a></li><li data-type='method'><a href="Entry.html#includeReference">includeReference</a></li><li data-type='method'><a href="Entry.html#language">language</a></li><li data-type='method'><a href="Entry.html#addQuery">addQuery</a></li><li data-type='method'><a href="Entry.html#includeSchema">includeSchema</a></li><li data-type='method'><a href="Entry.html#includeReferenceContentTypeUid">includeReferenceContentTypeUid</a></li><li data-type='method'><a href="Entry.html#includeContentType">includeContentType</a></li><li data-type='method'><a href="Entry.html#includeOwner">includeOwner</a></li><li data-type='method'><a href="Entry.html#toJSON">toJSON</a></li><li data-type='method'><a href="Entry.html#addParam">addParam</a></li><li data-type='method'><a href="Entry.html#fetch">fetch</a></li><li data-type='method'><a href="Entry.html#includeReferenceContentTypeUid">includeReferenceContentTypeUid</a></li></ul></li><li><a href="Query.html">Query</a><ul class='methods'><li data-type='method'><a href="Query.html#lessThan">lessThan</a></li><li data-type='method'><a href="Query.html#lessThanOrEqualTo">lessThanOrEqualTo</a></li><li data-type='method'><a href="Query.html#greaterThan">greaterThan</a></li><li data-type='method'><a href="Query.html#greaterThanOrEqualTo">greaterThanOrEqualTo</a></li><li data-type='method'><a href="Query.html#notEqualTo">notEqualTo</a></li><li data-type='method'><a href="Query.html#containedIn">containedIn</a></li><li data-type='method'><a href="Query.html#notContainedIn">notContainedIn</a></li><li data-type='method'><a href="Query.html#exists">exists</a></li><li data-type='method'><a href="Query.html#notExists">notExists</a></li><li data-type='method'><a href="Query.html#ascending">ascending</a></li><li data-type='method'><a href="Query.html#descending">descending</a></li><li data-type='method'><a href="Query.html#beforeUid">beforeUid</a></li><li data-type='method'><a href="Query.html#afterUid">afterUid</a></li><li data-type='method'><a href="Query.html#skip">skip</a></li><li data-type='method'><a href="Query.html#limit">limit</a></li><li data-type='method'><a href="Query.html#or">or</a></li><li data-type='method'><a href="Query.html#and">and</a></li><li data-type='method'><a href="Query.html#where">where</a></li><li data-type='method'><a href="Query.html#count">count</a></li><li data-type='method'><a href="Query.html#query">query</a></li><li data-type='method'><a href="Query.html#tags">tags</a></li><li data-type='method'><a href="Query.html#includeCount">includeCount</a></li><li data-type='method'><a href="Query.html#addParam">addParam</a></li><li data-type='method'><a href="Query.html#getQuery">getQuery</a></li><li data-type='method'><a href="Query.html#regex">regex</a></li><li data-type='method'><a href="Query.html#search">search</a></li><li data-type='method'><a href="Query.html#find">find</a></li><li data-type='method'><a href="Query.html#findOne">findOne</a></li></ul></li><li><a href="Result.html">Result</a><ul class='methods'><li data-type='method'><a href="Result.html#toJSON">toJSON</a></li><li data-type='method'><a href="Result.html#get">get</a></li><li data-type='method'><a href="Result.html#getDownloadUrl">getDownloadUrl</a></li></ul></li></ul>
3737
</nav>
3838

3939
<div id="main">
@@ -73,7 +73,7 @@ <h4 class="name" id="Assets"><span class="type-signature"></span>new Assets<span
7373

7474

7575
<div class="description">
76-
Retrieves the asset based on the specified UID
76+
Retrieves all assets of a stack by default. To retrieve a single asset, specify its UID.
7777
</div>
7878

7979

@@ -171,7 +171,7 @@ <h5>Parameters:</h5>
171171

172172

173173

174-
<h5>Example</h5>
174+
<h5>Examples</h5>
175175

176176
<pre class="prettyprint"><code>let data = Stack.Assets('bltsomething123').toJSON().fetch()
177177
data
@@ -181,6 +181,14 @@ <h5>Example</h5>
181181
// error function
182182
})</code></pre>
183183

184+
<pre class="prettyprint"><code>let data = Stack.Assets().toJSON().find()
185+
data
186+
.then(function(result) {
187+
// ‘result’ will display all assets present in stack
188+
}, function(error) {
189+
// error function
190+
})</code></pre>
191+
184192

185193

186194

0 commit comments

Comments
 (0)