How to create simple Background Agent in Windows Phone - Revision history

Influencer: Influencer -

2013-02-09T14:22:42Z

Influencer -

Aady: Aady - /* Basic requirements */

2013-02-08T18:57:22Z

Aady - - Basic requirements

Vdharankar: Vdharankar -

2013-02-06T05:34:45Z

Vdharankar -

Hamishwillee: Hamishwillee - Subedit introduction

2013-02-04T00:11:42Z

Hamishwillee - Subedit introduction

Hamishwillee: Hamishwillee - Minor update

2013-02-03T23:11:20Z

Hamishwillee - Minor update

Vdharankar: Vdharankar - /* Possible Use cases */

2013-02-02T12:12:01Z

Vdharankar - - Possible Use cases

Vdharankar: Vdharankar - /* Limitations */

2013-02-02T12:08:35Z

Vdharankar - - Limitations

Vdharankar: Vdharankar - /* Introduction */

2013-02-02T11:58:33Z

Vdharankar - - Introduction

Vdharankar: Vdharankar - /* Introduction */

2013-02-02T11:42:16Z

Vdharankar - - Introduction

Hamishwillee: Hamishwillee - Bot update - Fix metadata

2013-01-23T06:44:42Z

Hamishwillee - Bot update - Fix metadata

@@ Line 53: / Line 53: @@
 == Basic requirements ==
-* You need to create an app project, it can be anything from simple basic windows phone app to panorama or pivote based application.
+* You need to create an app project, it can be anything from simple basic windows phone app to panorama or pivot based application.
-*Then create your background agent project in the same solution and add its reference to the main app, with necessary code (which is hardly few lines) you can have your background agent running. You can test agents in simulator as well.
+*Then create your background agent project in the same solution and add its reference to the main app, with necessary code (which is hardly few lines) you can have your background agent running. You can test agents in the simulator as well.
 == How to.... ==
@@ Line 62: / Line 62: @@
 [[File:Screenshot (4).png]]
-* Create a ''scheduled task agent'' project in Visual Studio, this should be added to the same solution, an easy way to do is, goto solution explorer of main application right click on solution and select add, select add project and automatically the project created will get added to the existing solution. Assign some suitable name to the project.
+* Create a ''scheduled task agent'' project in Visual Studio, this should be added to the same solution. An easy way to do this is: goto solution explorer of main application, right click on solution and select add, select add project and automatically the project created will get added to the existing solution. Assign some suitable name to the project.
@@ Line 68: / Line 68: @@
-* Next step is to add a reference to the main application it can be done by going to Solution Explorer, right click references under main project and select Add Reference option.
+* The next step is to add a reference to the main application. This can be done by going to Solution Explorer, right clicking references under main project and selecting the Add Reference option.

@@ Line 53: / Line 53: @@
 == Basic requirements ==
-You need to create an app project, it can be anything from simple basic windows phone app to panorama or pivote based application. Then create your background agent project in the same solution and add its reference to the main app, with necessary code ( which is hardly few lines) you can have your background agent running. You can test agents in simulator as well.
+* You need to create an app project, it can be anything from simple basic windows phone app to panorama or pivote based application.
 == How to.... ==

