RequiresApi

  • Cmn
    @MustBeDocumented
    @Retention(value = AnnotationRetention.BINARY)
    @Target(allowedTargets = [AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FIELD, AnnotationTarget.FILE])
    @OptionalExpectation
    annotation RequiresApi
  • android
    @MustBeDocumented
    @Retention(value = AnnotationRetention.BINARY)
    @Target(allowedTargets = [AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FIELD, AnnotationTarget.FILE])
    @Target(value = [ElementType.TYPE, ElementType.METHOD, ElementType.CONSTRUCTOR, ElementType.FIELD, ElementType.PACKAGE])
    annotation RequiresApi

Denotes that the annotated element should only be called on the given Android API level or higher.

This is similar in purpose to the older @TargetApi annotation, but more clearly expresses that this is a requirement on the caller, rather than being used to "suppress" warnings within the method that exceed the minSdkVersion.

For API requirements on SDK extensions, see the androidx.annotation.RequiresExtension annotation.

Summary

Public constructors

RequiresApi(value: @IntRange(from = 1) Int, api: @IntRange(from = 1) Int)
Cmn
android

Public properties

Int

The API level to require

Cmn
android
Int

The API level to require.

Cmn
android

Public constructors

RequiresApi

RequiresApi(value: @IntRange(from = 1) Int = 1, api: @IntRange(from = 1) Int = 1)

Public properties

api

val apiInt

The API level to require

value

val valueInt

The API level to require. Alias for .api which allows you to leave out the api= part.