Получение компонента в наборе средств Microsoft Graph
С помощью mgt-get можно создавать любые GET-запросы из Microsoft Graph непосредственно в HTML-коде. Компонент не предоставляет пользовательский интерфейс по умолчанию и требует написания шаблона.
Пример
В приведенном ниже примере показано использование компонента mgt-get для отображения электронной почты пользователя. Вы можете использовать редактор кода, чтобы узнать, как свойства и атрибуты изменяют поведение компонента.
Свойства и атрибуты
Чтобы изменить поведение компонента, можно использовать несколько атрибутов. Единственным обязательным атрибутом является resource.
| Атрибут | Свойство | Описание |
|---|---|---|
| resource | resource | Ресурс, который требуется получить из Microsoft Graph (например, /me). |
| scopes | scopes | Необязательный массив строк при использовании свойства или область с разделителями-запятыми при использовании атрибута . Компонент и поддерживаемый поставщик гарантируют, что пользователь дает согласие по крайней мере на одно из предоставленных разрешений. |
| version | version | Необязательная версия API, используемая при выполнении GET запроса. Значение по умолчанию: v1.0. |
| max-pages | maxPages | Необязательное количество страниц (для ресурсов, поддерживающих разделение на страницы). Значение по умолчанию: 3. При установке этого значения 0 извлекаются все страницы. |
| polling-rate | pollingRate | Необязательное количество миллисекунда. Если этот параметр задан, компонент опрашивает универсальный код ресурса (URI) запроса на наличие обновлений в течение определенного интервала. При использовании разностного запроса при опросе всегда запрашивается разностный API. Шаблон обновляется только при изменении данных. |
| cache-enabled | cacheEnabled | Необязательное логическое значение. Если задано значение , это означает, что ответ от ресурса кэшируется. Переопределите, если refresh() вызывается или используется pollingRate . Значение по умолчанию: false. |
| cache-invalidation-period | cacheInvalidationPeriod | Необязательное количество миллисекунда. Если задано в сочетании с cacheEnabled, задержка до того, как кэш достигнет своего периода недействительности, изменяет значение. Значение по умолчанию — и 0 использует период недействительности по умолчанию. |
| type | type | Необязательный тип ожидаемого ответа. Значение по умолчанию: json. Поддерживает json или image (поддерживаются только для конечных точек, заканчивающихся на /photo/value$). |
| Н/Д | response | Нередактируемый ответ в Microsoft Graph, если запрос был успешен. |
| Н/Д | error | Ошибка только для чтения из Microsoft Graph, если запрос не был успешным. |
Методы
| Метод | Описание |
|---|---|
| refresh(force?: boolean) | Вызов метода для обновления данных. По умолчанию пользовательский интерфейс обновляется только при изменении данных. Передайте true для принудительного обновления компонента. |
События
| Событие | Когда он генерируется | Пользовательские данные | Отменяемым | Пузыри | Работает с пользовательским шаблоном |
|---|---|---|---|---|---|
dataChange |
Активируется после загрузки данных компонентом. |
{ response: any, error: any }. Свойство response содержит ответ, полученный из Microsoft Graph. Свойство error содержит сведения об ошибке, если она произошла. |
Нет | Нет | Да |
Совет
Дополнительные сведения о данных, возвращаемых в свойстве response , см. в справочнике по API, который вы использовали в свойстве resource компонента Get.
Дополнительные сведения об обработке событий см. в разделе События.
Шаблоны
Компонент mgt-get поддерживает несколько шаблонов, с помощью которых можно определить внешний вид и удобство использования. Чтобы указать шаблон, включите <template> элемент внутри компонента и задайте для data-type параметра одно из следующих значений.
| Тип данных | Контекст данных | Описание |
|---|---|---|
| default | Ответ от Microsoft Graph. | Для отображения данных, поступающих из Microsoft Graph, требуется шаблон по умолчанию. |
| value | Элемент данных из возвращаемого value массива |
Используйте шаблон value, а не шаблон default, когда ожидается, что в ответе от графа будет указан массив элементов, например, сообщений, файлов или пользователей. Шаблон value автоматически повторяется для каждого элемента, возвращаемого ресурсом. Шаблон value также начинает отрисовку элементов, как только они будут готовы (в отличие от шаблона по умолчанию). |
| error | Ошибка из Microsoft Graph. | Этот шаблон используется при возникновении ошибки при выполнении запроса. |
| loading | Н/Д | Этот шаблон используется во время выполнения запроса. |
| no-data | Н/Д | Этот шаблон используется, когда запрос не возвращает данных. |
Разрешения Microsoft Graph
Разрешения, необходимые для этого компонента, зависят от данных, которые вы хотите получить с помощью Microsoft Graph. Microsoft Graph Toolkit проверяет, согласился ли текущий пользователь по крайней мере на один из предоставленных scopes. Дополнительные сведения о разрешениях см. в справочнике по разрешениям Microsoft Graph.
Проверка подлинности
Для получения требуемых данных в средстве управления используется глобальный поставщик проверки подлинности, указанный в документации по проверке подлинности.
Кэш
Чтобы включить и настроить кэш, используйте cacheEnabled свойства и cacheInvalidationPeriod . По умолчанию mgt-get компонент не кэширует ответы.
| Хранилище объектов | Кэшированные данные | Замечания |
|---|---|---|
response |
Полный ответ, полученный из Microsoft Graph для запроса, указанного в свойстве resourcemgt-get |
Дополнительные сведения см. в разделе Кэширование.
Локализация
Элемент управления не предоставляет переменные локализации.