Документация для разработчиков
Темная тема

UrlPreview

UrlPreview - класс для работы с "богатыми ссылками".

Обращается к пространству имён:

Метод Описание С версии
checkDynamicPreviewAccess Метод возвращает true если у текущего пользователя есть права на чтение данных сущности за внутренней ссылкой.
getDynamicPreview Метод возвращает HTML код для динамической (внутренний URL) "богатой ссылки".
getMetadataAndHtmlByIds Метод возвращает сохранённые метаданные для массива ID.
getMetadataAndHtmlByUrl Если URL - удалённый, то возвращает метаданные для него. Если URL - локальный, проверяет пользователя на доступ к сущности и возвращает "богатую ссылку".
getMetadataByUrl Метод возвращает метаданные, связанные с указанным URL
isEnabled Метод проверяет разрешено ли использование "богатых ссылок" (UrlPreview) в настройках главного модуля.
isUrlCached Метод проверяет могут ли метаданные для указанного URL быть выданы и закешированы.
reserveIdForUrl Метод создаёт временную запись для URL.
resolveTemporaryMetadata Метод возвращает и хранит метаданные для временной записи созданной методом reserveIdForUrl.
setMetadataImage Метод устанавливает картинку с указанным ID, отображающуюся для богатой ссылки.
showEdit Метод возвращает html код "богатой ссылки" для вывода в режиме редактирования.
showView Метод возвращает html код для "богатой ссылки".
sign Метод подписывает значение с использованием соли \UrlPreview.
getImAttach Метод возвращает приложение к сообщению мессенджера. 17.0.0


Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2024, «1С-Битрикс», 2024
Наверх