Siminov Hybrid Siminov Hybrid

  • API Docs for Version: 2.0

    • APIs

    Show:

    ServiceDescriptor.Request.HeaderParameter Class

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

    It exposes methods to Get and Set request header parameter details as per defined in ServiceDescriptor.xml file by the application.

    <request>
                        
                            <!-- 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>    
                            
                        </request>

    Methods

    addProperty

    (
    • name
    • value
    )

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

    Add Property in property pool.

    Parameters:

    • name String

      Name of Property.

    • value String

      value of Property.

    containProperty

    (
    • name
    )
    Boolean

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

    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.

    getName

    () String

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

    Get name of header parameter

    Returns:

    String:

    Name of Header Parameter

    getProperties

    () Array

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

    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:870

    Get Property based on name provided.

    Parameters:

    • name String

      Name of Property.

    Returns:

    String:

    Property value.

    getValue

    () String

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

    Get value of header parameter

    Returns:

    String:

    Value of Header Parameter

    removeProperty

    (
    • name
    )

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

    Remove Property from property pool.

    Parameters:

    • name String

      Name of Property.

    setName

    (
    • val
    )

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

    Set name of header parameter

    Parameters:

    • val String

      Name of Header Parameter

    setValue

    (
    • val
    )

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

    Set value of header parameter

    Parameters:

    • val String

      Value of Header Parameter