class innerbbop-rest-response~
Source: response.
new response(in_data)
Contructor for a REST query response object.
The constructor argument is an object, not a string.
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
in_data |
String |
|
the string returned from a request |
- Returns
-
Objectrest response object
Methods
message([message]) → String
A message that the response wants to let you know about its creation.
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
message |
String |
Yes |
setter for message |
- Returns
-
Stringmessage string
message_type([message_type]) → String
A message about the message (a string classifier) that the response wants to let you know about its message.
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
message_type |
String |
Yes |
setter for message_type |
- Returns
-
Stringmessage type string
okay([okay_p]) → Boolean
Simple return verification of sane response from server.
This okay() caches its return value, so harder probes don't need to be performed more than once.
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
okay_p |
Boolean |
Yes |
setter for okay |
- Returns
-
Boolean
raw() → Object
Returns the initial response object, whatever it was.
- Returns
-
Objectobject