1 /* 2 * Copyright (C) 2024 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package com.android.systemui.biometrics.plugins 18 19 import com.android.systemui.plugins.AuthContextPlugin 20 import com.android.systemui.plugins.PluginManager 21 22 /** Wrapper interface for registering & forwarding events to all available [AuthContextPlugin]s. */ 23 interface AuthContextPlugins { 24 /** Finds and actives all plugins via SysUI's [PluginManager] (should be called at startup). */ activatenull25 fun activate() 26 27 /** 28 * Interact with all registered plugins. 29 * 30 * The provided [block] will be repeated for each available plugin. 31 */ 32 suspend fun use(block: (AuthContextPlugin) -> Unit) 33 34 /** 35 * Like [use] but when no existing coroutine context is available. 36 * 37 * The [block] will be run on SysUI's general background context and can, optionally, be 38 * confined to [runOnMain] (defaults to a background thread). 39 */ 40 fun useInBackground(runOnMain: Boolean = false, block: (AuthContextPlugin) -> Unit) 41 } 42