Office.DevicePermission interface

Fordert von einem Benutzer die Berechtigung zum Zugriff auf seine Gerätefunktionen an, z. B. eine Kamera oder ein Mikrofon.

Alle angeforderten Berechtigungen werden dem Benutzer in einem einzigen modalen Dialogfeld angezeigt. Das Dialogfeld enthält Optionen zum Zulassen, Einmal zulassenoder Verweigern der angeforderten Berechtigungen.

Diese Methode gibt eine Zusage zurück. Verwenden Sie es mit Excel-, PowerPoint- und Word-Add-Ins.

Wenn ein Benutzer erstmals Zugriff auf eine Gerätefunktion gewährt, wird die Zusage mit trueaufgelöst. Sie müssen dann das Add-In neu laden, bevor Sie Code ausführen können, der die Gerätefunktion verwendet. Sie können beispielsweise aufrufen window.location.reload() , um Ihr Add-In neu zu laden. Wenn ein Benutzer zuvor Zugriff auf eine Gerätefunktion gewährt hatte, wird die Zusage mit falseaufgelöst. Sie müssen Ihr Add-In nicht neu laden, um Code auszuführen, der die Gerätefunktion verwendet, da die Berechtigung bereits festgelegt ist. Wenn ein Benutzer den Zugriff auf eine Gerätefunktion verweigert, wird die Zusage mit der Fehlermeldung "Benutzer hat die Berechtigungsanforderung abgelehnt" abgelehnt.

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

Parameter

Gibt zurück

Hinweise

Wichtig:

• Diese Methode wird in Outlook-Add-Ins nicht unterstützt. Verwenden Sie stattdessen die requestPermissionsAsync Methode.

• Wenn Ihr Add-In den gleichen Code sowohl für Office im Web als auch für Office-Desktopclients verwendet, überprüfen Sie die Plattform, auf der das Add-In ausgeführt wird, bevor requestPermissionsSie . Verwenden Sie Office.context.platform , und überprüfen Sie, ob zurückgegeben Office.PlatformType.OfficeOnlinewird. Andernfalls gibt der requestPermissions Aufruf einen Fehler zurück.

• Wenn ein Benutzer im Dialogfeld "Zulassen " auswählt, bleibt die Berechtigung bestehen, bis das Add-In deinstalliert oder der Cache des Browsers, auf dem das Add-In ausgeführt wird, gelöscht wird. Wenn ein Benutzer den Zugriff eines Add-Ins auf seine Kamera oder sein Mikrofon ändern möchte, muss er das Add-In deinstallieren oder seinen Browsercache löschen.

• Wenn ein Benutzer im Dialogfeld " Einmal zulassen " auswählt, bleibt die Berechtigung bestehen, bis die Browserregisterkarte oder das Fenster, in dem das Add-In ausgeführt wird, geschlossen wird.

• Wenn ein Benutzer im Dialogfeld " Verweigern " auswählt, wird der Benutzer erneut um Berechtigungen gebeten, wenn das Add-In das nächste Mal Zugriff auf die Gerätefunktionen des Benutzers benötigt.

• Der Zugriff auf die Geolokalisierung eines Benutzers wird in Excel, PowerPoint und Word nicht unterstützt. Es wird nur in Outlook im Web und im neuen Outlook unter Windows mit dieser requestPermissionsAsync Methode unterstützt.

Beispiele

// 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.
        });
}

Fordert von einem Benutzer die Berechtigung zum Zugriff auf seine Gerätefunktionen an, z. B. Kamera, Geolokalisierung oder Mikrofon.

Alle angeforderten Berechtigungen werden dem Benutzer in einem einzigen modalen Dialogfeld angezeigt. Das Dialogfeld enthält Optionen zum Zulassen, Einmal zulassenoder Verweigern der angeforderten Berechtigungen.

Diese Methode akzeptiert eine Rückruffunktion. Verwenden Sie es mit Outlook-Add-Ins.

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

Parameter

Gibt zurück

Hinweise

Wichtig:

• Verwenden Sie für Excel-, PowerPoint- und Word-Add-Ins stattdessen die requestPermissions Methode.

