Object methods

Attention! We strongly recommend first to learn more about REST documentation for Sites module to understand how the module functions (with REST available in Bitrix24 Self-hosted editions). View this documentation as useful source when working with Bitrix24 Self-hosted editions.

Descriptions for object handing methods.

Class	Description	Available from version
addBlock	Adds new block to landing page.
copyAllBlocks	Copies all blocks of specified landing page into the current page.
copyBlock	Copies block from a landing page into the current page.
deleteBlock	Deletes block from current landing page.
downBlock	Swaps block with the below block on the same landing page.
getAreas	Returns array of included landing page areas if they exist.
getBlocks	Returns array of blocks - Block objects
getError	Returns a landing page error.
getId	Returns current page ID.
getMeta	Returns landing page meta data.
getPreview	Gets landing page URL preview (image).
getPublicUrl	Gets landing page URL.
getSiteId	Returns site ID for current landing page.
getDomainId	Returns site domain ID for page.
getSiteTitle	Returns site name for current page.
getFolderId	Returns folder ID.
getSmnSiteId	Returns main module site ID, when page site если сайт страницы привязан к данному сайту.
getTitle	Returns title (name) for current page.
getCode	Returns symbolic code for current page.
getXmlId	Returns current page external ID.
hideBlock	Hides block from landing page.
isActive	Returns true or false depending if landing page is active.
markDeletedBlock	Marks block as deleted/not deleted.
moveBlock	Moves block from a page to the current page.
publication	Publishes a landing page.
resortBlocks	Re-sorts landing page blocks.
showBlock	Activates hidden block on the landing page.
touch	Updates landing page modified date to the current date. Modified user changes to the current user.
unpublic	Removes landing page from publication.
upBlock	Swaps block with the upper block on the same landing page.
view	Main method for displaying the page, used both in editor and when publishing the page.
move	Moves landing page to another site and/or folder.
favoriteBlock	Saves block available at the page in "My blocks".
unFavoriteBlock	Deletes block saved in "My blocks".
resolveIdByPublicUrl	Returns page ID by passed page relative URL.
clearFolderIndex	When page is set as the main (index), this method resets this flag.