Configuring Application Descriptor
Application Descriptor is the one who connects application to Siminov framework. It provide basic information about application, which defines the behaviour of application.
<!-- Design Of ApplicationDescriptor.xml -->
<siminov>
<!-- General Application Description Properties -->
<!-- Mandatory Field -->
<property name="name">application_name</property>
<!-- Optional Field -->
<property name="description">application_description</property>
<!-- Mandatory Field (Default is 0.0) -->
<property name="version">application_version</property>
<!-- Database Descriptors Used By Application (zero-to-many) -->
<!-- Optional Field's -->
<database-descriptors>
<database-descriptor>full_path_of_database_descriptor_file</database-descriptor>
</database-descriptors>
<!-- Services -->
<service-descriptors>
<!-- Service -->
<service-descriptor>full_path_of_service</service-descriptor>
</service-descriptors>
<!-- Sync Handlers -->
<!-- Sync Handler -->
<sync-descriptors>
<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</property>
<!-- Services -->
<!-- Service -->
<services>
<service>name_of_service.name_of_api</service>
</services>
</sync-descriptor>
</sync-descriptors>
<!-- Push Notification -->
<notification-descriptor>
<!-- Optional Field -->
<property name="name_of_property">value_of_property</property>
</notification-descriptor>
<!-- Adapter Descriptors Used By Hybrid Application (zero-to-many) -->
<!-- Optional Field's -->
<adapter-descriptors>
<!-- Adapter Paths -->
<adapter-descriptor>adapter_path</adapter-descriptor>
</adapter-descriptors>
<!-- Library Descriptors Used By Application (zero-to-many) -->
<!-- Optional Field's -->
<library-descriptors>
<library-descriptor>full_path_of_library_descriptor_file</library-descriptor>
</library-descriptors>
<!-- Event Handlers Implemented By Application (zero-to-many) -->
<!-- Optional Field's -->
<event-handlers>
<event-handler>full_java_class_path_of_event_handler/javascript_class_path_of_event_handler (ISiminovHandler/IDatabaseHandler)</event-handler>
</event-handlers>
</siminov>
<!-- Android Sample: Application Descriptor -->
<siminov>
<property name="name">SIMINOV HYBRID PHONEGAP SAMPLE</property>
<property name="description">Siminov Hybrid Phonegap Sample Application</property>
<property name="version">0.9</property>
<!-- Database Descriptors -->
<database-descriptors>
<database-descriptor>DatabaseDescriptor.xml</database-descriptor>
</database-descriptors>
<!-- Service Descriptors -->
<service-descriptors>
<service-descriptor>Book-Services/Books.xml</service-descriptor>
<service-descriptor>Book-Services/Lessions.xml</service-descriptor>
<service-descriptor>Book-Services/NotificationService.xml</service-descriptor>
</service-descriptors>
<!-- Sync Descriptors -->
<syn-descriptors>
<sync-descriptor>Book-Sync/Books.xml</sync-descriptor>
<sync-descriptor>Book-Sync/Lessions.xml</sync-descriptor>
</syn-descriptors>
<!-- Notification Descriptor -->
<notification-descriptor>
<property name="sender_id">853402201726</property>
</notification-descriptor>
<!-- Event Handlers -->
<event-handlers>
<event-handler>siminov.hybrid.phonegap.sample.events.SiminovEventHandler</event-handler>
<event-handler>siminov.hybrid.phonegap.sample.events.DatabaseEventHandler</event-handler>
<event-handler>siminov.hybrid.phonegap.sample.events.NotificationEventHandler</event-handler>
<event-handler>siminov.hybrid.phonegap.sample.events.SyncEventHandler</event-handler>
</event-handlers>
<!-- Library Descriptors -->
<library-descriptors>
<library-descriptor>siminov.hybrid.phonegap.library.sample.resources</library-descriptor>
</library-descriptors>
</siminov>
<!-- iOS Sample: Application Descriptor -->
<siminov>
<property name="name">SIMINOV HYBRID PHONEGAP SAMPLE</property>
<property name="description">Siminov Hybrid Phonegap Sample Application</property>
<property name="version">0.9</property>
<!-- Database Descriptors -->
<database-descriptors>
<database-descriptor>DatabaseDescriptor.xml</database-descriptor>
</database-descriptors>
<!-- Service Descriptors -->
<service-descriptors>
<service-descriptor>Book-Services/Books.xml</service-descriptor>
<service-descriptor>Book-Services/Lessions.xml</service-descriptor>
<service-descriptor>Book-Services/NotificationService.xml</service-descriptor>
</service-descriptors>
<!-- Sync Descriptors -->
<syn-descriptors>
<sync-descriptor>Book-Sync/Books.xml</sync-descriptor>
<sync-descriptor>Book-Sync/Lessions.xml</sync-descriptor>
</syn-descriptors>
<!-- Notification Descriptor -->
<notification-descriptor>
<property name="sender_id">853402201726</property>
</notification-descriptor>
<!-- Event Handlers -->
<event-handlers>
<event-handler>SiminovEventHandler</event-handler>
<event-handler>DatabaseEventHandler</event-handler>
<event-handler>NotificationEventHandler</event-handler>
<event-handler>SyncEventHandler</event-handler>
</event-handlers>
<!-- Library Descriptors -->
<library-descriptors>
<library-descriptor>Siminov.Hybrid.Phonegap.Library.Sample.Resources</library-descriptor>
</library-descriptors>
</siminov>
Note: Application Developer can provide their own properties also, and by using following API's they can use properties.
Get Properties - [Android:getProperties | iOS:getProperties | Windows:GetProperties | JavaScript:getProperties]: It will return all properties associated with Application Descriptor.
Get Property - [Android:getProperty(Name-of-Property) | iOS:getProperty:Name-of-Property | Windows:GetProperty(Name-of-Property) | JavaScript:getProperty(Name-of-Property)]: It will return property value associated with property name provided.
Contains Property - [Android:containsProperty(Name-of-Property) | iOS:containsProperty:Name-of-Property | Windows:ContainsProperty(Name-of-Property) | JavaScript:containsProperty(Name-of-Property)]: It will return TRUE/FALSE whether property exists or not.
Add Property - [Android:addProperty(Name-of-Property, Value-of-Property) | iOS:addProperty:Name-of-Property value:Value-of-Property | Windows:AddProperty(Name-of-Property, Value-of-Property) | JavaScript:addProperty(Name-of-Property, Value-of-Property)]: It will add new property to the collection of Application Descriptor properties.
Remove Property - [Android:removeProperty(Name-of-Property) | iOS:removeProperty:Name-of-Property | Windows:RemoveProperty(Name-of-Property) | JavaScript:removeProperty(Name-of-Property)]: It will remove property from Application Descriptor properties based on name provided.
- name*: Name of application. It is mandatory field. If any resources is created by Siminov Framework then it will be under this folder name.
Android Sample: Application data folder based on name defined
![Application Data Folder Based On Name Defined] (https://raw.github.com/Siminov/hybrid/docs/github/v2.0/app_storage_structure.android.png "Application Data Folder Based On Name Defined")
iOS Sample: Application data folder based on name defined
![Application data folder based on name defined] (https://raw.github.com/Siminov/hybrid/docs/github/v2.0/app_storage_structure.ios.png "Application data folder based on name defined")
-
descriptor: Description of application. It is optional field.
-
version: Version of application. It is mandatory field. Default is 0.0.
- Path of all database descriptor's used in application.
- Every database descriptor will have its own database object.
- Path of all service descriptor's used in application.
- Path of all sync descriptor's used in application.
- All properties needed to support push notification.
- Path of all adapter descriptor's used in application.
-
Siminov Framework provides two type of event handlers
-
Android: ISiminovEvents | iOS:SICISiminovEvents | Windows:ISiminovEvents | JavaScript:ISiminovEvents: It contains events associated with life cycle of Siminov Framework. such as On Siminov Initialized, On First Time Siminov Initialized, On Siminov Stopped.
-
Android:IDatabaseEvents | iOS:SICIDatabaseEvents | Windows:IDatabaseEvents | JavaScript:IDatabaseEvents: It contains events associated with database operations. such as On Database Created, On Database Dropped, On Table Created, On Table Dropped, On Index Created, On Index Dropped.
-
Android:ISyncEvents | iOS:SIKISyncEvents | Windows:ISyncEvents | JavaScript:ISyncEvents: It contain events associated with sync operations. such as On Sync Start, On Sync Queued, On Sync Finished, On Sync Terminated.
-
Android:INotificationEvents | iOS:SIKINotificationEvents | Windows:INotificationEvents | JavaScript:INotificationEvents: It contain events associated with notification. such as On Notification Registered, On Notification Unregistered, On Notification Message, On Notification Error.
-
Application can implement these event handlers based on there requirement.
Note
Event Handler: It can be define in both Native and Hybrid.
Native Event Handler: If you want to handle Event in Native then define Event Handler using Android - Java, iOS - Objective C, Windows - C#. Specify full class path and name in ApplicationDescriptor.xml.
Hybrid Event Handler: If you want to handle Event in Hybrid then define Event Handler using JavaScript. Specify only JavaScript Function name in ApplicationDescriptor.xml.
Both (Native/Hybrid) Event Handler: If you want to handle Event in both Native and Hybrid then define Event Handler in both Native and JavaScript. Specify full class path and name in ApplicationDescriptor.xml, no need to define for JavaScript because Siminov will automatically assume same name for it.
Note
Provide full package name under which LibraryDescriptor.xml file is placed.
Siminov framework will automatically read LibraryDescriptor.xml file defined under package name provided.
Note
Application descriptor name should always be same as ApplicationDescriptor.xml only.
It should always be in root folder of application assets.
![Android Sample: Application Descriptor] (https://raw.github.com/Siminov/hybrid/docs/github/v2.0/application_descriptor_path.android.png "Android Sample: Application Descriptor")
![iOS Sample: Application Descriptor] (https://raw.github.com/Siminov/hybrid/docs/github/v2.0/application_descriptor_path.ios.png "iOS Sample: Application Descriptor")
