FMPWeb

interface FMPWeb : FMPObject

Представляет HTTP запросы к WEB ресурсу.

Since

21.04.01

Samples

import ru.fsight.fmp.*
fun main() { 
   //sampleStart 
   /*
 * Пример создания вэб-ресурса.
 */
val web: FMPWeb = fmp.web.resource(resource) // Указать используемый ресурс.
	.build() // Получить FMPWeb. 
   //sampleEnd
}
import ru.fsight.fmp.*
fun main() { 
   //sampleStart 
   /*
 * Пример выполнения запроса.
 */
val response: FMPWeb.Response = web.request().result
val data: ByteArray = response.data // Данные, которые вернул ресурс. 
   //sampleEnd
}

Types

Link copied to clipboard

Требуемые параметры: resource.

Link copied to clipboard

Доступные HTTP методы.

Link copied to clipboard
data class Request(val url: String = "", val method: FMPWeb.Method = Method.GET, val data: ByteArray = byteArrayOf(), val headers: Map<String, String> = mapOf())

Ответ HTTP запроса.

Link copied to clipboard
data class Response(val request: FMPWeb.Request = Request(), val status: Int = -1, val data: ByteArray = byteArrayOf(), val headers: Map<String, String> = mapOf(), val exception: FMPException? = null, val error: String = exception?.message.orEmpty())

Properties

Link copied to clipboard
abstract val data: ByteArray

Данные для передачи в запросе.

Link copied to clipboard
abstract val headers: Map<String, String>

HTTP заголовки запроса.

Link copied to clipboard
abstract val method: FMPWeb.Method

Указанный HTTP метод.

Link copied to clipboard
abstract val path: String

Путь внутри ресурса.

Link copied to clipboard
abstract val resource: FMPResource

Указанный ресурс для запроса.

Functions

Link copied to clipboard
abstract operator override fun equals(other: Any?): Boolean

Сравнить объекты между собой.

Link copied to clipboard
abstract override fun hashCode(): Int

Хэш-код объектов. В отличие от equals он будет одинаков для объектов с одинаковыми ключевыми параметрами, но созданными от разных объектов FMP.

Link copied to clipboard
abstract override fun rebuild(): FMPWeb.Builder
Link copied to clipboard

Выполнить запрос.

Link copied to clipboard
abstract override fun toString(): String

Получить ключевые параметры объекта в виде строки.