[Outlook] (roaming settings) Update sample (#991)

* Update roaming settings sample

* Apply suggestion from review

Co-authored-by: Elizabeth Samuel <[email protected]>

* Run script

---------

Co-authored-by: Elizabeth Samuel <[email protected]>

Author: samantharamon

playlists-prod/outlook.yaml

@@ -1,7 +1,7 @@
 - id: outlook-roaming-settings-roaming-settings
   name: Use add-in settings
   fileName: roaming-settings.yaml
-  description: 'Gets, sets, and saves add-in roaming settings'
+  description: 'Gets, sets, saves, and removes add-in roaming settings.'
   rawUrl: >-
     https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/10-roaming-settings/roaming-settings.yaml
   group: Roaming Settings

playlists/outlook.yaml

@@ -1,7 +1,7 @@
 - id: outlook-roaming-settings-roaming-settings
   name: Use add-in settings
   fileName: roaming-settings.yaml
-  description: 'Gets, sets, and saves add-in roaming settings'
+  description: 'Gets, sets, saves, and removes add-in roaming settings.'
   rawUrl: >-
     https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/outlook/10-roaming-settings/roaming-settings.yaml
   group: Roaming Settings

samples/outlook/10-roaming-settings/roaming-settings.yaml

@@ -1,6 +1,6 @@
 id: outlook-roaming-settings-roaming-settings
 name: Use add-in settings
-description: 'Gets, sets, and saves add-in roaming settings'
+description: 'Gets, sets, saves, and removes add-in roaming settings.'
 host: OUTLOOK
 api_set:
     Mailbox: '1.1'
@@ -9,21 +9,22 @@ script:
         document.getElementById("get").addEventListener("click", get);
         document.getElementById("set").addEventListener("click", set);
         document.getElementById("save").addEventListener("click", save);
+        document.getElementById("remove").addEventListener("click", remove);
 
         function get() {
           const settingName = (document.getElementById("settingName") as HTMLInputElement).value;
           const settingValue = Office.context.roamingSettings.get(settingName);
           (document.getElementById("settingValue") as HTMLInputElement).value = settingValue;
           console.log(`The value of setting "${settingName}" is "${settingValue}".`);
         }
-          
+
         function set() {
           const settingName = (document.getElementById("settingName") as HTMLInputElement).value;
           const settingValue = (document.getElementById("settingValue") as HTMLInputElement).value;
           Office.context.roamingSettings.set(settingName, settingValue);
           console.log(`Setting "${settingName}" set to value "${settingValue}".`);
         }
-          
+
         function save() {
           // Save settings in the mailbox to make it available in future sessions.
           Office.context.roamingSettings.saveAsync(function(result) {
@@ -34,6 +35,13 @@ script:
             }
           });
         }
+
+        function remove() {
+          // Remove the specified setting from the mailbox.
+          const settingName = (document.getElementById("settingName") as HTMLInputElement).value;
+          Office.context.roamingSettings.remove(settingName);
+          console.log(`The "${settingName}" setting has been removed.`);
+        }
     language: typescript
 template:
     content: |-
@@ -59,6 +67,9 @@ template:
           <button id="save" class="ms-Button">
             <div class="ms-Button-label">Save all</div>
           </button>
+          <button id="remove" class="ms-Button">
+            <div class="ms-Button-label">Remove</div>
+          </button>
         </section>
     language: html
 style:

snippet-extractor-metadata/outlook.xlsx

@@ -14387,6 +14387,20 @@
     settingValue;
 
     console.log(`The value of setting "${settingName}" is "${settingValue}".`);
+'Office.RoamingSettings#remove:member(1)':
+  - >-
+    // Link to full sample:
+    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/10-roaming-settings/roaming-settings.yaml
+
+
+    // Remove the specified setting from the mailbox.
+
+    const settingName = (document.getElementById("settingName") as
+    HTMLInputElement).value;
+
+    Office.context.roamingSettings.remove(settingName);
+
+    console.log(`The "${settingName}" setting has been removed.`);
 'Office.RoamingSettings#saveAsync:member(1)':
   - >-
     // Link to full sample: