Office.DevicePermission interface

Предоставляет надстройке методы, с помощью которых надстройка запрашивает у пользователя разрешение на доступ к возможностям устройства. Возможности устройства пользователя включают камеру, географическое положение и микрофон.

Методы

requestPermissions(permissions)

Запрашивает у пользователя разрешение на доступ к возможностям устройства, таким как камера или микрофон.

Все запрашиваемые разрешения отображаются для пользователя в одном модальном диалоговом окне. В диалоговом окне содержатся параметры "Разрешить", " Однократно" или "Отклонить запрошенные разрешения".

Этот метод возвращает отложенный результат. Используйте его с надстройками Excel, PowerPoint и Word.

Если пользователь впервые предоставляет доступ к возможности устройства, обещание разрешается с trueпомощью . Затем необходимо перезагрузить надстройку, прежде чем можно будет запустить код, использующий возможности устройства. Например, можно позвонить window.location.reload() , чтобы перезагрузить надстройку. Если пользователь ранее предоставил доступ к возможности устройства, обещание разрешается с falseпомощью . Перезагружать надстройку для выполнения кода, использующего возможности устройства, не требуется, так как разрешение уже задано. Если пользователь отказывает в доступе к возможности устройства, обещание отклоняется с сообщением об ошибке «Пользователю отказано в запросе разрешения».

requestPermissionsAsync(permissions, options, callback)

Запрашивает у пользователя разрешение на доступ к возможностям устройства, таким как камера, географическое положение или микрофон.

Все запрашиваемые разрешения отображаются для пользователя в одном модальном диалоговом окне. В диалоговом окне содержатся параметры "Разрешить", " Однократно" или "Отклонить запрошенные разрешения".

Этот метод принимает функцию обратного вызова. Используйте его с надстройками Outlook.

requestPermissionsAsync(permissions, callback)

Запрашивает у пользователя разрешение на доступ к возможностям устройства, таким как камера, географическое положение или микрофон.

Все запрашиваемые разрешения отображаются для пользователя в одном модальном диалоговом окне. В диалоговом окне содержатся параметры "Разрешить", " Однократно" или "Отклонить запрошенные разрешения".

Этот метод принимает функцию обратного вызова. Используйте его с надстройками Outlook.

requestPermissions(permissions)

Запрашивает у пользователя разрешение на доступ к возможностям устройства, таким как камера или микрофон.

Все запрашиваемые разрешения отображаются для пользователя в одном модальном диалоговом окне. В диалоговом окне содержатся параметры "Разрешить", " Однократно" или "Отклонить запрошенные разрешения".

Этот метод возвращает отложенный результат. Используйте его с надстройками Excel, PowerPoint и Word.

Если пользователь впервые предоставляет доступ к возможности устройства, обещание разрешается с trueпомощью . Затем необходимо перезагрузить надстройку, прежде чем можно будет запустить код, использующий возможности устройства. Например, можно позвонить window.location.reload() , чтобы перезагрузить надстройку. Если пользователь ранее предоставил доступ к возможности устройства, обещание разрешается с falseпомощью . Перезагружать надстройку для выполнения кода, использующего возможности устройства, не требуется, так как разрешение уже задано. Если пользователь отказывает в доступе к возможности устройства, обещание отклоняется с сообщением об ошибке «Пользователю отказано в запросе разрешения».

requestPermissions(permissions: Office.DevicePermissionType[]): Promise<boolean>;

Параметры

permissions: Office.DevicePermissionType[]

Массив возможностей устройства, доступ к которым запрашивает надстройка. В веб-версиях Excel, PowerPoint и Word надстройки могут запрашивать доступ только к камере и микрофону пользователя. Доступ к географическому положению пользователя заблокирован.

Возвращаемое значение

Promise<boolean>

Этот способ не поддерживается в надстройках Outlook. Используйте этот requestPermissionsAsync метод.
Если в надстройке используется одинаковый код для Office в Интернете и классического клиента Office, прежде чем вызывать requestPermissionsнадстройку, проверьте платформу, на которой работает надстройка. Используйте Office.context.platform и убедитесь, что он возвращает Office.PlatformType.OfficeOnline. В противном случае requestPermissions вызов вернет ошибку.
Если пользователь нажимает кнопку "Разрешить " в диалоговом окне, разрешение сохраняется до удаления надстройки или до очистки кэша браузера, в котором работает надстройка. Если пользователь хочет изменить доступ надстройки к камере или микрофону, он должен удалить надстройку или очистить кэш браузера.
Если пользователь выбирает "Разрешить однократно " в диалоговом окне, разрешение сохраняется до тех пор, пока вкладка браузера или окно, в котором работает надстройка, не будет закрыто.
Если пользователь нажмет " Запретить " в диалоговом окне, у пользователя будут снова запрошены разрешения в следующий раз, когда надстройке потребуется доступ к возможностям устройства пользователя.
Доступ к географическому положению пользователя не поддерживается в Excel, PowerPoint и Word. Он поддерживается только в Outlook в Интернете и новом Outlook для Windows при использовании этого requestPermissionsAsync метода.