• Wenn Ihr Add-In den gleichen Code sowohl für Office im Web als auch für Office-Desktopclients verwendet, überprüfen Sie die Plattform, auf der das Add-In ausgeführt wird, bevor requestPermissionsAsyncSie . Verwenden Sie Office.context.mailbox.diagnose. hostName an, und überprüfen Sie, ob zurückgegeben OutlookWebAppwird. Andernfalls gibt der requestPermissionsAsync Aufruf einen Fehler zurück.

• Wenn ein Benutzer im Dialogfeld "Zulassen " auswählt, bleibt die Berechtigung bestehen, bis das Add-In deinstalliert oder der Cache des Browsers, auf dem das Add-In ausgeführt wird, gelöscht wird. Wenn ein Benutzer den Zugriff eines Add-Ins auf seine Kamera oder sein Mikrofon ändern möchte, muss er das Add-In deinstallieren oder seinen Browsercache löschen.

• Wenn ein Benutzer im Dialogfeld " Einmal zulassen " auswählt, bleibt die Berechtigung bestehen, bis die Browserregisterkarte oder das Fenster, in dem das Add-In ausgeführt wird, geschlossen wird.

• Wenn ein Benutzer im Dialogfeld " Verweigern " auswählt, wird der Benutzer erneut um Berechtigungen gebeten, wenn das Add-In das nächste Mal Zugriff auf die Gerätefunktionen des Benutzers benötigt.

• Wenn Ihr Add-In eine ereignisbasierte Aktivierung implementiert, werden die Browserberechtigungen für Gerätefunktionen nicht vererbt, und die requestPermissionsAsync Methode wird nicht unterstützt.

Fordert von einem Benutzer die Berechtigung zum Zugriff auf seine Gerätefunktionen an, z. B. Kamera, Geolokalisierung oder Mikrofon.

Alle angeforderten Berechtigungen werden dem Benutzer in einem einzigen modalen Dialogfeld angezeigt. Das Dialogfeld enthält Optionen zum Zulassen, Einmal zulassenoder Verweigern der angeforderten Berechtigungen.

Diese Methode akzeptiert eine Rückruffunktion. Verwenden Sie es mit Outlook-Add-Ins.

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

Parameter

Gibt zurück

Hinweise

Wichtig:

• Verwenden Sie für Excel-, PowerPoint- und Word-Add-Ins stattdessen die requestPermissions Methode.

• Wenn Ihr Add-In den gleichen Code sowohl für Office im Web als auch für Office-Desktopclients verwendet, überprüfen Sie die Plattform, auf der das Add-In ausgeführt wird, bevor requestPermissionsAsyncSie . Verwenden Sie Office.context.mailbox.diagnose. hostName an, und überprüfen Sie, ob zurückgegeben OutlookWebAppwird. Andernfalls gibt der requestPermissionsAsync Aufruf einen Fehler zurück.

• Wenn ein Benutzer im Dialogfeld "Zulassen " auswählt, bleibt die Berechtigung bestehen, bis das Add-In deinstalliert oder der Cache des Browsers, auf dem das Add-In ausgeführt wird, gelöscht wird. Wenn ein Benutzer den Zugriff eines Add-Ins auf seine Kamera oder sein Mikrofon ändern möchte, muss er das Add-In deinstallieren oder seinen Browsercache löschen.

• Wenn ein Benutzer im Dialogfeld " Einmal zulassen " auswählt, bleibt die Berechtigung bestehen, bis die Browserregisterkarte oder das Fenster, in dem das Add-In ausgeführt wird, geschlossen wird.

• Wenn ein Benutzer im Dialogfeld " Verweigern " auswählt, wird der Benutzer erneut um Berechtigungen gebeten, wenn das Add-In das nächste Mal Zugriff auf die Gerätefunktionen des Benutzers benötigt.

• Wenn Ihr Add-In eine ereignisbasierte Aktivierung implementiert, werden die Browserberechtigungen für Gerätefunktionen nicht vererbt, und die requestPermissionsAsync Methode wird nicht unterstützt.

Beispiele

// 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.
            }
        }
    });
}