CCAPI Updating Elements - Revision history

Gcronkright: /* Overview */

2025-02-05T21:11:00Z

‎Overview

Rwest: moved CCAPI Element to CCAPI Updating Elements: There was no "Elements" element - made this more concept based

2010-03-30T00:05:41Z

moved CCAPI Element to CCAPI Updating Elements: There was no "Elements" element - made this more concept based

Rwest at 00:04, 30 March 2010

2010-03-30T00:04:58Z

Renee.mckechnie: /* Chaining Updates with Page Creates */

2009-12-20T22:47:29Z

‎Chaining Updates with Page Creates

Renee.mckechnie at 22:46, 20 December 2009

2009-12-20T22:46:39Z

Renee.mckechnie: Created page with '== Overview== The CCAPI Element object allows you to add/edit content for textblocks and custom elements. It requires that your site have a proper [[CCAPI Conf…'

2009-11-22T16:11:19Z

Created page with '== Overview== The CCAPI Element object allows you to add/edit content for textblocks and custom elements. It requires that your site have a proper [[CCAPI Conf…'

New page

== Overview==
The [[CCAPI_Element|CCAPI Element]] object allows you to add/edit content for textblocks and custom elements. It requires that your site have a proper [[CCAPI Config| CCAPI Config]] file established in the site where you would like to use the CCAPI

== Example Usage ==

<cfscript>
// custom element sample
tmp = structNew();
tmp.field1 = "test";
tmp.field2 = "test 2";
// get the content object from the factory
csContentObj = server.ADF.getBean("CSContent_1_0");
// call populate content (sorry I wish it was more difficult then that)
results = csContentObj.populateContent("elementName", tmp);
</cfscipt>

<cfscript>
// textblock sample
tmp = structNew();
tmp.textblock = "test";
tmp.caption = "test 2";
// get the content object from the factory
csContentObj = server.ADF.getBean("CSContent_1_0");
// call populate content (sorry I wish it was more difficult then that)
results = csContentObj.populateContent("elementName", tmp);
</cfscipt>

<cfscript>
// custom element sample with update
tmp = structNew();
tmp.field1 = "test";
tmp.field2 = "test 2";
tmp.dataPageID = 29333;
// get the content object from the factory
csContentObj = server.ADF.getBean("CSContent_1_0");
// call populate content (sorry I wish it was more difficult then that)
results = csContentObj.populateContent("elementName", tmp);
</cfscipt>

Based on the "name" of the element passed in, the component will find the configuration from the [[CCAPI Config| CCAPI Config]] file and load the proper pageID/elementID combo - and then populate content.

== Updating Content ==
By default if you are working with a textblock content will always be updated. If you would like to update a Custom Element record then be sure to add "dataPageID" into your data struct (see example above). You will receive the "dataPageID" in your render handler or if you use [[CEData|CEData]] - it will be the "pageID" field for the record you are using.

== Chaining Updates with Page Creates ==
If you would like to chain a page creation with a page content update then you can also add the "pageID"/"subsiteID" combo to your data before passing to the populateCustomElement method.

Note: You would be more likely to chain a populateCustom Element with a createPage if the page you
were creating contained a Local Custom Element

Note:
dataPageID = the Custom Element Instance Record
pageID = the pages ID which contains a Custom Element

← Older revision		Revision as of 21:11, 5 February 2025
Line 1:		Line 1:
	== Overview==		== Overview==
		+
		+	IMPORTANT: With the release of CommonSpot 11 and ADF 2.7 it is recommended to use the CommonSpot Custom Data API or the ADF's ceRecordAPI wrappers to 'populate custom elements' instead of using CCAPI. See the [[ceRecordAPI Reference]] for more info.
		+
	Two of the key calls available in the CommonSpot CCAPI are "populateTextblock" and "populateCustomElement". The CCAPI Libary Component has a CFC called "csContent" which will make easy to call either of these two calls.		Two of the key calls available in the CommonSpot CCAPI are "populateTextblock" and "populateCustomElement". The CCAPI Libary Component has a CFC called "csContent" which will make easy to call either of these two calls.

@@ Line 1: / Line 1: @@
 == Overview==
-The [[CCAPI_Element|CCAPI Element]] object allows you to add or edit content for textblocks and custom elements.  Your site must have a proper [[CCAPI Config| CCAPI Config]] file established in the site where you would like to use the CCAPI.
+Two of the key calls available in the CommonSpot CCAPI are "populateTextblock" and "populateCustomElement".  The CCAPI Libary Component has a CFC called "csContent" which will make easy to call either of these two calls.
 == Example Usage ==

@@ Line 46: / Line 46: @@
 == Chaining Updates with Page Creates ==
 If you would like to chain a page creation with a page content update, add the  "pageID"/"subsiteID" combo to your data before passing to the populateCustomElement method.
 Note: You would be more likely to chain a populateCustom Element with a createPage if the page you were creating contained a Local Custom Element.
 [[Category:CCAPI]]

← Older revision	Revision as of 00:05, 30 March 2010
(No difference)

@@ Line 1: / Line 1: @@
 == Overview==
-The [[CCAPI_Element|CCAPI Element]] object allows you to add/edit content for textblocks and custom elements.  It requires that your site have a proper [[CCAPI Config| CCAPI Config]] file established in the site where you would like to use the CCAPI
+The [[CCAPI_Element|CCAPI Element]] object allows you to add or edit content for textblocks and custom elements.  Your site must have a proper [[CCAPI Config| CCAPI Config]] file established in the site where you would like to use the CCAPI.
 == Example Usage ==
@@ Line 39: / Line 39: @@
-Based on the "name" of the element passed in, the component will find the configuration from the [[CCAPI Config| CCAPI Config]] file and load the proper pageID/elementID combo - and then populate content.
+Based on the "name" of the element passed in, the component will find the configuration from the [[CCAPI Config| CCAPI Config]] file and load the proper pageID/elementID combo, then populate content.
 == Updating Content ==
-By default if you are working with a textblock content will always be updated.  If you would like to update a Custom Element record then be sure to add "dataPageID" into your data struct (see example above).  You will receive the "dataPageID" in your render handler or if you use [[CEData|CEData]] - it will be the "pageID" field for the record you are using.
+By default, if you are working with a textblock, content will always be updated.  If you would like to update a Custom Element record, be sure to add "dataPageID" into your data struct (see example above).  You will receive the "dataPageID" in your renderhandler.  If you use [[CEData|CEData]], it will be the "pageID" field for the record you are using.
 == Chaining Updates with Page Creates ==
-If you would like to chain a page creation with a page content update then you can also add the  "pageID"/"subsiteID" combo to your data before passing to the populateCustomElement method.
+If you would like to chain a page creation with a page content update, add the  "pageID"/"subsiteID" combo to your data before passing to the populateCustomElement method.
- Note: You would be more likely to chain a populateCustom Element with a createPage if the page you
+Note: You would be more likely to chain a populateCustom Element with a createPage if the page you were creating contained a Local Custom Element.
- Note:
+Note:
- dataPageID = the Custom Element Instance Record
+* dataPageID = the Custom Element Instance Record
- pageID = the pages ID which contains a Custom Element
+* pageID = the pages ID which contains a Custom Element