ServiceDescriptor.Request Class
Defined in:
Module: Model
/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/ServiceDescriptor.js:356
It exposes methods to Get and Set service request details as per defined in ServiceDescriptor.xml file by the application.
<request>
<!-- General Request Properties -->
<!-- Mandatory Field -->
<property name="name">name_of_request</property>
<!-- Mandatory Field -->
<property name="type">GET|HEAD|POST|PUT|DELETE|TRACE|OPTIONS|CONNECT|PATCH</property>
<!-- Mandatory Field -->
<property name="api">full_request_path</property>
<!-- Mandatory Field -->
<property name="handler">handler_of_request</property>
<!-- Optional Field (DEFAULT: SYNC)-->
<property name="mode">SYNC|ASYNC</property>
<!-- Query Parameters -->
<!-- Query Parameter -->
<query-parameters>
<query-parameter>
<!-- Mandatory Field -->
<property name="name">name_of_query_parameter</property>
<!-- Mandatory Field -->
<property name="value">value_of_query_parameter</property>
</query-parameter>
</query-parameters>
<!-- Header Parameters -->
<!-- Header Parameter -->
<header-parameters>
<header-parameter>
<!-- Mandatory Field -->
<property name="name">name_of_header_parameter</property>
<!-- Mandatory Field -->
<property name="value">value_of_header_parameter</property>
</header-parameter>
</header-parameters>
<!-- Stream of Data Under Request Body -->
<!-- It is Optional Property -->
<data-stream>stream_of_data</data-stream>
</request>
Item Index
Methods
addHeaderParameter
(
-
headerParameters
Add header parameter
Parameters:
-
headerParameters
ServiceDescriptor.Request.HeaderParameter
addProperty
(
-
name
-
value
Add Property in property pool.
addQueryParameter
(
-
queryParameter
Add query parameter
Parameters:
-
queryParameter
ServiceDescriptor.Request.QueryParameter
containProperty
(
Boolean
-
name
Check whether Property exist or not.
Parameters:
-
name
StringName of Property.
Returns:
Boolean:
true/false, TRUE if property exist, FALSE if property does not exist.
getProperties
()
Array
Get all Properties defined in descriptor.
Returns:
Array:
All Property Values.
getProperty
(
String
-
name
Get Property based on name provided.
Parameters:
-
name
StringName of Property.
Returns:
String:
Property value.
removeProperty
(
-
name
Remove Property from property pool.
Parameters:
-
name
StringName of Property.