Siminov Hybrid Siminov Hybrid

  • API Docs for Version: 2.0

    • APIs

    Show:

    ServiceDescriptor.Request Class

    Defined in: /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/ServiceDescriptor.js:356
    Module: Model

    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>

    Methods

    addHeaderParameter

    (
    • headerParameters
    )

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/ServiceDescriptor.js:640

    Add header parameter

    Parameters:

    addProperty

    (
    • name
    • value
    )

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/ServiceDescriptor.js:588

    Add Property in property pool.

    Parameters:

    • name String

      Name of Property.

    • value String

      value of Property.

    addQueryParameter

    (
    • queryParameter
    )

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/ServiceDescriptor.js:620

    Add query parameter

    Parameters:

    containProperty

    (
    • name
    )
    Boolean

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/ServiceDescriptor.js:576

    Check whether Property exist or not.

    Parameters:

    • name String

      Name of Property.

    Returns:

    Boolean:

    true/false, TRUE if property exist, FALSE if property does not exist.

    getDataStream

    () String

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/ServiceDescriptor.js:532

    Get data stream

    Returns:

    String:

    Data Stream

    getHandler

    () String

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/ServiceDescriptor.js:492

    Get handler of request

    Returns:

    String:

    Handler

    getHeaderParameters

    () Array

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/ServiceDescriptor.js:630

    Get all header parameters

    Returns:

    Array:

    Header Parameters

    getName

    () String

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/ServiceDescriptor.js:432

    Get request name

    Returns:

    String:

    Name of request

    getProperties

    () Array

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/ServiceDescriptor.js:553

    Get all Properties defined in descriptor.

    Returns:

    Array:

    All Property Values.

    getProperty

    (
    • name
    )
    String

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/ServiceDescriptor.js:564

    Get Property based on name provided.

    Parameters:

    • name String

      Name of Property.

    Returns:

    String:

    Property value.

    getQueryParameters

    () Array

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/ServiceDescriptor.js:610

    Get all query parameters

    Returns:

    Array:

    Query Parameters

    getType

    () String

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/ServiceDescriptor.js:452

    Get type of request

    Returns:

    String:

    Get request type

    removeProperty

    (
    • name
    )

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/ServiceDescriptor.js:600

    Remove Property from property pool.

    Parameters:

    • name String

      Name of Property.

    setApi

    (
    • api
    )

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/ServiceDescriptor.js:482

    Set request api

    Parameters:

    setDataStream

    (
    • val
    )

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/ServiceDescriptor.js:542

    Set data stream

    Parameters:

    setHandler

    (
    • handler
    )

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/ServiceDescriptor.js:502

    Set handler of request

    Parameters:

    setMode

    (
    • mode
    )

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/ServiceDescriptor.js:522

    Set mode of request

    Parameters:

    setName

    (
    • name
    )

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/ServiceDescriptor.js:442

    Set request name

    Parameters:

    setType

    (
    • type
    )

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/ServiceDescriptor.js:462

    Set type of request

    Parameters: