Edit

Share via

Office.RequirementSetSupport interface

Package:
office

Provides information about which Requirement Sets are supported in the current environment.

Remarks

Examples

const requirements : Office.RequirementSetSupport = Office.context.requirements; 
if (requirements.isSetSupported('Mailbox', '1.14')) {
    // Code that uses APIs from the 'Mailbox 1.14' requirement set.
} else {
    // An alternate path (such as a message to the user) when the requirement set isn't supported.
}

Methods

isSetSupported(name, minVersion)

Check if the specified requirement set is supported by the Office application.
isSetSupported(name, minVersionNumber)

Check if the specified requirement set is supported by the Office application.

Method Details

isSetSupported(name, minVersion)

Check if the specified requirement set is supported by the Office application.

isSetSupported(name: string, minVersion?: string): boolean;

Parameters

name

string

The requirement set name (e.g., "ExcelApi").

minVersion

string

The minimum required version (e.g., "1.4").

Returns

boolean

isSetSupported(name, minVersionNumber)

Warning

This API is now deprecated.

Use the string overload of isSetSupported instead.

Check if the specified requirement set is supported by the Office application.

isSetSupported(name: string, minVersionNumber?: number): boolean;

Parameters

name

string

The requirement set name (e.g., "ExcelApi").

minVersionNumber

number

The minimum required version (e.g., 1.4).

Returns

boolean