Krosstalk Core/com.rnett.krosstalk/MethodDefinition

MethodDefinition

@KrosstalkPluginApi

data class MethodDefinition<T> @InternalKrosstalkApi constructor(name: String, endpoint: Endpoint, httpMethod: String, contentType: String?, requiredScopes: Set<Scope>, optionalScopes: Set<Scope>, useExplicitResult: Boolean, includeStacktrace: Boolean, propagateServerExceptions: Boolean, optionalParameters: Set<String>, serverDefaultParameters: Set<String>, objectParameters: Map<String, *>, returnObject: Any?, outerWithHeaders: Boolean, innerWithHeaders: Boolean, requestHeadersParam: String?, serverUrlParam: String?, types: MethodTypes, serialization: MethodSerialization, call: MethodCaller<T>)

All the Krosstalk metadata associated with a krosstalk method.

Constructors

MethodDefinition

@InternalKrosstalkApi

fun MethodDefinition(name: String, endpoint: Endpoint, httpMethod: String, contentType: String?, requiredScopes: Set<Scope>, optionalScopes: Set<Scope>, useExplicitResult: Boolean, includeStacktrace: Boolean, propagateServerExceptions: Boolean, optionalParameters: Set<String>, serverDefaultParameters: Set<String>, objectParameters: Map<String, *>, returnObject: Any?, outerWithHeaders: Boolean, innerWithHeaders: Boolean, requestHeadersParam: String?, serverUrlParam: String?, types: MethodTypes, serialization: MethodSerialization, call: MethodCaller<T>)

Properties

val allScopes: Set<Scope>

all scopes used by the method

@InternalKrosstalkApi

val call: MethodCaller<T>

a lambda to call the method

val contentType: String?

the content type to use for bodies, or null to use the serialization handler's

val endpoint: Endpoint

the method endpoint

val httpMethod: String

the http method to use

includeStacktrace

@InternalKrosstalkApi

val includeStacktrace: Boolean

whether any KrosstalkResult.ServerExceptions should include the exception stack trace

innerWithHeaders

@InternalKrosstalkApi

val innerWithHeaders: Boolean

whether to wrap the initial result (not including KrosstalkResult handling) in WithHeaders

val name: String

the method name

objectParameters

@InternalKrosstalkApi

val objectParameters: Map<String, *>

parameters that are objects and shouldn't be transfered

optionalParameters

@InternalKrosstalkApi

val optionalParameters: Set<String>

scopes optionally used by the method

val optionalScopes: Set<Scope>

outerWithHeaders

@InternalKrosstalkApi

val outerWithHeaders: Boolean

whether to wrap the final result (including KrosstalkResult handling) in WithHeaders

propagateServerExceptions

@InternalKrosstalkApi

val propagateServerExceptions: Boolean

whether ExceptionHandling.propagateServerExceptions is set

requestHeadersParam

@InternalKrosstalkApi

val requestHeadersParam: String?

the name of the parameter that contains the request headers, if there is one

val requiredScopes: Set<Scope>

scopes required by the method

@InternalKrosstalkApi

val returnObject: Any?

the object to use as the return value, if there is one

@InternalKrosstalkApi

val serialization: MethodSerialization

serverDefaultParameters

@InternalKrosstalkApi

val serverDefaultParameters: Set<String>

parameters using ServerDefault

@InternalKrosstalkApi

val serverUrlParam: String?

the name of the parameter that contains the server url, if there is one

@InternalKrosstalkApi

val types: MethodTypes

the method's parameter and return types

useExplicitResult

@InternalKrosstalkApi

val useExplicitResult: Boolean

whether the result is wrapped in a KrosstalkResult

Sources