microsoftdocs / cordova-docs

ARCHIVE (NO LONGER IN USE)

ARCHIVED CONTENT

Visual Studio Tools for Apache Cordova has a NEW docs repo

This GitHub repository is NO LONGER IN USE - please visit the updated documentation at github.com/MicrosoftDocs/CordovaDocs.

This repo contains documentation relevant to Visual Studio 2015 only.

Terms of Use

By downloading and running this project, you agree to the license terms of the third party application software, Microsoft products, and components to be installed.

The third party software and products are provided to you by third parties. You are responsible for reading and accepting the relevant license terms for all software that will be installed. Microsoft grants you no rights to third party software.

License

Unless otherwise mentioned, the code samples are released under the MIT license.

The MIT License (MIT)

Copyright (c) Microsoft Corporation

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

cordova-docs's Issues

Possible Tutorial Addition

I had a problem updating TypeScript in my Visual Studio 2015 Cordova projects. There wasn't a lot of information available so I stumbled across a solution. I wrote up instructions and placed on stackoverflow. I believe these are best practices.

I think other VS Cordova users may want to know this? Is it possible to put the content on cordova-docs or a link to it? Please use the content if necessary.

Here's the instructions:
http://stackoverflow.com/questions/32385087/vs2015-change-typescript-version/32394948?noredirect=1#answer-32403229

Suggestion for "Build errors caused by long path and file names"

I recently hit this issue and was able to partially resolve it by following the suggestion of moving the project closer to the root of the drive. However the npm-cache folder was still an issue as it lives by default in C:\Users\username\AppData\Roaming\npm-cache.

I was able to get around this by creating a .npmrc file in my project and specifying a folder that lives in my project (excluded with .gitignore). Another option is to move it for the user profile or possibly the entire machine.

I'd be happy to write something up for this if it is useful and a particular approach is preferred!

5.4.0

Build a 5.4.0 project for Windows 10 (UWP x64) results in:

MakeAppx : error : Error info: error C00CE015: App manifest validation error: The app manifest must be valid as per schema: Line 25, Column 203, Reason: The attribute 'ToastCapable' on the element '{http://schemas.microsoft.com/appx/manifest/uap/windows10}VisualElements' is not defined in the DTD/Schema. [C:\demoprojects\BlankCordovaApp1\platforms\windows\CordovaApp.Windows10.jsproj]

Are the Tools for Apache Cordova open source? Where to report issues?

The title says it all.

it's so nice to be able to report issues easily over here at GitHub like we can with Microsoft's Node.js tools. I cannot find any information about whether Tools for Apache Cordova are open source or not or where to easily report issues for it.

Build fail in VS 2015 community due to the mysql?

I just installed the VS 2015 community version and created a JavaScript-apache cordova project.

It worked once,but after I reopen the project ,It told me that build success but debug fail.

I really have no idea.

Cannot open a cordova project that was created using VS2013 Update 4 into Visual Studio 2015 Community Edition

Hi,

Cannot open a cordova project that was created using VS2013 Update 4 into Visual Studio 2015 Community Edition.
I get "his project is incompatible with the current edition of Visual Studio".

Any suggestions or workaround?

Known issues - vs2015 does not show correct info - jsproj files missing

Step 6 at https://github.com/Microsoft/cordova-docs/blob/master/known-issues/known-issues-vs2015.md has to include *.jsproj + .jsproj. files

keystore absolute paths are not supported

I was following the guidelines here:
https://github.com/Microsoft/cordova-docs/tree/master/tutorial-package-publish

build.json setup mentions absolute path: "keystore":"c:\\my-release-key.keystore",

But copying that brings a build error which makes it clear that absolute paths are not supported in keystore item.

IOS Remote build excludes all folders with the word 'plugins'

This is a bit of a pain as I'm using durandal for my app structure, which relies on a folder inside (in my case) www > scripts > libs > durandal > plugins

That plugins folder and everything in it fail to get copied so obviously things aren't working so well once deployed.

Errors when building for Android with plugins that include Google Play Services as a framework

When building a Cordova CLI 5.1.1 project in Visual Studio 2015 that has a plugin that includes Google Play Services as a framework the following error is shown in the build console:

