Типы данных

  • Просмотры Просмотры: 546
  • Последнее обновление Последнее обновление:

Навигация

API
   Конечные точки
   Типы данных
Страница
  • Данная страница содержит информацию обо всех типах данных, которые используются в API.

    Стандартные типы данных​

    • string - Стандартное строковое значение
    • integer - Стандартный целочисленный тип данных
    • bool - Стандартное булевое значение. Может принимать значения true/false
    • object - Абстрактный тип данных, позволяющий хранить пары вида (ключ, значение)
    • array - Структура данных, хранящая набор значений, идентифицируемых по индексу
    • float - Стандартное число с плавающей запятой

    Тип данных: Attachment
    Объект, содержащий информацию о вложении

    Колонка Тип Описание
    filename integer Оригинальное название файла
    file_size integer Размер файла в байтах
    height integer Ширина (для изображений). Для иных файлов вернет 0
    width integer Высота (для изображений). Для иных файлов вернет 0
    thumbnail_url string Ссылка на миниатюру (только для изображений)
    direct_url string Прямая ссылка на скачивание
    is_video bool Является ли содержмое видеофайлом
    is_audio bool Является ли содержмое аудиофайлом
    attachment_id integer ID вложения
    content_type string Тип контента, где используется вложение
    content_id integer ID контента, где используется вложение
    attach_date integer Время создания вложения в Unix Time
    view_count integer Количество просмотров вложения

    Тип данных: Conversation
    Объект, содержащий информацию о переписке

    Колонка Тип Описание
    username string Имя отправителя
    recipients object Получатели. Пара ключ-значение идентификаторов и имен пользователей-получателей
    is_starred bool Истинно, если просматривающий пользователь пометил беседу
    is_unread bool Истинно, если эта перписка не прочитана
    can_edit bool Возможно ли изменить
    can_reply bool Возможно ли ответить
    can_invite bool Возможно ли пригласить пользователей в переписку
    can_upload_attachment bool Возможно ли загружать вложения
    view_url string Прямая ссылка на переписку
    conversation_id integer ID переписки
    title string Тема переписки
    user_id integer ID пользователя, который создал переписку
    start_date integer Дата создания переписки в Unix Time
    open_invite bool Описание отсутствует
    conversation_open bool Открыта ли переписка
    reply_count integer Количество сообщений (без учета первого сообщения)
    recipient_count integer Количество получателей
    first_message_id integer ID первого сообщения
    last_message_date integer Дата последнего сообщения в Unix Time
    last_message_id integer ID последнего сообщения
    last_message_user_id integer ID пользователя последнего сообщения
    Starter User Информация о пользователе-отправителе

    Тип данных: ConversationMessage
    Объект, содержащий информацию о сообщении в переписке

    Колонка Тип Описание
    username string Имя пользователя
    is_unread bool Истинно, если эта перписка не прочитана
    message_parsed string HTML-версия содержимого сообщения
    can_edit bool Возможно ли изменить
    can_react bool Возможно ли использовать реакции
    view_url string Прямая ссылка на сообщение
    Conversation Conversation Если требуется по контексту, объект диалога, в который входит это сообщение
    Attachments Attachment[] Список вложений (если есть)
    is_reacted_to bool Истинно, если просматривающий пользователь отреагировал на этот контент
    visitor_reaction_id integer Если просматривающий пользователь отреагировал, ID реакции, которую он использовал
    message_id integer ID сообщения
    conversation_id integer ID переписки
    message_date integer Дата сообщения в Unix Time
    user_id integer ID пользователя
    message string Содержимое сообщения с учетом BB-кодов
    attach_count integer Количество вложений
    reaction_score integer Количество реакций
    User User Информация о пользователе

    Тип данных: Forum
    Объект, содержащий информацию о форуме

    Колонка Тип Описание
    forum_type_id string Описание отсутствует
    allow_posting bool Описание отсутствует
    require_prefix bool Описание отсутствует
    min_tags integer Описание отсутствует

    Тип данных: LinkForum
    Объект, содержащий информацию о форуме-ссылке

    Колонка Тип Описание
    link_url string Описание отсутствует
    redirect_count integer Описание отсутствует

    Тип данных: Node
    Объект, содержащий информацию об узле

    Колонка Тип Описание
    breadcrumbs array Список хлебных крошек для этого узла, включая node_id, title и node_type_id
    type_data object Данные, относящиеся к конкретному типу узла, который он представляет. Содержание будет существенно отличаться
    view_url string Прямая ссылка на узел
    node_id integer ID узла
    title string Название узла
    node_name string Описание отсутствует
    description string Описание
    node_type_id string Тип узла
    parent_node_id integer ID родительского узла
    display_order integer Порядок отображения
    display_in_list bool Показывать в списке узлов

    Тип данных: Page
    Объект, содержащий информацию о странице

    Колонка Тип Описание
    publish_date integer Дата создания в Unix Time
    view_count integer Количество просмотров

    Тип данных: Poll
    Объект, содержащий информацию о голосовании

    Колонка Тип Описание
    can_vote bool Может голосовать
    has_voted bool Истинно, если пользователь проголосовал
    responses array Список возможных ответов с текстом, подсчетом голосов (если видны)
    poll_id integer ID голосования
    question string Вопрос
    voter_count integer Описание отсутствует
    public_votes bool Описание отсутствует
    max_votes integer Описание отсутствует
    close_date integer Дата закрытия голосования в Unix Time
    change_vote bool Описание отсутствует
    view_results_unvoted bool Описание отсутствует

    Тип данных: Post
    Объект, содержащий информацию о сообщении в теме

    Колонка Тип Описание
    username string Имя пользователя
    is_first_post bool Является первым сообщением
    is_last_post bool Является последним сообщением
    is_unread bool Истинно, если сообщение не является прочитанным
    message_parsed string HTML-версия содержимого сообщения
    can_edit bool Возможно ли изменить
    can_soft_delete bool Возможно ли удалить
    can_hard_delete bool Возможно ли стереть
    can_react bool Возможно ли использовать реакции
    can_view_attachments bool Возможно ли просматривать вложения
    view_url string Прямая ссылка на сообщение
    Thread Thread Сущность Thread, к которому принадлежит сообщение
    Attachments Attachment[] Список вложений (если есть)
    is_reacted_to bool Стоит ли реакция от владельца API ключа
    visitor_reaction_id integer ID реакции
    vote_score integer Оценка содержания (если поддерживается)
    can_content_vote bool Возможно ли голосовать за этот контент
    allowed_content_vote_types string[] Список типов голосования, разрешенных для этого контента
    is_content_voted bool Истинно, если пользователь, просматривающий этот контент, проголосовал за него
    visitor_content_vote string Если пользователь отреагировал, его голосование (вверх / вниз)
    post_id integer ID сообщения
    thread_id integer ID темы
    user_id integer ID пользователя
    post_date integer Дата сообщения в Unix Time
    message string Содержимое сообщения с учетом BB-кодов
    message_state string Состояние сообщения
    attach_count integer Количество вложений
    warning_message string Описание отсутствует
    position string Позиция сообщения. Начинается с 0
    last_edit_date string Время последнего изменения в Unix Time
    reaction_score string Количество реакций
    User User Информация о пользователе

    Тип данных: ProfilePost
    Объект, содержащий информацию о сообщении в профиле

    Колонка Тип Описание
    username string Имя пользователя
    message_parsed string HTML-версия содержимого сообщения
    can_edit bool Возможно ли изменить
    can_soft_delete bool Возможно ли удалить
    can_hard_delete bool Возможно ли стереть
    can_react bool Возможно ли использовать реакции
    can_view_attachments bool Возможно ли просматривать вложения
    view_url string Прямая ссылка на сообщение
    ProfileUser User Информация о пользователе
    Attachments Attachment[] Список вложений (если есть)
    LatestComments ProfilePostComment[] Список комментариев к сообщению
    is_reacted_to bool Стоит ли реакция от владельца API ключа
    visitor_reaction_id integer ID реакции
    profile_post_id integer ID сообщения
    profile_user_id integer ID пользователя, на стене которого размещено сообщение
    user_id integer ID пользователя
    post_date integer Дата сообщения в Unix Time
    message string Содержимое сообщения с учетом BB-кодов
    message_state string Состояние сообщения
    warning_message string Описание отсутствует
    comment_count integer Количество комментариев
    first_comment_date integer Дата первого комментария в Unix Time
    last_comment_date integer Дата последнего комментария в Unix Time
    reaction_score integer Количество реакций
    User User Информация о пользователе

    Тип данных: ProfilePostComment
    Объект, содержащий информацию о комментарии к сообщению в профиле

    Колонка Тип Описание
    username string Имя пользователя
    message_parsed string HTML-версия содержимого сообщения
    can_edit bool Возможно ли изменить
    can_soft_delete bool Возможно ли удалить
    can_hard_delete bool Возможно ли стереть
    can_react bool Возможно ли использовать реакции
    can_view_attachments bool Возможно ли просматривать вложения
    Attachments Attachment[] Список вложений (если есть)
    ProfilePost ProfilePost Сущность ProfilePost, к которому принадлежит комментарий
    is_reacted_to bool Стоит ли реакция от владельца API ключа
    visitor_reaction_id integer ID реакции
    profile_post_comment_id integer ID комментария
    profile_post_id integer ID сообщения
    user_id integer ID пользователя
    comment_date integer Дата комментария в Unix Time
    message string Содержимое сообщения с учетом BB-кодов
    message_state string Состояние сообщения
    warning_message string Описание отсутствует
    reaction_score integer Количество реакций
    User User Информация о пользователе

    Тип данных: Thread
    Объект, содержащий информацию о теме

    Колонка Тип Описание
    username string Имя пользователя
    is_watching bool Истинно, если пользователь отслеживает эту ветку
    visitor_post_count integer Количество сообщений от владельца API ключа
    is_unread bool Истинно, если не является прочитанным
    custom_fields object Пары "ключ-значение" значений настраиваемого поля для этой темы
    tags array Список тегов темы
    prefix string Название префикса
    can_edit bool Возможно ли изменить
    can_edit_tags bool Возможно ли изменить теги
    can_reply bool Возможно ли ответить
    can_soft_delete bool Возможно ли удалить
    can_hard_delete bool Возможно ли стереть
    can_view_attachments bool Возможно ли просматривать вложения
    view_url string Прямая ссылка на тему
    is_first_post_pinned bool Закреплено ли первое сообщение
    highlighted_post_ids array Описание отсутствует
    Forum Node Сущность Node, к которому принадлежит тема
    vote_score integer Оценка содержания (если поддерживается)
    can_content_vote bool Возможно ли голосовать за этот контент
    allowed_content_vote_types string[] Список типов голосования, разрешенных для этого контента
    is_content_voted bool Истинно, если пользователь, просматривающий этот контент, проголосовал за него
    visitor_content_vote string Если пользователь отреагировал, его голосование (вверх / вниз)
    thread_id integer ID темы
    node_id integer ID узла
    title string Название темы
    reply_count integer Количество ответов
    view_count integer Количество просмотров
    user_id integer ID пользователя
    post_date integer Дата создания темы в Unix Time
    sticky bool Истинно, если тема закреплена
    discussion_state string Состояние обсуждения
    discussion_open bool Истинно, если обсуждение открыто
    discussion_type string Тип обсуждения
    first_post_id integer ID первого сообщения
    last_post_date integer Дата последнего сообщения в Unix Time
    last_post_id integer ID последнего сообщения
    last_post_user_id integer ID пользователя последнего сообщения
    last_post_username string Имя пользователя последнего сообщения
    first_post_reaction_score integer Количество реакций у первого сообщения
    prefix_id integer ID префикса
    User User Информация о пользователе

    Тип данных: ThreadField
    Объект, содержащий информацию о поле в теме

    Колонка Тип Описание
    field_id string Описание отсутствует
    title string Описание отсутствует
    description string Описание отсутствует
    display_order integer Описание отсутствует
    field_type string Описание отсутствует
    field_choices object Описание отсутствует
    match_type string Описание отсутствует
    match_params array Описание отсутствует
    max_length integer Описание отсутствует
    required bool Описание отсутствует
    display_group string Описание отсутствует

    Тип данных: ThreadPrefix
    Объект, содержащий информацию о префиксе в теме

    Колонка Тип Описание
    prefix_id integer Описание отсутствует
    title string Описание отсутствует
    description string Описание отсутствует
    usage_help string Описание отсутствует
    is_usable bool Описание отсутствует
    prefix_group_id integer Описание отсутствует
    display_order integer Описание отсутствует
    materialized_order integer Описание отсутствует

    Тип данных: User
    Объект, содержащий информацию о пользователе форума

    Колонка Тип Описание
    about string Информация о пользователе
    activity_visible bool Истинно, если у пользователя включено отображение активности
    age integer Возраст
    alert_optout array Описание отсутствует
    allow_post_profile string Кто может создавать сообщения в профиле
    allow_receive_news_feed string Кто может получать новые темы от пользователя
    allow_send_personal_conversation string Кто может создавать переписки с пользователем
    allow_view_identities string Описание отсутствует
    allow_view_profile string Описание отсутствует
    avatar_urls object Пары "ключ-значение" ссылок на аватары
    profile_banner_urls object Пары "ключ-значение" ссылок на баннеры
    can_ban bool Может банить
    can_converse bool Может создавать переписки
    can_edit bool Описание отсутствует
    can_follow bool Описание отсутствует
    can_ignore bool Описание отсутствует
    can_post_profile bool Описание отсутствует
    can_view_profile bool Описание отсутствует
    can_view_profile_posts bool Описание отсутствует
    can_warn bool Описание отсутствует
    content_show_signature bool Описание отсутствует
    creation_watch_state string Описание отсутствует
    custom_fields object Описание отсутствует
    custom_title string Описание отсутствует
    dob object Описание отсутствует
    email string Описание отсутствует
    email_on_conversation bool Описание отсутствует
    gravatar string Описание отсутствует
    interaction_watch_state bool Описание отсутствует
    is_admin bool Описание отсутствует
    is_banned bool Описание отсутствует
    is_discouraged bool Описание отсутствует
    is_followed bool Описание отсутствует
    is_ignored bool Описание отсутствует
    is_moderator bool Описание отсутствует
    is_super_admin bool Описание отсутствует
    last_activity integer Описание отсутствует
    location string Описание отсутствует
    push_on_conversation bool Описание отсутствует
    push_optout array Описание отсутствует
    receive_admin_email bool Описание отсутствует
    secondary_group_ids array Описание отсутствует
    show_dob_date bool Описание отсутствует
    show_dob_year bool Описание отсутствует
    signature string Описание отсутствует
    timezone string Описание отсутствует
    use_tfa array Описание отсутствует
    user_group_id integer Описание отсутствует
    user_state string Описание отсутствует
    user_title string Описание отсутствует
    visible bool Описание отсутствует
    warning_points integer Описание отсутствует
    website string Описание отсутствует
    view_url string Описание отсутствует
    user_id integer Описание отсутствует
    username string Описание отсутствует
    message_count integer Описание отсутствует
    question_solution_count integer Описание отсутствует
    register_date integer Описание отсутствует
    trophy_points integer Описание отсутствует
    is_staff bool Описание отсутствует
    reaction_score integer Описание отсутствует
    vote_score integer Описание отсутствует


    Тип данных: UserField
    Объект, содержащий информацию о кастомных полях пользователя

    Колонка Тип Описание
    field_id string Описание отсутствует
    title string Описание отсутствует
    description string Описание отсутствует
    display_order integer Описание отсутствует
    field_type string Описание отсутствует
    field_choices object Описание отсутствует
    match_type string Описание отсутствует
    match_params array Описание отсутствует
    max_length integer Описание отсутствует
    required bool Описание отсутствует
    display_group string Описание отсутствует

    Тип данных: XFRM_Category
    Объект, содержащий информацию о категории ресурсов

    Колонка Тип Описание
    resource_category_id integer Описание отсутствует
    title string Описание отсутствует
    description string Описание отсутствует
    resource_count integer Описание отсутствует
    last_update integer Описание отсутствует
    last_resource_title string Описание отсутствует
    last_resource_id integer Описание отсутствует
    allow_local bool Описание отсутствует
    allow_external bool Описание отсутствует
    allow_commercial_external bool Описание отсутствует
    allow_fileless bool Описание отсутствует
    min_tags integer Описание отсутствует
    enable_versioning bool Описание отсутствует
    enable_support_url bool Описание отсутствует
    parent_category_id integer Описание отсутствует
    display_order integer Описание отсутствует

    Тип данных: XFRM_ResourceField
    Объект, содержащий информацию о кастомном поле ресурсов

    Колонка Тип Описание
    field_id string Описание отсутствует
    title string Описание отсутствует
    description string Описание отсутствует
    display_order integer Описание отсутствует
    field_type string Описание отсутствует
    field_choices object Описание отсутствует
    match_type string Описание отсутствует
    match_params array Описание отсутствует
    max_length integer Описание отсутствует
    required bool Описание отсутствует
    display_group string Описание отсутствует

    Тип данных: XFRM_ResourceItem
    Объект, содержащий информацию о ресурсе

    Колонка Тип Описание
    resource_id integer Описание отсутствует
    title string Описание отсутствует
    tag_line string Описание отсутствует
    user_id integer Описание отсутствует
    resource_state string Описание отсутствует
    resource_type string Описание отсутствует
    resource_date integer Описание отсутствует
    resource_category_id integer Описание отсутствует
    external_url string Описание отсутствует
    price float Описание отсутствует
    currency string Описание отсутствует
    view_count integer Описание отсутствует
    download_count integer Описание отсутствует
    rating_count integer Описание отсутствует
    rating_avg float Описание отсутствует
    rating_weighted float Описание отсутствует
    last_update integer Описание отсутствует
    alt_support_url string Описание отсутствует
    prefix_id integer Описание отсутствует
    Category XFRM_Category Описание отсутствует
    User User Описание отсутствует

    Тип данных: XFRM_ResourcePrefix
    Объект, содержащий информацию о префиксе ресурсов

    Колонка Тип Описание
    prefix_id integer Описание отсутствует
    title string Описание отсутствует
    description string Описание отсутствует
    usage_help string Описание отсутствует
    is_usable bool Описание отсутствует
    prefix_group_id integer Описание отсутствует
    display_order integer Описание отсутствует
    materialized_order integer Описание отсутствует

    Тип данных: XFRM_ResourceReviewField
    Объект, содержащий информацию о рецензия ресурса

    Колонка Тип Описание
    field_id string Описание отсутствует
    title string Описание отсутствует
    description string Описание отсутствует
    display_order integer Описание отсутствует
    field_type string Описание отсутствует
    field_choices object Описание отсутствует
    match_type string Описание отсутствует
    match_params array Описание отсутствует
    max_length integer Описание отсутствует
    required bool Описание отсутствует
    display_group integer Описание отсутствует

    Тип данных: XFRM_ResourceVersion
    Объект, содержащий информацию о версии ресурса

    Колонка Тип Описание
    resource_version_id integer Описание отсутствует
    resource_id integer Описание отсутствует
    version_string string Описание отсутствует
    release_date integer Описание отсутствует
    download_count integer Описание отсутствует
    rating_count integer Описание отсутствует
    version_state string Описание отсутствует
Сверху Снизу