Siminov Hybrid Siminov Hybrid

  • API Docs for Version: 2.0

    • APIs

    Show:

    ServiceDescriptor.Request.QueryParameter Class

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

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

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

    Methods

    addProperty

    (
    • name
    • value
    )

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

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

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

    Get name of query parameter

    Returns:

    String:

    Name of Query Parameter

    getProperties

    () Array

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

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

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

    Get value of query parameter

    Returns:

    String:

    Value of Query Parameter

    removeProperty

    (
    • name
    )

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

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

    Set name of query parameter

    Parameters:

    • val String

      Name of query parameter

    setValue

    (
    • val
    )

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

    Set value of query parameter

    Parameters:

    • val String

      Value of Query Parameter