Skip to content

Commit c3635c3

Browse files
ElizabethSamuel-MSFTgithub-actions
andauthored
Automatically generated docs (#2308)
Co-authored-by: github-actions <[email protected]>
1 parent cdd5390 commit c3635c3

File tree

18 files changed

+351
-1
lines changed

18 files changed

+351
-1
lines changed

docs/docs-ref-autogen/outlook/outlook/office.roamingsettings.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,27 @@ methods:
140140
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
141141
-->**: Compose or Read
142142
143+
144+
#### Examples
145+
146+
147+
```TypeScript
148+
149+
// Link to full sample:
150+
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/10-roaming-settings/roaming-settings.yaml
151+
152+
153+
// Remove the specified setting from the mailbox.
154+
155+
const settingName = (document.getElementById("settingName") as
156+
HTMLInputElement).value;
157+
158+
Office.context.roamingSettings.remove(settingName);
159+
160+
console.log(`The "${settingName}" setting has been removed.`);
161+
162+
```
163+
143164
isPreview: false
144165
isDeprecated: false
145166
syntax:

docs/docs-ref-autogen/outlook_1_1/outlook/office.roamingsettings.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,27 @@ methods:
140140
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
141141
-->**: Compose or Read
142142
143+
144+
#### Examples
145+
146+
147+
```TypeScript
148+
149+
// Link to full sample:
150+
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/10-roaming-settings/roaming-settings.yaml
151+
152+
153+
// Remove the specified setting from the mailbox.
154+
155+
const settingName = (document.getElementById("settingName") as
156+
HTMLInputElement).value;
157+
158+
Office.context.roamingSettings.remove(settingName);
159+
160+
console.log(`The "${settingName}" setting has been removed.`);
161+
162+
```
163+
143164
isPreview: false
144165
isDeprecated: false
145166
syntax:

docs/docs-ref-autogen/outlook_1_10/outlook/office.roamingsettings.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,27 @@ methods:
140140
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
141141
-->**: Compose or Read
142142
143+
144+
#### Examples
145+
146+
147+
```TypeScript
148+
149+
// Link to full sample:
150+
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/10-roaming-settings/roaming-settings.yaml
151+
152+
153+
// Remove the specified setting from the mailbox.
154+
155+
const settingName = (document.getElementById("settingName") as
156+
HTMLInputElement).value;
157+
158+
Office.context.roamingSettings.remove(settingName);
159+
160+
console.log(`The "${settingName}" setting has been removed.`);
161+
162+
```
163+
143164
isPreview: false
144165
isDeprecated: false
145166
syntax:

docs/docs-ref-autogen/outlook_1_11/outlook/office.roamingsettings.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,27 @@ methods:
140140
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
141141
-->**: Compose or Read
142142
143+
144+
#### Examples
145+
146+
147+
```TypeScript
148+
149+
// Link to full sample:
150+
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/10-roaming-settings/roaming-settings.yaml
151+
152+
153+
// Remove the specified setting from the mailbox.
154+
155+
const settingName = (document.getElementById("settingName") as
156+
HTMLInputElement).value;
157+
158+
Office.context.roamingSettings.remove(settingName);
159+
160+
console.log(`The "${settingName}" setting has been removed.`);
161+
162+
```
163+
143164
isPreview: false
144165
isDeprecated: false
145166
syntax:

docs/docs-ref-autogen/outlook_1_12/outlook/office.roamingsettings.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,27 @@ methods:
140140
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
141141
-->**: Compose or Read
142142
143+
144+
#### Examples
145+
146+
147+
```TypeScript
148+
149+
// Link to full sample:
150+
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/10-roaming-settings/roaming-settings.yaml
151+
152+
153+
// Remove the specified setting from the mailbox.
154+
155+
const settingName = (document.getElementById("settingName") as
156+
HTMLInputElement).value;
157+
158+
Office.context.roamingSettings.remove(settingName);
159+
160+
console.log(`The "${settingName}" setting has been removed.`);
161+
162+
```
163+
143164
isPreview: false
144165
isDeprecated: false
145166
syntax:

docs/docs-ref-autogen/outlook_1_13/outlook/office.roamingsettings.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,27 @@ methods:
140140
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
141141
-->**: Compose or Read
142142
143+
144+
#### Examples
145+
146+
147+
```TypeScript
148+
149+
// Link to full sample:
150+
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/10-roaming-settings/roaming-settings.yaml
151+
152+
153+
// Remove the specified setting from the mailbox.
154+
155+
const settingName = (document.getElementById("settingName") as
156+
HTMLInputElement).value;
157+
158+
Office.context.roamingSettings.remove(settingName);
159+
160+
console.log(`The "${settingName}" setting has been removed.`);
161+
162+
```
163+
143164
isPreview: false
144165
isDeprecated: false
145166
syntax:

docs/docs-ref-autogen/outlook_1_14/outlook/office.roamingsettings.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,27 @@ methods:
140140
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
141141
-->**: Compose or Read
142142
143+
144+
#### Examples
145+
146+
147+
```TypeScript
148+
149+
// Link to full sample:
150+
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/10-roaming-settings/roaming-settings.yaml
151+
152+
153+
// Remove the specified setting from the mailbox.
154+
155+
const settingName = (document.getElementById("settingName") as
156+
HTMLInputElement).value;
157+
158+
Office.context.roamingSettings.remove(settingName);
159+
160+
console.log(`The "${settingName}" setting has been removed.`);
161+
162+
```
163+
143164
isPreview: false
144165
isDeprecated: false
145166
syntax:

docs/docs-ref-autogen/outlook_1_15/outlook/office.roamingsettings.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,27 @@ methods:
140140
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
141141
-->**: Compose or Read
142142
143+
144+
#### Examples
145+
146+
147+
```TypeScript
148+
149+
// Link to full sample:
150+
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/10-roaming-settings/roaming-settings.yaml
151+
152+
153+
// Remove the specified setting from the mailbox.
154+
155+
const settingName = (document.getElementById("settingName") as
156+
HTMLInputElement).value;
157+
158+
Office.context.roamingSettings.remove(settingName);
159+
160+
console.log(`The "${settingName}" setting has been removed.`);
161+
162+
```
163+
143164
isPreview: false
144165
isDeprecated: false
145166
syntax:

docs/docs-ref-autogen/outlook_1_2/outlook/office.roamingsettings.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,27 @@ methods:
140140
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
141141
-->**: Compose or Read
142142
143+
144+
#### Examples
145+
146+
147+
```TypeScript
148+
149+
// Link to full sample:
150+
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/10-roaming-settings/roaming-settings.yaml
151+
152+
153+
// Remove the specified setting from the mailbox.
154+
155+
const settingName = (document.getElementById("settingName") as
156+
HTMLInputElement).value;
157+
158+
Office.context.roamingSettings.remove(settingName);
159+
160+
console.log(`The "${settingName}" setting has been removed.`);
161+
162+
```
163+
143164
isPreview: false
144165
isDeprecated: false
145166
syntax:

docs/docs-ref-autogen/outlook_1_3/outlook/office.roamingsettings.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,27 @@ methods:
140140
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
141141
-->**: Compose or Read
142142
143+
144+
#### Examples
145+
146+
147+
```TypeScript
148+
149+
// Link to full sample:
150+
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/10-roaming-settings/roaming-settings.yaml
151+
152+
153+
// Remove the specified setting from the mailbox.
154+
155+
const settingName = (document.getElementById("settingName") as
156+
HTMLInputElement).value;
157+
158+
Office.context.roamingSettings.remove(settingName);
159+
160+
console.log(`The "${settingName}" setting has been removed.`);
161+
162+
```
163+
143164
isPreview: false
144165
isDeprecated: false
145166
syntax:

0 commit comments

Comments
 (0)