Editar

Partilhar via


ContributedFeature interface

A feature that can be enabled or disabled

Properties

defaultState

If true, the feature is enabled unless overridden at some scope

defaultValueRules

Rules for setting the default value if not specified by any setting/scope. Evaluated in order until a rule returns an Enabled or Disabled state (not Undefined)

description

The description of the feature

featureProperties

Extra properties for the feature

featureStateChangedListeners

Handler for listening to setter calls on feature value. These listeners are only invoked after a successful set has occurred

id

The full contribution id of the feature

includeAsClaim

If this is set to true, then the id for this feature will be added to the list of claims for the request.

name

The friendly name of the feature

order

Suggested order to display feature in.

overrideRules

Rules for overriding a feature value. These rules are run before explicit user/host state values are checked. They are evaluated in order until a rule returns an Enabled or Disabled state (not Undefined)

scopes

The scopes/levels at which settings can set the enabled/disabled state of this feature

serviceInstanceType

The service instance id of the service that owns this feature

tags

Tags associated with the feature.

Property Details

defaultState

If true, the feature is enabled unless overridden at some scope

defaultState: boolean

Property Value

boolean

defaultValueRules

Rules for setting the default value if not specified by any setting/scope. Evaluated in order until a rule returns an Enabled or Disabled state (not Undefined)

defaultValueRules: ContributedFeatureValueRule[]

Property Value

description

The description of the feature

description: string

Property Value

string

featureProperties

Extra properties for the feature

featureProperties: {[key: string]: any}

Property Value

{[key: string]: any}

featureStateChangedListeners

Handler for listening to setter calls on feature value. These listeners are only invoked after a successful set has occurred

featureStateChangedListeners: ContributedFeatureListener[]

Property Value

id

The full contribution id of the feature

id: string

Property Value

string

includeAsClaim

If this is set to true, then the id for this feature will be added to the list of claims for the request.

includeAsClaim: boolean

Property Value

boolean

name

The friendly name of the feature

name: string

Property Value

string

order

Suggested order to display feature in.

order: number

Property Value

number

overrideRules

Rules for overriding a feature value. These rules are run before explicit user/host state values are checked. They are evaluated in order until a rule returns an Enabled or Disabled state (not Undefined)

overrideRules: ContributedFeatureValueRule[]

Property Value

scopes

The scopes/levels at which settings can set the enabled/disabled state of this feature

scopes: ContributedFeatureSettingScope[]

Property Value

serviceInstanceType

The service instance id of the service that owns this feature

serviceInstanceType: string

Property Value

string

tags

Tags associated with the feature.

tags: string[]

Property Value

string[]