Interface ContributedFeature

A feature that can be enabled or disabled

interface ContributedFeature {
    _links?: any;
    defaultState?: boolean;
    defaultValueRules?: ContributedFeatureValueRule[];
    description?: string;
    featureProperties?: { [key: string]: any };
    featureStateChangedListeners?: ContributedFeatureListener[];
    id?: string;
    includeAsClaim?: boolean;
    name?: string;
    order?: number;
    overrideRules?: ContributedFeatureValueRule[];
    scopes?: ContributedFeatureSettingScope[];
    serviceInstanceType?: string;
    tags?: string[];
}

Properties

_links? defaultState? defaultValueRules? description? featureProperties? featureStateChangedListeners? id? includeAsClaim? name? order? overrideRules? scopes? serviceInstanceType? tags?

Properties

Optional_links

_links?: any

Named links describing the feature

OptionaldefaultState

defaultState?: boolean

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

OptionaldefaultValueRules

defaultValueRules?: ContributedFeatureValueRule[]

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)

Optionaldescription

description?: string

The description of the feature

OptionalfeatureProperties

featureProperties?: { [key: string]: any }

Extra properties for the feature

OptionalfeatureStateChangedListeners

featureStateChangedListeners?: ContributedFeatureListener[]

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

Optionalid

id?: string

The full contribution id of the feature

OptionalincludeAsClaim

includeAsClaim?: boolean

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

Optionalname

name?: string

The friendly name of the feature

Optionalorder

order?: number

Suggested order to display feature in.

OptionaloverrideRules

overrideRules?: ContributedFeatureValueRule[]

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)

Optionalscopes

scopes?: ContributedFeatureSettingScope[]

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

OptionalserviceInstanceType

serviceInstanceType?: string

The service instance id of the service that owns this feature

Optionaltags

tags?: string[]

Tags associated with the feature.

Settings

Member Visibility

On This Page

Properties