1>------ Rebuild All started: Project: BlankCordovaApp2, Configuration: Debug Android ------
1>  ANDROID_HOME=C:\Program Files (x86)\Android\android-sdk
1>  JAVA_HOME=C:\Program Files (x86)\Java\jdk1.7.0_80
1>  Running: c:\Users\Josh\Documents\Visual Studio 2015\Projects\BlankCordovaApp2\BlankCordovaApp2\platforms\android\gradlew clean -b c:\Users\Josh\Documents\Visual Studio 2015\Projects\BlankCordovaApp2\BlankCordovaApp2\platforms\android\build.gradle -Dorg.gradle.daemon=true
1>
1>  FAILURE: Build failed with an exception.
1>
1>  * What went wrong:
1>  A problem occurred configuring root project 'android'.
1>  > Could not resolve all dependencies for configuration ':_debugCompile'.
1>     > Could not find com.google.android.gms:play-services-gcm:7.3.0.
1>       Searched in the following locations:
1>           https://repo1.maven.org/maven2/com/google/android/gms/play-services-gcm/7.3.0/play-services-gcm-7.3.0.pom
1>           https://repo1.maven.org/maven2/com/google/android/gms/play-services-gcm/7.3.0/play-services-gcm-7.3.0.jar
1>           file:/C:/Program Files (x86)/Android/android-sdk/extras/android/m2repository/com/google/android/gms/play-services-gcm/7.3.0/play-services-gcm-7.3.0.pom
1>           file:/C:/Program Files (x86)/Android/android-sdk/extras/android/m2repository/com/google/android/gms/play-services-gcm/7.3.0/play-services-gcm-7.3.0.jar
1>       Required by:
1>           :android:unspecified
1>     > Could not find com.google.android.gms:play-services-ads:7.3.0.
1>       Searched in the following locations:
1>           https://repo1.maven.org/maven2/com/google/android/gms/play-services-ads/7.3.0/play-services-ads-7.3.0.pom
1>           https://repo1.maven.org/maven2/com/google/android/gms/play-services-ads/7.3.0/play-services-ads-7.3.0.jar
1>           file:/C:/Program Files (x86)/Android/android-sdk/extras/android/m2repository/com/google/android/gms/play-services-ads/7.3.0/play-services-ads-7.3.0.pom
1>           file:/C:/Program Files (x86)/Android/android-sdk/extras/android/m2repository/com/google/android/gms/play-services-ads/7.3.0/play-services-ads-7.3.0.jar
1>       Required by:
1>           :android:unspecified
1>
1>  * Try:
1>  Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output.
1>
1>  BUILD FAILED
1>
1>  Total time: 2.121 secs
1>
1>  c:\Users\Josh\Documents\Visual Studio 2015\Projects\BlankCordovaApp2\BlankCordovaApp2\platforms\android\cordova\node_modules\q\q.js:126
1>                      throw e;
1>                            ^
1>  Error code 1 for command: cmd with args: /s /c ""c:\Users\Josh\Documents\Visual Studio 2015\Projects\BlankCordovaApp2\BlankCordovaApp2\platforms\android\gradlew" clean -b "c:\Users\Josh\Documents\Visual Studio 2015\Projects\BlankCordovaApp2\BlankCordovaApp2\platforms\android\build.gradle" -Dorg.gradle.daemon=true"
1>C:\Program Files (x86)\MSBuild\Microsoft\VisualStudio\v14.0\ApacheCordovaTools\vs-mda-targets\Microsoft.MDA.FileMirroring.targets(352,5): error MSB3073: The command "platforms\android\cordova\clean.bat" exited with code 1.
========== Rebuild All: 0 succeeded, 1 failed, 0 skipped ==========

The problem can be repdocuded by adding OneSignal as a custom plugin and setting the Cordova CLI to 5.1.1.

If I build this project from the command line by running cordova build android it runs just fine. If I run platforms\android\gradlew -b platforms\android\build.gradle -Dorg.gradle.daemon=true from the command line I get the same error as VS.

OneSignal's plugin.xml framework includes:

<framework src="com.google.android.gms:play-services-gcm:7.3.0" />
<framework src="com.google.android.gms:play-services-ads:7.3.0" />

Please look into fixing this in Visual Studio or include any settings that are needed to to fix this issue.

Thanks.

Remove duplicate content from repo

After a recent folder structure change, we now have articles located in an /articles folder, however we still have those same articles in their pre-existing locations at the root of the repo. This results in duplicate content in the repo and leads to difficulty in understanding where to submit changes. For example, this page:

package-and-publish/get-your-app-approved.md

and

articles/package-and-publish/get-your-app-approved.md

Have the same content. There should be just one source of truth (in the articles folder, I assume). So that links to the old file locations continue to work, we need to keep files there. I suggest that we replace their content with some simple text like "This document has moved! See it in its new home at: ..." and a link to the new file location.

Push notification Tutorial

