Informing ClassKit that a task is about to begin

Overview

To provide hints to Schoolwork about which tasks are most recently and commonly used, activate the context that represents that task.

Activate contexts when users begin tasks

When a person navigates to a point in your app that corresponds to a particular context, you activate that context with a call to the becomeActive() method.

In many cases, contexts correspond directly to views in your app. This lets you associate view appearance with context activation. For example, if your app presents one section of a chapter as a scroll view, and the corresponding view controller has a handle on the model instance representing that section, you can use the viewDidAppear(_:) method to activate the context:

override func viewDidAppear(_ animated: Bool) {
    super.viewDidAppear(animated)

    let path = section.identifierPath
    CLSDataStore.shared.mainAppContext.descendant(matchingIdentifierPath: path) { context, _ in
        context?.becomeActive()
    }
}

Deactivate contexts when users finish

Similarly, you deactivate a context when the user leaves the corresponding area of your app using a call to the resignActive() method. In the case of the section view, you can add the call to the view controller’s viewWillDisappear(_:) method:

override func viewWillDisappear(_ animated: Bool) {
    super.viewWillDisappear(animated)

    let path = section.identifierPath
    CLSDataStore.shared.mainAppContext.descendant(matchingIdentifierPath: path) { context, _ in
        context?.resignActive()
    }
}

Only one context can be active at a time. If you activate a new context when one is already active, the framework automatically causes the old one to resign.

See Also

Activating and deactivating a context

• becomeActive()
• resignActive()
• isActive