1 /* 2 * Copyright (C) 2017 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 package androidx.lifecycle 17 18 import kotlinx.coroutines.CoroutineScope 19 20 /** 21 * A class that has an Android lifecycle. These events can be used by custom components to handle 22 * lifecycle changes without implementing any code inside the Activity or the Fragment. 23 * 24 * @see Lifecycle 25 * @see ViewTreeLifecycleOwner 26 */ 27 public interface LifecycleOwner { 28 /** 29 * Returns the Lifecycle of the provider. 30 * 31 * @return The lifecycle of the provider. 32 */ 33 public val lifecycle: Lifecycle 34 } 35 36 /** 37 * [CoroutineScope] tied to this [LifecycleOwner]'s [Lifecycle]. 38 * 39 * This scope will be cancelled when the [Lifecycle] is destroyed. 40 * 41 * This scope is bound to 42 * [Dispatchers.Main.immediate][kotlinx.coroutines.MainCoroutineDispatcher.immediate]. 43 */ 44 public val LifecycleOwner.lifecycleScope: LifecycleCoroutineScope 45 get() = lifecycle.coroutineScope 46