@@ Line 5: / Line 5: @@
 * [http://msdn.microsoft.com/en-us/library/windowsphone/develop/hh202941(v&#61;vs.105).aspx How to implement background agents for Windows Phone] (Dev Center)}}
 {{ArticleMetaData <!-- v1.2 -->
-|sourcecode= <!-- Link to example source code e.g. [[Media:The Code Example ZIP.zip]] -->
+|sourcecode= [[Media:ScheduledDemoTaskAgent.zip]]
 |installfile= <!-- Link to installation file (e.g. [[Media:The Installation File.sis]]) -->
-|devices= <!-- Devices tested against - e.g. ''devices=Nokia 6131 NFC, Nokia C7-00'') -->
+|devices=   ''Nokia lumia 920, lumia 900''
-|sdk= <!-- SDK(s) built and tested against (e.g. [http://linktosdkdownload/ Qt SDK 1.1.4]) -->
+|sdk= WP SDK 8.0
 |platform= <!-- Compatible platforms - e.g. Symbian^1 and later, Qt 4.6 and later -->
 |devicecompatability= <!-- Compatible devices e.g.: All* (must have internal GPS) -->

@@ Line 1: / Line 1: @@
 [[Category:Windows Phone]][[Category:Windows Phone 8]][[Category:Windows Phone 7.5]][[Category:General Programming]]
-{{Abstract|This article explains how to create Background Agents (Tasks) in Windows Phone }}
+{{Abstract|This article provides a minimal example on how to create [http://msdn.microsoft.com/en-us/library/windowsphone/develop/hh202942(v&#61;vs.105).aspx Background Agents] (Tasks) in Windows Phone.  There is a more comprehensive example on Dev Center [http://msdn.microsoft.com/en-us/library/windowsphone/develop/hh202941(v&#61;vs.105).aspx How to implement background agents for Windows Phone].}}
+{{SeeAlso|
 {{ArticleMetaData <!-- v1.2 -->
 |sourcecode= <!-- Link to example source code e.g. [[Media:The Code Example ZIP.zip]] -->
@@ Line 26: / Line 28: @@
 == Introduction ==
-This article explains how to create a simple background agent in Windows Phone. There is a MSDN [http://msdn.microsoft.com/en-us/library/windowsphone/develop/hh202941(v=vs.105).aspx example] on how to create a background agent but its not simple it has additional stuff in like the example talks about both the background task as well as resource intensive task. Its good but for someone who just need plain simple working example of background agent/task its over-killing. Also the example has lot of additional information being shown like UI shows if the tasks are running or off, when is the tasks scheduled etc. Thus if you are looking for just plain simple how to ? here it is.
+Windows Phone apps are made dormant when running in the background or when the phone is locked (to conserve device memory and battery life). If your application needs to perform processing when it is (may be) in the background you can use a [http://msdn.microsoft.com/en-us/library/windowsphone/develop/hh202942(v=vs.105).aspx background agent] to run activities according to some schedule.
-These types of tasks can be used for various purposes in real life apps such as
+Apps which require more device resources and/or which do not require a fixed update schedule, can use a resource intensive task. These tasks run when the device is connected to external power and/or connected to a WiFi network - they are very useful when you need to transfer a lot of data or perform some other long running task in the background.
-*Download data from remote server in background, like twitter feeds , for this resource intensive tasks are best suited as downloading tweets may require more time than 25sec.
+This article provides a very simple example of how to create a ''Periodic Task''.
-*Synchronize todo-lists  in background incase of a todo application which updates based on gmail tasks.
-*Changing lock screen wallpaper after every X min/ X hours in background. ( Something that bing app does)
-*Download Facebook notifications from account
-There are several such possibilities
+{{Tip|If you want to also understand Resource-intensive tasks then check out [http://msdn.microsoft.com/en-us/library/windowsphone/develop/hh202941(v&#61;vs.105).aspx How to implement background agents for Windows Phone] (Dev Center). This is more complicated to read, but is more comprehensive and covers both periodic and resource-intensive tasks.}}
-== Limitations==
+=== Limitations===
-*Background tasks cant be repeated before 30min.
+Background agents have certain limitations, as listed below.
-*There are certain APIs which are not supported , you can check [http://msdn.microsoft.com/en-us/library/windowsphone/develop/hh202942(v=vs.105).aspx#BKMK_TypesofScheduledTasks here].
+* Background tasks can minimally be run every 30 minutes. There is a debug-only API to run them more regularly, but this is not available for released apps.
-*Background tasks are limited by number on each device and can be enabled or disabled from application settings.
+* There are certain APIs which are not supported , you can check [http://msdn.microsoft.com/en-us/library/windowsphone/develop/hh202942(v=vs.105).aspx#BKMK_TypesofScheduledTasks here].
-*They simply do not work when power saver mode is activated.
+* Some low power devices do not support background agents
 == Basic requirements ==
@@ Line 80: / Line 78: @@
-* Next open ''ScheduledAgent.cs'' file from your background agent project and add following lines of code in ''OnInvoke'' method
+* Next open '''ScheduledAgent.cs''' file from your background agent project and add following lines of code in {{Icode|OnInvoke()}} method
 <code csharp>
@@ Line 211: / Line 209: @@
 == Summary ==
-This is how you can create the {{Icode|SchedulesAgent}} Task to run in background from using your own app. There is more information on this on MSDN, I have simplified the MSDN example as I felt the original example was overkiling and was hard to understand for a beginner due to additional stuff.
+This is how you can create the {{Icode|SchedulesAgent}} Task to run in background from using your own app. The example is simpler than that provided by Dev Center and therefore makes it easier to understand the basic usage.
 Add your feedback to comment section.

@@ Line 1: / Line 1: @@
-[[Category:Windows Phone]][[Category:Windows Phone 8]][[Category:Windows Phone 7.5]]
+[[Category:Windows Phone]][[Category:Windows Phone 8]][[Category:Windows Phone 7.5]][[Category:General Programming]]
-−
 {{Abstract|This article explains how to create Background Agents (Tasks) in Windows Phone }}
@@ Line 101: / Line 100: @@
 </code>
-Once the above code is added the Scheduled Agent or your background task is ready to fire a Toast notification whenever its called. As you may tun this app to test, dont forget to add following '''macro in at the top''' in your ''ScheduledAgent.cs'' file
+Once the above code is added the Scheduled Agent or your background task is ready to fire a Toast notification whenever its called. As you may tun this app to test, dont forget to add following ''macro in at the top'' in your '''ScheduledAgent.cs''' file
 <code csharp>
@@ Line 118: / Line 117: @@
-* Now next step is to setup this Agent (task) to run in background from your main app, it can be done with the help of following lines of code. Make sure you place them in your MainPage.xaml.cs file of main project, I am attaching the complete file for your exposure to the code.
+* Now next step is to setup this Agent (task) to run in background from your main app, it can be done with the help of following lines of code. Make sure you place them in your '''MainPage.xaml.cs''' file of main project, I am attaching the complete file for your exposure to the code.
 <code csharp>
@@ Line 205: / Line 204: @@
+}
 </code>
-We call ''LaunchForTest'' function only for debugging, which should be remove once your application goes into production environment.
+We call {{Icode|LaunchForTest()}} function only for debugging, which should be remove once your application goes into production environment.
 Make sure to remove the DEBUG macro once you are done debugging of the project which will stop calling the agent after every few seconds, which should be done only if you wish to debug the application.
 If you keep that line as it is it may cause failure in app submission process.
@@ Line 211: / Line 211: @@
 == Summary ==
-This is how you can create the SchedulesAgent Task to run in background from using your own app. There is more information on this on MSDN, I have simplified the MSDN example as I felt the original example was overkiling and was hard to understand for a beginner due to additional stuff.
+This is how you can create the {{Icode|SchedulesAgent}} Task to run in background from using your own app. There is more information on this on MSDN, I have simplified the MSDN example as I felt the original example was overkiling and was hard to understand for a beginner due to additional stuff.
 Add your feedback to comment section.

@@ Line 10: / Line 10: @@
 |platform= <!-- Compatible platforms - e.g. Symbian^1 and later, Qt 4.6 and later -->
 |devicecompatability= <!-- Compatible devices e.g.: All* (must have internal GPS) -->
 |dependencies= <!-- Any other/external dependencies e.g.: Google Maps Api v1.0 -->
-|signing=<!-- Signing requirements - empty or one of: Self-Signed, DevCert, Manufacturer -->
+|signing= <!-- Signing requirements - empty or one of: Self-Signed, DevCert, Manufacturer -->
 |capabilities= <!-- Capabilities required by the article/code example (e.g. Location, NetworkServices. -->
 |keywords= <!-- APIs, classes and methods (e.g. QSystemScreenSaver, QList, CBase -->
 |language= <!-- Language category code for non-English topics - e.g. Lang-Chinese -->
 |translated-by= <!-- [[User:XXXX]] -->
 |translated-from-title= <!-- Title only -->
 |translated-from-id= <!-- Id of translated revision -->
-|review-by=<!-- After re-review: [[User:username]] -->
+|review-by= <!-- After re-review: [[User:username]] -->
 |review-timestamp= <!-- After re-review: YYYYMMDD -->
 |update-by= <!-- After significant update: [[User:username]]-->
 |update-timestamp= <!-- After significant update: YYYYMMDD -->
-|creationdate= <!-- Format YYYYMMDD -->
+|creationdate= 20130121
-|author= <!-- Display as link [[User:username]] -->
+|author= [[User:Vdharankar]]
 }}
@@ Line 31: / Line 31: @@
 == Basic requirements ==
-You need to create an app project , it can be anything from simple basic windows phone app to panorama or pivote based application. Then create your background agent project in the same solution and add its reference to the main app, with necessary code ( which is hardly few lines) you can have your background agent running. You can test agents in simulator as well.
+You need to create an app project, it can be anything from simple basic windows phone app to panorama or pivote based application. Then create your background agent project in the same solution and add its reference to the main app, with necessary code ( which is hardly few lines) you can have your background agent running. You can test agents in simulator as well.
 == How to.... ==
@@ Line 37: / Line 37: @@
-[[File:Screenshot_(4).png]]
+[[File:Screenshot (4).png]]
-* Create a ''scheduled task agent'' project in Visual Studio, this should be added to the same solution , an easy way to do is, goto solution explorer of main application right click on solution and select add, select add project and automatically the project created will get added to the existing solution. Assign some suitable name to the project.
+* Create a ''scheduled task agent'' project in Visual Studio, this should be added to the same solution, an easy way to do is, goto solution explorer of main application right click on solution and select add, select add project and automatically the project created will get added to the existing solution. Assign some suitable name to the project.
-[[File:Screenshot_(5).png]]
+[[File:Screenshot (5).png]]
@@ Line 48: / Line 48: @@
-[[File:Screenshot_(6).png]]
+[[File:Screenshot (6).png]]
 * Next select Solutions section on the Add Reference dialog and you should be able to see the name of your scheduled task agent project name there select it and its done.
-[[File:Screenshot_(7).png]]
+[[File:Screenshot (7).png]]
@@ Line 76: / Line 76: @@
 </code>
-Once the above code is added the Scheduled Agent or your background task is ready to fire a Toast notification whenever its called. As you may tun this app to test , dont forget to add following '''macro in at the top''' in your ''ScheduledAgent.cs'' file
+Once the above code is added the Scheduled Agent or your background task is ready to fire a Toast notification whenever its called. As you may tun this app to test, dont forget to add following '''macro in at the top''' in your ''ScheduledAgent.cs'' file
 <code csharp>
@@ Line 93: / Line 93: @@
-* Now next step is to setup this Agent (task) to run in background from your main app , it can be done with the help of following lines of code. Make sure you place them in your MainPage.xaml.cs file of main project, I am attaching the complete file for your exposure to the code.
+* Now next step is to setup this Agent (task) to run in background from your main app, it can be done with the help of following lines of code. Make sure you place them in your MainPage.xaml.cs file of main project, I am attaching the complete file for your exposure to the code.
 <code csharp>
@@ Line 180: / Line 180: @@
+}
 </code>
-We call ''LaunchForTest'' function only for debugging , which should be remove once your application goes into production environment.
+We call ''LaunchForTest'' function only for debugging, which should be remove once your application goes into production environment.
-Make sure to remove the DEBUG macro once you are done debugging of the project which will stop calling the agent after every few seconds , which should be done only if you wish to debug the application.
+Make sure to remove the DEBUG macro once you are done debugging of the project which will stop calling the agent after every few seconds, which should be done only if you wish to debug the application.
 If you keep that line as it is it may cause failure in app submission process.