Поиск компонент результатов в наборе средств Microsoft Graph

  • Статья

Вы можете использовать для mgt-search-results выполнения поисковых запросов к Microsoft Graph непосредственно в HTML- коде. Компонент предоставляет некоторые отрисовки типов результатов по умолчанию, но также предлагает полную настройку шаблонов.

Пример

В следующем примере показано использование компонента в mgt-search-results наиболее релевантных документах. Вы можете использовать редактор кода, чтобы узнать, как свойства и атрибуты изменяют поведение компонента.

Свойства и атрибуты

Чтобы изменить поведение компонента, можно использовать несколько атрибутов. Обязательными атрибутами являются query-string и entity-types.

Атрибут Свойство Описание
строка запроса Querystring Запрос для отправки в Microsoft Поиск.
типы сущностей entityTypes Один или несколько типов ресурсов, ожидаемых в ответе. Возможные значения: list, site, listItem, message, event, drive, driveItem, person, externalItem, акроним, закладка, chatMessage. По умолчанию используется driveItemзначение , listItem, site.
источники содержимого contentSources Источники контента для использования с внешними элементами.
paging-max pagingMax Максимальное количество страниц, которые можно щелкнуть в элементе управления разбиением на страницы. Значение по умолчанию: 7.
query-template queryTemplate Шаблон запроса для использования в сложных сценариях поиска. Шаблоны запросов сейчас поддерживаются только в бета-версии конечной точки.
Выборка эскиза fetchThumbnail Задает, следует ли получить эскиз результата из Microsoft Graph. Значение по умолчанию: false.
enable-top-results enableTopResults Это активирует гибридную сортировку для сообщений: первые три сообщения являются наиболее актуальными. Это свойство применимо только к entityType=message. Значение по умолчанию: false.
scopes scopes Необязательный массив строк, если используется свойство либо область с разделителями-запятыми, при использовании атрибута. Компонент использует эти области (с поддерживаемым поставщиком), чтобы убедиться, что пользователь дает согласие на правильное разрешение.
size size Размер извлекаемой страницы. Максимальное значение — 1000. Значение по умолчанию: 10.
fields fields Содержит поля, возвращаемые для каждого ресурса.
version version Необязательная версия API, используемая при выполнении запроса. Значение по умолчанию: v1.0.
cache-enabled cacheEnabled Необязательное логическое значение. Если задано значение , это означает, что ответ от ресурса кэшируется. Переопределите, если refresh() вызывается или используется pollingRate . Значение по умолчанию: false.
cache-invalidation-period cacheInvalidationPeriod Необязательное количество миллисекунда. Если задано в сочетании с cacheEnabled, задержка до того, как кэш достигнет своего периода недействительности, изменяется этим значением. Значение по умолчанию — и 30000 использует период недействительности по умолчанию.
Н/Д error Ошибка только для чтения из Microsoft Graph, если запрос не был успешным.

Настраиваемые свойства CSS

Компонент mgt-search-results определяет следующие настраиваемые свойства CSS.

<mgt-search-results
  class="search-results"
  query-string="contoso"
  entity-types="driveItem"
></mgt-search-results>

.search-results {
  --answer-border-radius: 10px;
  --answer-box-shadow: 0px 2px 30px pink;
  --answer-border: dotted 2px white;
  --answer-padding: 8px 0px;
}

Дополнительные сведения см. в статье Компоненты стиля.

Методы

Метод Описание
refresh(force?: boolean) Вызов метода для обновления данных. По умолчанию пользовательский интерфейс обновляется только при изменении данных. Передайте true для принудительного обновления компонента.

События

Событие Когда он генерируется Пользовательские данные Отменяемым Пузыри Работает с пользовательским шаблоном
dataChange Активируется после загрузки данных компонентом. { response: any, error: any }. Свойство response содержит ответ, полученный из Microsoft Graph. Свойство error содержит сведения об ошибке, если она произошла. Нет Нет Да

Дополнительные сведения об обработке событий см. в разделе События.

Шаблоны

Компонент mgt-search-results поддерживает несколько шаблонов, с помощью которых можно определить внешний вид и удобство использования. Чтобы указать шаблон, включите <template> элемент внутри компонента и задайте для data-type параметра одно из следующих значений.

Тип данных Контекст данных Описание
default Ответ от Microsoft Graph. По умолчанию можно использовать для отрисовки всего ответа, поступающего от Microsoft Graph.
Результат-* Элемент данных из возвращаемого value массива result-* Используйте шаблон вместо шаблона, default когда ожидается, что ответ от графа будет содержать массив элементов. Шаблон result-* автоматически повторяется для каждого элемента, возвращаемого ресурсом. Шаблон result-* начинает отрисовку элементов сразу после их готовности (в отличие от шаблона по умолчанию). Вы можете иметь несколько result-* шаблонов, по одному entityType (см. доступные entity-type в свойствах и атрибутах)
error Ошибка из Microsoft Graph. Этот шаблон используется при возникновении ошибки при выполнении запроса.
loading Н/Д Этот шаблон используется во время выполнения запроса.
no-data Н/Д Этот шаблон используется, когда запрос не возвращает данных.

Разрешения Microsoft Graph

Разрешения, необходимые для этого компонента, зависят от данных, которые вы хотите получить с помощью Microsoft Graph. Дополнительные сведения о разрешениях см. в статье Использование API microsoft Поиск для запроса данных.

Подкомпоненты

Компонент mgt-search-results состоит из одного или нескольких подкомпонентов, для которых могут потребоваться другие разрешения, отличные от необходимых для этого компонента. Дополнительные сведения см. в документации по каждому подкомпоненту:

Проверка подлинности

Для получения требуемых данных в средстве управления используется глобальный поставщик проверки подлинности, указанный в документации по проверке подлинности.

Кэш

Чтобы включить и настроить кэш, используйте cacheEnabled свойства и cacheInvalidationPeriod . По умолчанию mgt-search-results компонент не кэширует ответы.

Хранилище объектов Кэшированные данные Замечания
response Полный ответ, полученный от Microsoft Graph для запроса, выполненного mgt-search-results

Дополнительные сведения см. в разделе Кэширование.

Локализация

Элемент управления предоставляет следующие переменные, которые можно локализовать. Дополнительные сведения о настройке локализации см. в разделе Локализация компонентов.

Имя строки Значение по умолчанию
изменено modified on
Назад Back
next Next
pages pages
page Page