Register a template in the site creation wizard landing.demos.register
We are still updating this page
Some data may be missing — we will complete it shortly.
Scope:
landingWho can execute the method: any user
The method landing.demos.register registers a template in the site and page creation wizard. It returns an array of identifiers for the created templates. The execution of the method is interrupted when an error occurs in the array of elements, and an error description is returned.
Note
To distribute the created site, it is sufficient to obtain an export to a file from the source account and distribute its application by calling this method during installation.
Parameters
|
Parameter |
Description |
|
data |
The result of the method landing.site.fullExport as is. |
|
params |
May contain the following keys (only for on-premise versions):
|
Localization
For clarifications on template localizations, please see here. When localization is required, uncomment the keys lang and lang_original. The principle used here is similar to localization of blocks. Please note that localization applies only to main phrases: page titles, descriptions. Do not overload this array with unnecessary information.
Examples
Note that the example uses the result of the method landing.site.fullExport.
try
{
const response = await $b24.callMethod(
'landing.site.fullExport',
{
id: 326,
params: {
edit_mode: 'Y',
code: 'myfirstsite',
name: 'Auto Repair Shop Website',
description: 'Website for your auto service. Under the hood, everything you need.',
preview_url: 'http://sample.landing.mycompany.com/',
preview: 'http://site.com/preview.jpg',
preview2x: 'http://site.com/preview.jpg',
preview3x: 'http://site.com/preview.jpg',
}
}
);
const result = response.getData().result;
console.info(result);
const data = result.data();
const response2 = await $b24.callMethod(
'landing.demos.register',
{
data: data,
params: {
site_template_id: '',
//lang: {
// en: {
// 'Phrase 1': 'Translate en 1',
// 'Phrase 2': 'Translate en 2'
// },
// de: {
// 'Phrase 1': 'Translate de 1',
// 'Phrase 2': 'Translate de 2'
// }
//},
//lang_original: 'ru'
}
}
);
const result2 = response2.getData().result;
console.info(result2);
}
catch(error)
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'landing.site.fullExport',
[
'id' => 326,
'params' => [
'edit_mode' => 'Y',
'code' => 'myfirstsite',
'name' => 'Auto Repair Shop Website',
'description' => 'Website for your auto service. Under the hood, everything you need.',
'preview_url' => 'http://sample.landing.mycompany.com/',
'preview' => 'http://site.com/preview.jpg',
'preview2x' => 'http://site.com/preview.jpg',
'preview3x' => 'http://site.com/preview.jpg',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
$data = $result;
$response2 = $b24Service
->core
->call(
'landing.demos.register',
[
'data' => $data,
'params' => [
'site_template_id' => '',
//localization array and original language
/*'lang' => [
'en' => [
'Phrase 1' => 'Translate en 1',
'Phrase 2' => 'Translate en 2'
],
'de' => [
'Phrase 1' => 'Translate de 1',
'Phrase 2' => 'Translate de 2'
]
],
'lang_original' => 'ru'*/
],
]
);
$result2 = $response2
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result2, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
BX24.callMethod(
'landing.site.fullExport',
{
id: 326,
params: {
edit_mode: 'Y',
code: 'myfirstsite',//symbolic code of site
name: 'Auto Repair Shop Website',// name of the site (page)
description: 'Website for your auto service. Under the hood, everything you need.',//description of the site
preview_url: 'http://sample.landing.mycompany.com/',//preview URL
preview: 'http://site.com/preview.jpg',//main preview image for the template list (recommended 280x115)
preview2x: 'http://site.com/preview.jpg',//enlarged preview image (recommended 560x230)
preview3x: 'http://site.com/preview.jpg',//retina-size preview image (recommended 845x345)
}
},
function(result)
{
if(result.error())
{
console.error(result.error());
}
else
{
var data = result.data();
console.info(data);
BX24.callMethod(
'landing.demos.register',
{
data: data,
params: {
site_template_id: '',//provide the template value if you are registering for your template (only on-premise!)
//localization array and original language
/*lang: {
en: {
'Phrase 1': 'Translate en 1',
'Phrase 2': 'Translate en 2'
},
de: {
'Phrase 1': 'Translate de 1',
'Phrase 2': 'Translate de 2'
}
},
lang_original: 'de'*/
}
},
function(result)
{
if(result.error())
{
console.error(result.error());
}
else
{
console.info(result.data());
}
}
);
}
}
);
How to Use Examples in Documentation