The samples on github :(https://github.com/Azure/mobile-services-samples)
is either using VS2013 or is not using Visual studio at all.

And the documentation on azure (https://azure.microsoft.com/en-us/documentation/articles/mobile-services-javascript-backend-windows-universal-dotnet-get-started-push/)
has all the platform except Cordova.

Can the team add a VS2015 version of the push notification sample with tutorial?
I believe this will help a lot of developers like me struggling to make push notification to work.

Spelling

Just making sure we're paying attention.

Spelling on "our documentation" needs to be updated.
"Help us improve out docuementaiton by sending us a pull-request or opening a GitHub Issue"

Located https://github.com/Microsoft/cordova-docs

How to exclude folder In Project or file, VS2015

I'm using VS2015, as I know I could add folder or files to Include In Project, but there's anyway to exclude from Project?

Typescript problem on cordova project

on Android
I tried debug two differend mobile os Android and iOS .
I update the cordova tools to Update 9 - Visual Studio Tools for Apache Cordova.
Create blank a typescript cordova project. Run the project a android VS Androud emulator 5.2.
Everything working such as javascript sourcemap to typescript. Yes i can add breakpoint to typescript file and can debug it.

on iOS
But
when i debug on ios Simulator to remote on Mac same blank typescript cordova project,
only breakpoints on javavascript working. Typescript files not seem on Script documents when debug.

ios simulator (iPhone 6s ) version 9.3
xcode version 7.3.1
i update everything such az npm, remotebuild, cordova vs..

I added example screenshot on here. Once Android one picture, after add two pic. for iOS debug.

So i tried on blank typescript cordova project and
typescript debuggin not working on remote ios simulator debuggin.

Missing instructions for importing an existing Cordova project

I have an existing Cordova project, created with the CLI tools on OSX and checked in to git. I can clone the git repo through VS2015, but I can't figure out how to import the repo into VS.

I know it's possible to create a new blank Cordova app in VS and copy all the content over, but I believe it was mentioned that importing existing apps was a supported feature.

Cordova application in Visual studio 2015 with ripple emulator giving error

Hi,
I have installed VS 2015 full instalation and also installed all andriod sdk and other dependent items for cordova application to run but still i receive below error when i try to run it in ripple emulator extension of chrome. please take a note that project builds successfully but when it runs in chrome it throws below error

CordovaError: Current working directory is not a Cordova-based project.
at Object.module.exports.cdProjectRoot (C:\Users\DMPatel\node_modules\cordova\src\util.js:87:19)
at prepare (C:\Users\DMPatel\node_modules\cordova\src\prepare.js:36:36)
at Object.handle (C:\Users\DMPatel\AppData\Roaming\npm\node_modules\vs-tac\node_modules\ripple-emulator\lib\server\emulate\hosted.js:200:17)
at next (C:\Users\DMPatel\AppData\Roaming\npm\node_modules\vs-tac\node_modules\ripple-emulator\node_modules\express\node_modules\connect\lib\proto.js:199:15)
at Object.handle (C:\Users\DMPatel\AppData\Roaming\npm\node_modules\vs-tac\node_modules\ripple-emulator\lib\server\emulate\cordovaProject.js:74:13)
at next (C:\Users\DMPatel\AppData\Roaming\npm\node_modules\vs-tac\node_modules\ripple-emulator\node_modules\express\node_modules\connect\lib\proto.js:199:15)
at next (C:\Users\DMPatel\AppData\Roaming\npm\node_modules\vs-tac\node_modules\ripple-emulator\node_modules\express\node_modules\connect\lib\proto.js:174:78)
at pass (C:\Users\DMPatel\AppData\Roaming\npm\node_modules\vs-tac\node_modules\ripple-emulator\node_modules\express\lib\router\index.js:107:24)
at Router._dispatch (C:\Users\DMPatel\AppData\Roaming\npm\node_modules\vs-tac\node_modules\ripple-emulator\node_modules\express\lib\router\index.js:170:5)
at Object.router (C:\Users\DMPatel\AppData\Roaming\npm\node_modules\vs-tac\node_modules\ripple-emulator\node_modules\express\lib\router\index.js:33:10)

Comma at the end "release" object

"keystoreType":"", contains a comma. Comma needs to be removed. Visual Studio warning "Unexpected comma after the last object member."

Bower sample and typescript definition

I want to be able to use bower to get angular and the typescript definition. Can you add a sample or some guideance on this. Why the samples uses a powershell script for this?

Also, will be nice to know how / where should I create MyApp module using typescript, a controller, a service and a factory as demo/example.

Thanks.

Cannot Open project.json file

Here's the sequence of events:

1. installed VS 2015
2. set up DNVM and DNX
3. Downloaded the Git Zip
4. Opened the solution and the projects did not fully install for Console, Mvc, Web.
5. Finally figured out to select the project.json files when Add | Existing Project ... is used.
6. The projects did open and I could browse to any of them.

Great stuff but .Net 5 was not installed. So I downloaded it from Microsoft and ran the install for .Net 5.0 RC1 Update 1. After this VS 2015 would not open.

So I uninstalled the .Net 5 framework and finally VS 2015 would start up. But then all 3 projects in the list have (incompatible) after them, i.e., ConsoleApp (incompatible) and the same for MvcApp and WebApp.

But now when I browse to the project locations with Add | Existing Project ... VS 2015 expects to see a .csproj file, not .xproj or .json. If I try to use either of these latter 2 types I get a dialog saying that .csproj file needs to be used.

Makes no sense ... the Git download worked the first time after the projects were re-loaded. I looked in Tools | Options to see if there was some way to select the correct project file types -- maybe a checkbox was set wrong and VS is set somehow now to only look for .csproj?

Checked Google but could not find what was causing the error.

I've repaired the install after the .Net 5 uninstall. Also made sure dnvm and dnx are installed. It all looks correct but any project / solution I open with VS 2015, any project or projects even though they're obviously 2015 projects show as incompatible.

Use GitHub archive function

The readme mentions this isn't maintained, so it probably makes sense to use the (now built in) archive function https://help.github.com/articles/about-archiving-repositories/

Need to restart VS after setting environment variable for Could Not Create Java Virtual Machine Error

I ran into this Android Java issue. It is missing the info that Visual Studio needs to be restarted after the environment variable has been set.

It might also be a good idea to reproduce a version of the instructions there and give credit to the source site, just in case that link breaks.

Can't Create nor Open Apache Cordova Projects

When I try to open or Create a new Apache Cordova Project the IDE just stop to respond. I found inside the ActivityLog.xml some errors related to Apache Cordova Extension Initialization:

8757-4084-8526-E8A1D165433D} VisualStudio 2015/08/17 13:40:36.261
728 Begin package load [ApacheCordovaToolsPackage] {317A330D-8757-4084-8526->E8A1D165433D} VisualStudio 2015/08/17 13:40:36.261
729 ERROR SetSite failed for package [ApacheCordovaToolsPackage] {317A330D-8757-4084-8526->E8A1D165433D} 80131604 VisualStudio 2015/08/17 13:40:36.498
730 ERROR End package load [ApacheCordovaToolsPackage] {317A330D-8757-4084-8526->E8A1D165433D} 80131604 VisualStudio 2015/08/17 13:40:36.503
731 Entering function CVsPackageInfo::HrInstantiatePackage {317A330D-8757-4084-8526->E8A1D165433D} VisualStudio 2015/08/17 13:40:48.902
732 Begin package load [ApacheCordovaToolsPackage] {317A330D-8757-4084-8526->E8A1D165433D} VisualStudio 2015/08/17 13:40:48.902
733 ERROR SetSite failed for package [ApacheCordovaToolsPackage] {317A330D-8757-4084-8526->E8A1D165433D} 80131604 VisualStudio 2015/08/17 13:40:48.903
734 ERROR End package load [ApacheCordovaToolsPackage]

I had a clean instalation, and just upgraded the VS 2015 Azure SDK, nothing else more, but somehow stop working.

Missing iOS Icons and Splashscreens

Known Issues - CTP 3/3.1 for Visual Studio 2013

The suggested fix for the issue Missing iOS Icons and Splashscreens works. However, the element is removed when editing confix.xml from the designer. Is there any way to get around it besides using an older version of vs-mda-remote?

Hosted app tutorial does not work properly

When I use the latest update and Cordova 5.4.1 and the hosted app tutorial:
http://taco.visualstudio.com/en-us/docs/create-a-hosted-app/

I get the following error:
"APPHOST9624: The app can’t use script to load the https://cordovahostedweb-starter.azurewebsites.net/ url because the url launches another app. Only direct user interaction can launch another app."

The error is triggered by this line:
window.location.replace(targetUrl);

The allow-navigation tag is set to the following in config.xml and the CSP is set the same as in the tutorial

Can you please have a look? This seems like a severe issue

Exception when trying to associate app with store

When trying to associate the app with the Store (by right clicking cordova project->Store->associate App with Store) am getting this error:
Unable to update the package manifest. An unexpected error occurred. (HRESULT: 0x80004003)

I'm using Visual studio 2015 Enterprise Update 1
Visual Studio Tools for Apache Cordova Update 5

This guy appears to get it also:
http://stackoverflow.com/questions/34118499/publishing-package-error-on-assosiasion-visual-studio

Support Cordova 5.4.1

Build is OK, but can not debug anymore.

When can we expect iOS 9 debugging?

I see that only iOS 6, 7 and 8 are listed as supported versions for debugging (and this is confirmed by my inability to debug on iOS 9). Is there a roadmap or expected release date for iOS 9 debugging support?