id: outlook-roaming-settings-roaming-settings
name: Use add-in settings
description: Gets, sets, saves, and removes add-in roaming settings.
host: OUTLOOK
api_set:
    Mailbox: '1.1'
script:
    content: |-
        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) {
            if (result.status !== Office.AsyncResultStatus.Succeeded) {
              console.error(`Action failed with message ${result.error.message}`);
            } else {
              console.log(`Settings saved with status: ${result.status}`);
            }
          });
        }

        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: |-
        <section>
          <p>This sample shows how to set, save, and get add-in properties that can be accessed the next time the add-in is opened.</p>
        </section>
        <section>
          <h3>Try it out</h3>
          <label>Setting name:</label>
          <input id="settingName" type="text" value="hello" placeholder="">
          <label>Setting value:</label>
          <input id="settingValue" type="text" value="world" placeholder="">
          <button id="set">Set</button>
          <button id="get">Get</button>
          <button id="save">Save all</button>
          <button id="remove">Remove</button>
        </section>
    language: html
style:
    content: |-
        body {
            font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;
            font-size: 14px;
            line-height: 1.5;
            padding: 10px;
        }

        section {
            margin-bottom: 20px;
        }

        h3 {
            margin-top: 0;
            margin-bottom: 10px;
            font-size: 16px;
        }

        p {
            margin: 0 0 10px 0;
        }

        button {
            background-color: #f0f0f0;
            color: #333333;
            border: 1px solid #8a8a8a;
            padding: 8px 16px;
            font-size: 14px;
            cursor: pointer;
            border-radius: 2px;
            margin-left: 20px;
            margin-bottom: 5px;
            min-width: 80px;
            display: block;
        }

        button:hover {
            background-color: #e0e0e0;
        }

        button:active {
            background-color: #d0d0d0;
        }

        input {
            padding: 8px;
            margin: 5px 0;
            border: 1px solid #ccc;
            border-radius: 2px;
            font-size: 14px;
        }

        .header {
            text-align: center;
            background-color: #f3f2f1;
            padding: 10px;
        }
    language: css
libraries: |-
    https://appsforoffice.microsoft.com/lib/1/hosted/office.js
    https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/master/types/office-js/index.d.ts