KFunction

Common
JVM
JS
1.0
interface KFunction<out R> : KCallable<R>, Function<R>
Native
1.3
interface KFunction<out R> : KCallable<R>

Represents a function with introspection capabilities.

Properties

Common
JVM
JS
Native
1.1

isExternal

true if this function is external. See the Kotlin language documentation for more information.

abstract val isExternal: Boolean
Common
JVM
JS
Native
1.1

isInfix

true if this function is infix. See the Kotlin language documentation for more information.

abstract val isInfix: Boolean
Common
JVM
JS
Native
1.1

isInline

true if this function is inline. See the Kotlin language documentation for more information.

abstract val isInline: Boolean
Common
JVM
JS
Native
1.1

isOperator

true if this function is operator. See the Kotlin language documentation for more information.

abstract val isOperator: Boolean
Common
JVM
JS
Native
1.1

isSuspend

true if this is a suspending function.

abstract val isSuspend: Boolean

Extension Properties

JVM
1.1

extensionReceiverParameter

Returns a parameter representing the extension receiver instance needed to call this callable, or null if this callable is not an extension.

val KCallable<*>.extensionReceiverParameter: KParameter?
JVM
1.1

instanceParameter

Returns a parameter representing the this instance needed to call this callable, or null if this callable is not a member of a class and thus doesn't take such parameter.

val KCallable<*>.instanceParameter: KParameter?
JVM
1.0

isAccessible

Provides a way to suppress JVM access checks for a callable.

var KCallable<*>.isAccessible: Boolean
JVM
1.0

javaConstructor

Returns a Java Constructor instance corresponding to the given Kotlin function, or null if this function is not a constructor or cannot be represented by a Java Constructor.

val <T> KFunction<T>.javaConstructor: Constructor<T>?
JVM
1.0

javaMethod

Returns a Java Method instance corresponding to the given Kotlin function, or null if this function is a constructor or cannot be represented by a Java Method.

val KFunction<*>.javaMethod: Method?
JVM
1.1

valueParameters

Returns parameters of this callable, excluding the this instance and the extension receiver parameter.

val KCallable<*>.valueParameters: List<KParameter>

Extension Functions

JVM
1.3

callSuspend

Calls a callable in the current suspend context. If the callable is not a suspend function, behaves as KCallable.call. Otherwise, calls the suspend function with current continuation.

suspend fun <R> KCallable<R>.callSuspend(
    vararg args: Any?
): R
JVM
1.3

callSuspendBy

Calls a callable in the current suspend context. If the callable is not a suspend function, behaves as KCallable.callBy. Otherwise, calls the suspend function with current continuation.

suspend fun <R> KCallable<R>.callSuspendBy(
    args: Map<KParameter, Any?>
): R
JVM
1.1

findAnnotation

Returns an annotation of the given type on this element.

fun <T : Annotation> KAnnotatedElement.findAnnotation(): T?
JVM
1.1

findParameterByName

Returns the parameter of this callable with the given name, or null if there's no such parameter.

fun KCallable<*>.findParameterByName(
    name: String
): KParameter?
JVM
1.0

reflect

This is an experimental API. Given a class for a compiled Kotlin lambda or a function expression, returns a KFunction instance providing introspection capabilities for that lambda or function expression and its parameters. Not all features are currently supported, in particular KCallable.call and KCallable.callBy will fail at the moment.

fun <R> Function<R>.reflect(): KFunction<R>?

Inheritors

Common
JVM
JS
Native
1.0

Getter

Getter of the property is a get method declared alongside the property.

interface Getter<out R> : Accessor<R>, KFunction<R>
Common
JVM
JS
Native
1.0

Setter

Setter of the property is a set method declared alongside the property.

interface Setter<R> : Accessor<R>, KFunction<Unit>