WklHttpRequest
WklHttpRequest class
Signature
Dim myWklHttpRequest As WklHttpRequest
Summary
One web request of a queue.
Parameters
None
Remarks
Not created directly; returned by other members of the library.
| Member | Kind | Summary |
|---|---|---|
| `Id` | Property | Gets the number of the request. |
| `Method` | Property | Gets or sets the method. |
| `Url` | Property | Gets or sets the address. |
| `Body` | Property | Gets or sets the body. |
| `ContentType` | Property | Gets or sets the Content-Type of the body. |
| `Header` | Property | Gets or sets an own header of this request. |
| `IdempotencyKey` | Property | Gets or sets the value sent as Idempotency-Key. |
| `Tag` | Property | Gets or sets any value passed unchanged to every event of the request. |
| `State` | Property | Gets the state. |
| `Cancel` | Method | Cancels the request. |
Code example
None
Inheritance
None
Id property
Signature
Property Get Id() As Long
Summary
Gets the number of the request.
Parameters
None
Property value: Long – Unique in its task.
Remarks
Default member: it can be left out, as in myWklHttpRequest(...) for myWklHttpRequest.Id(...). Read-only.
Code example
None
Inheritance
Declared by WklHttpRequest.
Method property
Signature
Property Get Method() As String Property Let Method(RHS As String)
Summary
Gets or sets the method.
Parameters
None
Property value: String – GET, POST …
Remarks
Can be changed until the request is sent.
Read/write.
Code example
None
Inheritance
Declared by WklHttpRequest.
Url property
Signature
Property Get Url() As String Property Let Url(RHS As String)
Summary
Gets or sets the address.
Parameters
None
Property value: String – The address.
Remarks
Can be changed until the request is sent.
Read/write.
Code example
None
Inheritance
Declared by WklHttpRequest.
Body property
Signature
Property Get Body() As String Property Let Body(RHS As String)
Summary
Gets or sets the body.
Parameters
None
Property value: String – The body text.
Remarks
Sent as UTF-8; can be changed until the request is sent.
Read/write.
Code example
None
Inheritance
Declared by WklHttpRequest.
ContentType property
Signature
Property Get ContentType() As String Property Let ContentType(RHS As String)
Summary
Gets or sets the Content-Type of the body.
Parameters
None
Property value: String – Default application/json; charset=utf-8.
Remarks
Read/write.
Code example
None
Inheritance
Declared by WklHttpRequest.
Header property
Signature
Property Get Header(ByVal Name As String) As String Property Let Header(ByVal Name As String, RHS As String)
Summary
Gets or sets an own header of this request.
Parameters
| Name | Type | Optional | Default | Description |
|---|---|---|---|---|
Name | String | No | – | The header name. |
Property value: String – The value; empty removes it.
Remarks
Overrides a shared header of the same name. Can be changed until the request is sent.
Read/write.
Code example
None
Inheritance
Declared by WklHttpRequest.
IdempotencyKey property
Signature
Property Get IdempotencyKey() As String Property Let IdempotencyKey(RHS As String)
Summary
Gets or sets the value sent as Idempotency-Key.
Parameters
None
Property value: String – A new GUID by default; empty sends none.
Remarks
The same for every repetition, so the service can recognize a request it already did.
Read/write.
Code example
None
Inheritance
Declared by WklHttpRequest.
Tag property
Signature
Property Get Tag() As Variant Property Let Tag(RHS As Variant)
Summary
Gets or sets any value passed unchanged to every event of the request.
Parameters
None
Property value: Variant – Any value, for example the key of a row.
Remarks
Read/write.
Code example
None
Inheritance
Declared by WklHttpRequest.
State property
Signature
Property Get State() As WklHttpRequestState
Summary
Gets the state.
Parameters
None
Property value: `WklHttpRequestState` – wrsWaiting, wrsSending, wrsCompleted, wrsFailed or wrsCancelled.
Remarks
Read-only.
Code example
None
Inheritance
Declared by WklHttpRequest.
Cancel method
Signature
Sub Cancel()
Summary
Cancels the request.
Parameters
None
Remarks
Not yet sent: taken out of the queue. On the way: its connection is closed; its outcome at the service is unknown. Never sent again.
Code example
None
Inheritance
Declared by WklHttpRequest.