IBM Worklight V6.0.

0
Getting Started

Windows Phone 8 Adding native functionality to Hybrid

application with Apache Cordova plug-in

12 July 2013

Copyright International Business Machines Corporation 2011, 2013. All rights reserved.
US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

Trademarks
IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of
International Business Machines Corporation, registered in many jurisdictions
worldwide. Worklight is a trademark or registered trademark of Worklight, an IBM
Company. Other product and service names might be trademarks of IBM or other
companies. A current list of IBM trademarks is available on the Web at Copyright and
trademark information at www.ibm.com/legal/copytrade.shtml.
Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft
Corporation in the United States, other countries, or both.
Java and all Java-based trademarks and logos are trademarks or registered
trademarks of Oracle and/or its affiliates.
Other company products or service names may be trademarks or service marks of
others.
This document may not be reproduced in whole or in part without the prior written
permission of IBM.

About IBM
See http://www.ibm.com/ibm/us/en/

Copyright International Business Machines Corporation 2011, 2013. All rights reserved.

Agenda
Apache Cordova plug-in overview
Implementing the plug-in by using C# code
Adding the plug-in to DOM
Invoking the plug-in from JavaScript
Configuring the Worklight project

Copyright International Business Machines Corporation 2011, 2013. All rights reserved.

Apache Cordova plug-in overview

Within an IBM Worklight application, developers occasionally have
to use a specific third-party native library or a device function that is
not yet available in Apache Cordova.
Apache Cordova allows developers to create custom native code
blocks and to invoke them from JavaScript.
This technique is called an Apache Cordova plug-in.
In this module, you see how to create a simple Windows Phone 8
Apache Cordova plug-in and how to use it in your code.
More samples can be found in the Apache Cordova documentation
at https://github.com/phonegap/phonegap-plugins.

Copyright International Business Machines Corporation 2011, 2013. All rights reserved.

Apache Cordova plug-in overview

An Apache Cordova plug-in consists of two parts:
A C# code that runs natively within the Windows Phone OS
A JavaScript wrapper
When both parts are implemented, developers are able to call a
native code from JavaScript in a simple and familiar way.

C#
Native
code

cordova.exec() API

callback

Your JavaScript
function

Your JavaScript
callback

Copyright International Business Machines Corporation 2011, 2013. All rights reserved.

Agenda
Apache Cordova plug-in overview
Implementing the plug-in by using C# code
Adding plug-in to DOM
Invoking plug-in from JavaScript
Configuring the Worklight project

Copyright International Business Machines Corporation 2011, 2013. All rights reserved.

Implementing the plug-in by using C# code (1 of 4)

Start by creating a C# class for the plug-in.
Call it HelloWorldPlugin.cs.

Add the new class to your project namespace

and add required imports.

Copyright International Business Machines Corporation 2011, 2013. All rights reserved.

Implementing the plug-in by using C# code (2 of 4)

Implement the HelloWorldPlugin class and the sayHello method.

Copyright International Business Machines Corporation 2011, 2013. All rights reserved.

Implementing the plug-in by using C# code (3 of 4)

Implement the HelloWorldPlugin class and the sayHello method.
The JavaScript wrapper calls the
sayHello method and pass a single
parameter. It returns a string back to
JavaScript.

Copyright International Business Machines Corporation 2011, 2013. All rights reserved.

Implementing the plug-in by using C# code (4 of 4)

Implement the HelloWorldPlugin class and the sayHello method.
The DispatchCommandResult is
responsible for returning the result back
to JavaScript whether it is success or
failure.

10

Copyright International Business Machines Corporation 2011, 2013. All rights reserved.

Agenda
Apache Cordova plug-in overview
Implementing the plug-in by using C# code
Adding the plug-in to DOM
Invoking the plug-in from JavaScript
Configuring the Worklight project

11

Copyright International Business Machines Corporation 2011, 2013. All rights reserved.

Adding the plug-in to DOM (1 of 5)

The second step of the plug-in implementation is to declare it in the
DOM and then to create a wrapper for it.

* Notice that in the cordova.exec command the plugin class name must include its namespace.

12

Copyright International Business Machines Corporation 2011, 2013. All rights reserved.

Adding the plug-in to DOM (2 of 5)

The second step of the plug-in implementation is to declare it in the
DOM and then to create a wrapper for it.

First, create an empty function that

serves as a wrapper for the plug-in.

13

Copyright International Business Machines Corporation 2011, 2013. All rights reserved.

Adding the plug-in to DOM (3 of 5)

The second step of the plug-in implementation is to declare it in the
DOM and then to create a wrapper for it.

Create a sayHello function

by using the HelloWorldPlugin prototype
and the hardcoded plug-in class name
and action. It invokes the plug-in
by using cordova.exec().

14

Copyright International Business Machines Corporation 2011, 2013. All rights reserved.

Adding the plug-in to DOM (4 of 5)

The second step of the plug-in implementation is to declare it in the
DOM and then to create a wrapper for it.

Success callback
Failure callback
Plugin Class name
Plugin method name
Parameters array

15

Copyright International Business Machines Corporation 2011, 2013. All rights reserved.

Adding the plug-in to DOM (5 of 5)

The second step of the plug-in implementation is to declare it in the
DOM and then to create a wrapper for it.

The final step is to add a helloWorldPlugin

property to the DOM window.plugins object.
You can now invoke your plug-in by using
window.plugins.helloWorldPlugin.sayHello().

16

Copyright International Business Machines Corporation 2011, 2013. All rights reserved.

Agenda
Apache Cordova plug-in overview
Implementing the plug-in by using C# code
Adding the plug-in to DOM
Invoking the plug-in from JavaScript
Configuring the Worklight project

17

Copyright International Business Machines Corporation 2011, 2013. All rights reserved.

Invoking the plug-in from JavaScript (1 of 2)

Now you are ready to invoke your plug-in from JavaScript.

Success
and callback
Failure callbacks
Success
and failure

18

Copyright International Business Machines Corporation 2011, 2013. All rights reserved.

Invoking the plug-in from JavaScript (2 of 2)

The sample for this training module can be found in the Getting Started page
of the IBM Worklight documentation website at
http://www.ibm.com/mobile-docs

19

Copyright International Business Machines Corporation 2011, 2013. All rights reserved.

Agenda
Apache Cordova plug-in overview
Implementing the plug-in by using C# code
Adding the plug-in to DOM
Invoking the plug-in from JavaScript
Configuring the Worklight project

20

Copyright International Business Machines Corporation 2011, 2013. All rights reserved.

Configuring the Worklight project

For the plug-in to actually work in the application, a few more steps
are required:
The plug-in must be placed the native folder.
The config.xml file that is located in the native folder must declare
the plug-in under the User section:

21

Copyright International Business Machines Corporation 2011, 2013. All rights reserved.

Notices

Permission for the use of these publications is granted subject to these terms and conditions.

This information was developed for products and services offered in the U.S.A.

IBM may not offer the products, services, or features discussed in this document in other countries.
Consult your local IBM representative for information on the products and services currently available in
your area. Any reference to an IBM product, program, or service is not intended to state or imply that only
that IBM product, program, or service may be used. Any functionally equivalent product, program, or
service that does not infringe any IBM intellectual property right may be used instead. However, it is the
user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter described in this document.
The furnishing of this document does not grant you any license to these patents. You can send license
inquiries, in writing, to:

22

Intellectual Property Licensing

Legal and Intellectual Property Law
IBM Japan Ltd.
1623-14, Shimotsuruma, Yamato-shi
Kanagawa 242-8502 Japan

The following paragraph does not apply to the United Kingdom or any other country where such
provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION
PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR
IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT,
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer
of express or implied warranties in certain transactions, therefore, this statement may not apply to you.

This information could include technical inaccuracies or typographical errors. Changes are periodically
made to the information herein; these changes will be incorporated in new editions of the publication. IBM
may make improvements and/or changes in the product(s) and/or the program(s) described in this
publication at any time without notice.

Any references in this information to non-IBM Web sites are provided for convenience only and do not in
any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of
the materials for this IBM product and use of those Web sites is at your own risk.

IBM may use or distribute any of the information you supply in any way it believes appropriate without
incurring any obligation to you.

Licensees of this program who wish to have information about it for the purpose of enabling: (i) the
exchange of information between independently created programs and other programs (including this one)
and (ii) the mutual use of the information which has been exchanged, should contact:

Such information may be available, subject to appropriate terms and conditions, including in some cases,
payment of a fee.
The licensed program described in this document and all licensed material available for it are provided by
IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any
equivalent agreement between us.

Information concerning non-IBM products was obtained from the suppliers of those products, their
published announcements or other publicly available sources. IBM has not tested those products and
cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products.
Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products.

COPYRIGHT LICENSE:

This information contains sample application programs in source language, which illustrate programming
techniques on various operating platforms. You may copy, modify, and distribute these sample programs
in any form without payment to IBM, for the purposes of developing, using, marketing or distributing
application programs conforming to the application programming interface for the operating platform for
which the sample programs are written. These examples have not been thoroughly tested under all
conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these
programs.

Each copy or any portion of these sample programs or any derivative work, must include a copyright notice
as follows:

IBM Director of Licensing

IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
U.S.A.

For license inquiries regarding double-byte character set (DBCS) information, contact the IBM Intellectual
Property Department in your country or send inquiries, in writing, to:

(your company name) (year). Portions of this code are derived from IBM Corp. Sample Programs.
Copyright IBM Corp. _enter the year or years_. All rights reserved.

Privacy Policy Considerations

IBM Software products, including software as a service solutions, (Software Offerings) may use cookies
or other technologies to collect product usage information, to help improve the end user experience, to
tailor interactions with the end user or for other purposes. In many cases no personally identifiable
information is collected by the Software Offerings. Some of our Software Offerings can help enable you to
collect personally identifiable information. If this Software Offering uses cookies to collect personally
identifiable information, specific information about this offerings use of cookies is set forth below.

Depending upon the configurations deployed, this Software Offering may use session cookies that collect
session information (generated by the application server). These cookies contain no personally identifiable
information and are required for session management. Additionally, persistent cookies may be randomly
generated to recognize and manage anonymous users. These cookies also contain no personally
identifiable information and are required.

If the configurations deployed for this Software Offering provide you as customer the ability to collect
personally identifiable information from end users via cookies and other technologies, you should seek
your own legal advice about any laws applicable to such data collection, including any requirements for
notice and consent. For more information about the use of various technologies, including cookies, for
these purposes, see IBMs Privacy Policy at http://www.ibm.com/privacy and IBMs Online Privacy
Statement at http://www.ibm.com/privacy/details the sections entitled Cookies, Web Beacons and Other
Technologies and the IBM Software Products and Software-as-a-Service Privacy Statement at
http://www.ibm.com/software/info/product-privacy.

IBM Corporation
Dept F6, Bldg 1
294 Route 100
Somers NY 10589-3216
USA

Copyright International Business Machines Corporation 2011, 2013. All rights reserved.

Support and comments

For the entire IBM Worklight documentation set, training material and online forums where you can post questions, see the IBM website at:
http://www.ibm.com/mobile-docs

Support
Software Subscription and Support (also referred to as Software Maintenance) is included with licenses purchased through Passport
Advantage and Passport Advantage Express. For additional information about the International Passport Advantage Agreement and the
IBM International Passport Advantage Express Agreement, visit the Passport Advantage website at:

http://www.ibm.com/support/handbook

Comments
We appreciate your comments about this publication. Please comment on specific errors or omissions, accuracy, organization, subject
matter, or completeness of this document. The comments you send should pertain to only the information in this manual or product and
the way in which the information is presented.
For technical questions and information about products and prices, please contact your IBM branch office, your IBM business partner,
or your authorized remarketer.
When you send comments to IBM, you grant IBM a nonexclusive right to use or distribute your comments in any way it believes
appropriate without incurring any obligation to you. IBM or any other organizations will only use the personal information that you supply
to contact you about the issues that you state.
Thank you for your support.
Submit your comments in the IBM Worklight forums at:

https://www.ibm.com/developerworks/mobile/worklight/connect.html

If you would like a response from IBM, please provide the following information:

23

http://www.ibm.com/software/passportadvantage

If you have a Software Subscription and Support in effect, IBM provides you assistance for your routine, short duration installation and
usage (how-to) questions, and code-related questions. For additional details, consult your IBM Software Support Handbook at:

Name
Address
Company or Organization
Phone No.
Email address

Copyright International Business Machines Corporation 2011, 2013. All rights reserved.

Thank You

4 July 2013

Copyright International Business Machines Corporation 2011, 2013. All rights reserved.
US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.