DisabledFeature

public struct DisabledFeature : Content

A feature that has been turned off by the server. If the appName is all, the indicated featureName is disabled at the API level for this feature and all relevant endpoints will return errors. For any other value of appName, the API still works, but the indicated client apps should not allow the feature to be accessed. The goal is to be able to disable code that is impacting server stability or performance without shutting down the server entirely or disallowing specific clients entirely.

Used in UserNotificationData.

Show on GitHub

  • AppName and featureName act as a grid, allowing a specific feature to be disabled only in a specific app. If the appName is all, the server code for the feature may be causing the issue, requiring the feature be disabled for all clients.

    Declaration

    Swift

    var appName: SwiftarrClientApp
    Show on GitHub

  • The feature to disable. Features roughly match API controller groups.

    Declaration

    Swift

    var featureName: SwiftarrFeature
    Show on GitHub