Interface FeatureConfigs

Contains the configuration information about various features provided by the Omni SDK. Note: these configurations are received from the server, and are not configurable by the client.

interface FeatureConfigs {
    getAllFeatures(): Readonly<FeatureConfig>[];
    getFeature(featureName: string): undefined | Readonly<FeatureConfig>;
    hasFeature(featureName: string): boolean;
}

Methods

getAllFeatures getFeature hasFeature

Methods

getAllFeatures

  • getAllFeatures(): Readonly<FeatureConfig>[]

  • Get the configurations for all the features that are available.

    Returns Readonly<FeatureConfig>[]

    An array of all feature configurations.

getFeature

  • getFeature(featureName): undefined | Readonly<FeatureConfig>

  • Get the configuration for the specified feature if its available.

    Parameters

    • featureName: string

      Name of the feature to get the configuration for.

    Returns undefined | Readonly<FeatureConfig>

    The configuration for the feature if available, otherwise undefined.

hasFeature

  • hasFeature(featureName): boolean

  • Check if configuration for the provided feature name are available.

    Parameters

    • featureName: string

      Name of the feature to check.

    Returns boolean

    true if the feature is available, otherwise false.

Settings

On This Page

Methods