RequiresOptIn

Требования к платформе и версии: JVM (1.3), JS (1.3), Native (1.3)

@Target([AnnotationTarget.ANNOTATION_CLASS]) annotation class RequiresOptIn

Указывает, что аннотированный класс аннотации является маркером API, который требует явного opt-in.

Места вызова любой декларации, помеченной этим маркером, должны быть включены в API, либо с использованием OptIn, либо путём аннотации самим маркером, что, в свою очередь, вызывает дальнейшее распространение требования opt-in.

Типы

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

Уровень

Степень диагностики, которая должна быть сообщена при использовании, которое не явно не включено в API, либо с помощью OptIn, либо путём аннотации соответствующим маркером аннотации.

enum class Level

Конструкторы

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

<init>

Указывает, что аннотированный класс аннотации является маркером API, который требует явного opt-in.

RequiresOptIn(
    message: String = "", 
    level: Level = Level.ERROR)

Свойства

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

уровень

указывает, как сообщаются использования API без явного opt-in в коде.

val level: Level

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

сообщение

сообщение, которое должно быть сообщено при использовании API без явного opt-in, или пустая строка для стандартного сообщения. Стандартное сообщение: «Эта декларация является экспериментальной, и ее использование должно быть помечено с помощью 'Marker' или '@OptIn(Marker::class)'», где Marker — маркер требования opt-in.

val message: String

© 2010–2022 JetBrains s.r.o. and Kotlin Programming Language contributors
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-requires-opt-in/