Entries

Link copied to clipboard

The GET method requests a representation of the specified resource. Requests using GET should only retrieve data and should have no other effect.

Link copied to clipboard

The POST method submits an entity to the specified resource, often causing a change in state or side effects on the server.

Link copied to clipboard

The PUT method replaces all current representations of the target resource with the request payload.

Link copied to clipboard

The DELETE method deletes the specified resource.

Link copied to clipboard

The PATCH method partially modifies the specified resource.

Link copied to clipboard

The HEAD method asks for a response identical to a GET request, but without the response body. Useful for retrieving meta-information.

Link copied to clipboard

The OPTIONS method describes the communication options for the target resource.

Link copied to clipboard

The TRACE method performs a message loop-back test along the path to the target resource.

Types

Link copied to clipboard
object Companion

The companion object provides utility methods for working with HttpMethod enum values.

Properties

Link copied to clipboard

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Link copied to clipboard

Indicates whether this HTTP method is idempotent. Idempotent methods can be called multiple times without different outcomes.

Link copied to clipboard

Indicates whether this HTTP method is considered safe. Safe methods should not change the state of the server.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val requiresBody: Boolean = false

Indicates whether the HTTP method typically requires a request body or data.

Functions

Link copied to clipboard

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Link copied to clipboard

Returns an array containing the constants of this enum type, in the order they're declared.