Skip to content

Commit 35d251c

Browse files
author
github-actions
committed
Merge branch 'main' into live
2 parents a2f4c4f + d5ab219 commit 35d251c

File tree

5 files changed

+43
-3
lines changed

5 files changed

+43
-3
lines changed

docs/code-snippets/office-snippets.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3946,6 +3946,14 @@ Office.PlatformType:enum:
39463946
const contextInfo = Office.context.diagnostics;
39473947
const platformType: Office.PlatformType = contextInfo.platform;
39483948
console.log("Platform: " + platformType);
3949+
Office.RequirementSetSupport:interface:
3950+
- |-
3951+
const requirements : Office.RequirementSetSupport = Office.context.requirements;
3952+
if (requirements.isSetSupported('Mailbox', '1.14')) {
3953+
// Code that uses APIs from the 'Mailbox 1.14' requirement set.
3954+
} else {
3955+
// An alternate path (such as a message to the user) when the requirement set isn't supported.
3956+
}
39493957
Office.Ribbon#requestCreateControls:member(1):
39503958
- |-
39513959
// Registers a custom contextual tab with Office.

docs/docs-ref-autogen/office/office/office.requirementsetsupport.yml

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,19 @@ uid: 'office!Office.RequirementSetSupport:interface'
44
package: office!
55
fullName: Office.RequirementSetSupport
66
summary: Provides information about which Requirement Sets are supported in the current environment.
7-
remarks: ''
7+
remarks: |-
8+
9+
10+
#### Examples
11+
12+
```TypeScript
13+
const requirements : Office.RequirementSetSupport = Office.context.requirements;
14+
if (requirements.isSetSupported('Mailbox', '1.14')) {
15+
// Code that uses APIs from the 'Mailbox 1.14' requirement set.
16+
} else {
17+
// An alternate path (such as a message to the user) when the requirement set isn't supported.
18+
}
19+
```
820
isPreview: false
921
isDeprecated: false
1022
type: interface

docs/docs-ref-autogen/office_release/office/office.requirementsetsupport.yml

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,19 @@ uid: 'office!Office.RequirementSetSupport:interface'
44
package: office!
55
fullName: Office.RequirementSetSupport
66
summary: Provides information about which Requirement Sets are supported in the current environment.
7-
remarks: ''
7+
remarks: |-
8+
9+
10+
#### Examples
11+
12+
```TypeScript
13+
const requirements : Office.RequirementSetSupport = Office.context.requirements;
14+
if (requirements.isSetSupported('Mailbox', '1.14')) {
15+
// Code that uses APIs from the 'Mailbox 1.14' requirement set.
16+
} else {
17+
// An alternate path (such as a message to the user) when the requirement set isn't supported.
18+
}
19+
```
820
isPreview: false
921
isDeprecated: false
1022
type: interface

generate-docs/API Coverage Report.csv

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7713,7 +7713,7 @@ Office.RangeFormatConfiguration,"format",Property,Good,false
77137713
Office.RemoveHandlerOptions,N/A,Class,Fine,false
77147714
Office.RemoveHandlerOptions,"asyncContext",Property,Fine,false
77157715
Office.RemoveHandlerOptions,"handler",Property,Good,false
7716-
Office.RequirementSetSupport,N/A,Class,Fine,false
7716+
Office.RequirementSetSupport,N/A,Class,Fine,true
77177717
Office.RequirementSetSupport,"isSetSupported(name, minVersion)",Method,Poor,false
77187718
Office.RequirementSetSupport,"isSetSupported(name, minVersionNumber)",Method,Deprecated,false
77197719
Office.Ribbon,N/A,Class,Good,false

generate-docs/script-inputs/local-repo-snippets.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5487,6 +5487,14 @@ Office.PlatformType:enum:
54875487
const contextInfo = Office.context.diagnostics;
54885488
const platformType: Office.PlatformType = contextInfo.platform;
54895489
console.log("Platform: " + platformType);
5490+
Office.RequirementSetSupport:interface:
5491+
- |-
5492+
const requirements : Office.RequirementSetSupport = Office.context.requirements;
5493+
if (requirements.isSetSupported('Mailbox', '1.14')) {
5494+
// Code that uses APIs from the 'Mailbox 1.14' requirement set.
5495+
} else {
5496+
// An alternate path (such as a message to the user) when the requirement set isn't supported.
5497+
}
54905498
Office.Ribbon#requestCreateControls:member(1):
54915499
- |-
54925500
// Registers a custom contextual tab with Office.

0 commit comments

Comments
 (0)