Siminov Hybrid Siminov Hybrid

  • API Docs for Version: 2.0

    • APIs

    Show:

    SyncDescriptor Class

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

    Exposes methods to GET and SET Sync Descriptor information as per define in SyncDescriptor.xml file by application.

    Example:
                            
                            <sync-descriptor>
                                        
                                    <!-- Mandatory Field -->
                                <property name="name">name_of_sync_handler</property>
                                        
                                    <!-- Optional Field -->
                                <property name="sync_interval">sync_interval_in_millisecond</property>
                                                
                                    <!-- Optional Field -->
                                        <!-- Default: SCREEN -->
                                <property name="type">INTERVAL|SCREEN|INTERVAL-SCREEN</property>
                                        
                                <!-- Services -->
                                    <!-- Service -->
                                <services>
                                            
                                    <service>name_of_service.name_of_api</service>
                                            
                                </services>
                            
                            </sync-descriptor>

    Methods

    addProperty

    (
    • name
    • value
    )

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/SyncDescriptor.js:162

    Add Property in property pool.

    Parameters:

    • name String

      Name of Property.

    • value String

      value of Property.

    addService

    (
    • service
    )

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/SyncDescriptor.js:194

    Add service

    Parameters:

    • service String

      Name of Service

    containProperty

    (
    • name
    )
    Boolean

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/SyncDescriptor.js:150

    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/SyncDescriptor.js:86

    Get name of sync descriptor

    Returns:

    String:

    Name of sync descriptor

    getProperties

    () Array

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/SyncDescriptor.js:127

    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/SyncDescriptor.js:138

    Get Property based on name provided.

    Parameters:

    • name String

      Name of Property.

    Returns:

    String:

    Property value.

    getServices

    () Array

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/SyncDescriptor.js:184

    Get all service descriptor names

    Returns:

    Array:

    Name of Services

    getSyncInterval

    () String

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/SyncDescriptor.js:106

    Get sync interval

    Returns:

    String:

    Sync Interval

    removeProperty

    (
    • name
    )

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/SyncDescriptor.js:174

    Remove Property from property pool.

    Parameters:

    • name String

      Name of Property.

    setName

    (
    • name
    )

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/SyncDescriptor.js:96

    Set name of sync descriptor

    Parameters:

    • name String

      Name of sync descriptor

    setSyncInterval

    (
    • syncInterval
    )

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/SyncDescriptor.js:116

    Set sync interval

    Parameters:

    • syncInterval String

      Sync Interval