Примеры

// Request permission from a user to access their camera and microphone.
if (Office.context.platform === Office.PlatformType.OfficeOnline) {
    const deviceCapabilities = [
        Office.DevicePermissionType.camera,
        Office.DevicePermissionType.microphone
    ];
    Office.devicePermission
        .requestPermissions(deviceCapabilities)
        .then((isGranted) => {
            if (isGranted) {
                console.log("Permission granted.");
                // Reload your add-in before you run code that uses the device capabilities.
                location.reload();
            } else {
                console.log("Permission has been previously granted and is already set in the iframe.");

                // Since permission has been previously granted, you don't need to reload your add-in.

                // Do something with the device capabilities.
            }
        })
        .catch((error) => {
            console.log("Permission denied.");
            console.error(error);

            // Do something when permission is denied.
        });
}

requestPermissionsAsync(permissions, options, callback)

Запрашивает у пользователя разрешение на доступ к возможностям устройства, таким как камера, географическое положение или микрофон.

Все запрашиваемые разрешения отображаются для пользователя в одном модальном диалоговом окне. В диалоговом окне содержатся параметры "Разрешить", " Однократно" или "Отклонить запрошенные разрешения".

Этот метод принимает функцию обратного вызова. Используйте его с надстройками Outlook.

requestPermissionsAsync(permissions: Office.DevicePermissionType[], options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;

Параметры

permissions: Office.DevicePermissionType[]

Массив возможностей устройства, доступ к которым запрашивает надстройка. В Outlook в Интернете и новом Outlook для Windows надстройка может запрашивать доступ к камере, географическому положению и микрофону пользователя.

options: Office.AsyncContextOptions

Объектный литерал, содержащий свойство asyncContext . Назначьте свойству asyncContext любой объект, к которому вы хотите получить доступ в функции обратного вызова.

callback: (asyncResult: Office.AsyncResult<boolean>) => void

Когда метод завершается, функция, переданная в параметре callback , вызывается с единственным параметром, asyncResultкоторый является объектом Office.AsyncResult . Если пользователь предоставляет разрешение на доступ к запрошенным возможностям устройства, true возвращается в свойство asyncResult.value . Затем необходимо перезагрузить надстройку, прежде чем можно будет запустить код, использующий возможности устройства. Например, можно позвонить window.location.reload() , чтобы перезагрузить надстройку. Если пользователь ранее предоставил разрешение на доступ к запрошенным возможностям устройства, false возвращается в свойство asyncResult.value . Перезагружать надстройку для выполнения кода, использующего возможности устройства, не требуется, так как разрешение уже задано. Если пользователь отказывает в доступе к запрошенным возможностям устройства, Office.AsyncResultStatus.Failed возвращается свойство asyncResult.status .

Возвращаемое значение

void

Для надстроек Excel, PowerPoint и Word используйте этот requestPermissions способ.
Если в надстройке используется одинаковый код для Office в Интернете и классического клиента Office, прежде чем вызывать requestPermissionsAsyncнадстройку, проверьте платформу, на которой работает надстройка. Используйте Office.context.mailbox.диагностика. hostName и убедитесь, что он возвращает OutlookWebApp. В противном случае requestPermissionsAsync вызов вернет ошибку.
Если пользователь нажимает кнопку "Разрешить " в диалоговом окне, разрешение сохраняется до удаления надстройки или до очистки кэша браузера, в котором работает надстройка. Если пользователь хочет изменить доступ надстройки к камере или микрофону, он должен удалить надстройку или очистить кэш браузера.
Если пользователь выбирает "Разрешить однократно " в диалоговом окне, разрешение сохраняется до тех пор, пока вкладка браузера или окно, в котором работает надстройка, не будет закрыто.
Если пользователь нажмет " Запретить " в диалоговом окне, у пользователя будут снова запрошены разрешения в следующий раз, когда надстройке потребуется доступ к возможностям устройства пользователя.
Если в надстройке реализована активация на основе событий, разрешения браузера на возможности устройства не наследуются, и этот requestPermissionsAsync метод не поддерживается.

requestPermissionsAsync(permissions, callback)

Запрашивает у пользователя разрешение на доступ к возможностям устройства, таким как камера, географическое положение или микрофон.

Все запрашиваемые разрешения отображаются для пользователя в одном модальном диалоговом окне. В диалоговом окне содержатся параметры "Разрешить", " Однократно" или "Отклонить запрошенные разрешения".

Этот метод принимает функцию обратного вызова. Используйте его с надстройками Outlook.

requestPermissionsAsync(permissions: Office.DevicePermissionType[], callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;

Параметры

permissions: Office.DevicePermissionType[]

Массив возможностей устройства, доступ к которым запрашивает надстройка. В Outlook в Интернете и новом Outlook для Windows надстройка может запрашивать доступ к камере, географическому положению и микрофону пользователя.

callback: (asyncResult: Office.AsyncResult<boolean>) => void

Когда метод завершается, функция, переданная в параметре callback , вызывается с единственным параметром, asyncResultкоторый является объектом Office.AsyncResult . Если пользователь предоставляет разрешение на доступ к запрошенным возможностям устройства, true возвращается в свойство asyncResult.value . Затем необходимо перезагрузить надстройку, прежде чем можно будет запустить код, использующий возможности устройства. Например, можно позвонить window.location.reload() , чтобы перезагрузить надстройку. Если пользователь ранее предоставил разрешение на доступ к запрошенным возможностям устройства, false возвращается в свойство asyncResult.value . Перезагружать надстройку для выполнения кода, использующего возможности устройства, не требуется, так как разрешение уже задано. Если пользователь отказывает в доступе к запрошенным возможностям устройства, Office.AsyncResultStatus.Failed возвращается свойство asyncResult.status .

Возвращаемое значение

void

Для надстроек Excel, PowerPoint и Word используйте этот requestPermissions способ.
Если в надстройке используется одинаковый код для Office в Интернете и классического клиента Office, прежде чем вызывать requestPermissionsAsyncнадстройку, проверьте платформу, на которой работает надстройка. Используйте Office.context.mailbox.диагностика. hostName и убедитесь, что он возвращает OutlookWebApp. В противном случае requestPermissionsAsync вызов вернет ошибку.
Если пользователь нажимает кнопку "Разрешить " в диалоговом окне, разрешение сохраняется до удаления надстройки или до очистки кэша браузера, в котором работает надстройка. Если пользователь хочет изменить доступ надстройки к камере или микрофону, он должен удалить надстройку или очистить кэш браузера.
Если пользователь выбирает "Разрешить однократно " в диалоговом окне, разрешение сохраняется до тех пор, пока вкладка браузера или окно, в котором работает надстройка, не будет закрыто.
Если пользователь нажмет " Запретить " в диалоговом окне, у пользователя будут снова запрошены разрешения в следующий раз, когда надстройке потребуется доступ к возможностям устройства пользователя.
Если в надстройке реализована активация на основе событий, разрешения браузера на возможности устройства не наследуются, и этот requestPermissionsAsync метод не поддерживается.

Примеры

// Request permission from a user to access their camera, geolocation, and microphone.
if (Office.context.mailbox.diagnostics.hostName === "OutlookWebApp") {
    const deviceCapabilities = [
        Office.DevicePermissionType.camera,
        Office.DevicePermissionType.geolocation,
        Office.DevicePermissionType.microphone
    ];

    Office.devicePermission.requestPermissionsAsync(deviceCapabilities, (asyncResult) => {
        if (asyncResult.status === Office.AsyncResultStatus.Failed) {
            console.log("Permission denied.");

            // Do something when permission is denied.
        } else {
            if (asyncResult.value) {
                console.log("Permission granted.");
                // Reload your add-in before you run code that uses the device capabilities.
                location.reload();
            } else {
                console.log("Permission has been previously granted and is already set in the iframe.");
                
                // Since permission has been previously granted, you don't need to reload your add-in.

                // Do something with the device capabilities.
            }
        }
    });
}

Комментарии

Методы

requestPermissions(permissions)

Параметры

Возвращаемое значение

Комментарии

Примеры

requestPermissionsAsync(permissions, options, callback)

Параметры

Возвращаемое значение

Комментарии

requestPermissionsAsync(permissions, callback)

Параметры

Возвращаемое значение

Комментарии

Примеры

Комментарии

Методы

Сведения о методе

requestPermissions(permissions)

Параметры

Возвращаемое значение

Комментарии

Примеры

requestPermissionsAsync(permissions, options, callback)

Параметры

Возвращаемое значение

Комментарии

requestPermissionsAsync(permissions, callback)

Параметры

Возвращаемое значение

Комментарии

Примеры

Обратная связь