Export (0) Print
Expand All

RoamingSettings.remove method (JavaScript API for Office)

apps for Office

Removes the specified setting.

Last modified: March 04, 2015

Hosts:Outlook

App type: Mail

Available in requirement sets

Mailbox

Last changed in Mailbox

1.0

Applicable Outlook modes

Compose or read

See all support details

Office.context.roamingSettings.remove(name);

name

Type: string

The case-sensitive name of the setting to remove.

null is a valid value for a setting. Therefore, assigning null to the setting will not remove it from the settings property bag.

function removeMySetting() {
    Office.context.roamingSettings.remove('mySetting');
}

A checkmark (√) in the following table indicates that this property is supported in the corresponding Outlook host application. An empty cell indicates that the Outlook host application doesn't support this property.

For more information about Office host application and server requirements, see Requirements for running apps for Office.

Supported hosts, by platform

Office for Windows desktop

Office for Windows RT

Office Online
(in browser)

OWA for Devices

Office for Mac

Outlook

√ (Read mode only)

Available in requirement sets

Mailbox

Minimum permission level

Restricted

App types

Mail

Library

Office.js

Namespace

Office

Version

Changes

1.0

Introduced

Show:
© 2015 Microsoft