Методы объекта
Внимание! Мы настоятельно рекомендуем ознакомиться сначала с REST-документацией модуля Сайты, чтобы понять как модуль функционирует (тем более REST доступен и в коробочной версии). Данную документацию рассматривайте как подспорье при работе в коробке, когда вам действительно мало функционала REST, или вы хотите детальнее разобраться в API.
Описание методов работы с объектом.
| Метод | Описание | С версии |
|---|---|---|
| addBlock | Добавление нового блока на страницу. | |
| clearFolderIndex | Если страница установлена главной (индексной) страницей папки, то метод этот флаг сбрасывает. | 21.800.0 |
| copyAllBlocks | Копирует все блоки указанной страницы в текущую. | |
| copyBlock | Копирует блок со сторонней страницы в данную. | |
| deleteBlock | Удаление блока из текущей страницы. | |
| downBlock | Меняет блок местами с нижестоящим на данной странице. | |
| favoriteBlock | Метод сохраняет имеющийся на странице блок в "Мои блоки". | 21.800.0 |
| getAreas | Вернет массив включаемых областей страницы, если они существуют. | |
| getBlocks | Вернет массив блоков – объекты сущностей Блок | |
| getDomainId | Метод возвращает идентификатор домена сайта страницы. | |
| getError | Вернет объект ошибки, если в моменты работы со страницей произошла ошибка. | |
| getFolderId | Метод возвращает идентификатор папки. | |
| getId | Вернет идентификатор текущей страницы. | |
| getMeta | Вернет мета-информацию страницы. | |
| getPreview | Получение адреса превью страницы (картинки). | |
| getPublicUrl | Получение адреса страницы. | |
| getSiteId | Вернет идентификатор сайта текущей страницы. | |
| getSiteTitle | Метод возвращает название сайта текущей страницы. | |
| getSmnSiteId | Вернет символьный код сайта главного модуля в случае, если сайт страницы привязан к данному сайту. | |
| getTitle | Вернет заголовок (название) текущей страницы. | |
| getCode | Вернет символьный код текущей страницы. | |
| getXmlId | Вернет внешний код текущей страницы. | |
| hideBlock | Скрывает блок со страницы. | |
| isActive | Вернет true или false в зависимости от того, активна или нет страница. | |
| markDeletedBlock | Помечает блок как удаленный / не удаленный. | |
| move | Метод перемещает страницу в другой сайт и/или папку. | 21.800.0 |
| moveBlock | Перемещает блок со сторонней страницы в данную. | |
| publication | Публикация страницы. | |
| copy | Метод для копирования страницы. | 20.0.137 |
| resolveIdByPublicUrl | Метод по переданному относительному URL страницы возвращает идентификатор страницы. | 21.800.0 |
| resortBlocks | Пересортировка блоков страницы. | |
| showBlock | Активирует скрытый блок на странице. | |
| touch | Дата изменения страницы меняется на текущую, идентификатор изменившего пользователя меняется на текущего. | |
| unFavoriteBlock | Метод удаляет блок, который был сохранен в "Мои блоки". | 21.800.0 |
| unpublic | Снятие с публикации страницы. | |
| upBlock | Меняет блок местами с вышестоящим на данной странице. | |
| view | Основной метод вывода страницы, используемый как в редакторе, так и при публикации. |
© «Битрикс», 2001-2023, «1С-Битрикс», 2023
Пользовательские комментарии
Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.Для этого нужно всего лишь авторизоваться на сайте
Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.
Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.