KillSwitchProvider

open class KillSwitchProvider : KillSwitchProviderProtocol

Undocumented

  • Called when a network error is received.

    Declaration

    Swift

    public func receivedError(_ error: APIErrorType?)

    Parameters

    error

    Api error.

  • Provide Bellerophon’s current status according to the status object received.

    Declaration

    Swift

    public func bellerophonStatus(_ manager: BellerophonManager, completion: @escaping (BellerophonObservable?, Error?) -> Void)

    Parameters

    manager

    The Bellerophon manager.

    completion

    Completion block that returns the BellerophonObservable status.

  • Called to determine if the killswitch is activated.

    Declaration

    Swift

    public func apiInactive() -> Bool

    Return Value

    Flag if the killswitch is activated.

  • Called to determine if the force update is activated.

    Declaration

    Swift

    public func forceUpdate() -> Bool

    Return Value

    Flag if the force update is activated.

  • The network retry interval before re-checking the app status.

    Declaration

    Swift

    public func retryInterval() -> TimeInterval

    Return Value

    Time interval for re-checking the app status.

  • User message to display on the custom view.

    Declaration

    Swift

    public func userMessage() -> String

    Return Value

    User message string to display.

  • Optional deprecated function to set the user’s message.

    Declaration

    Swift

    public func setUserMessage(_ message: String)

    Parameters

    message

    Message string.