Files
win8phoneApp/Doc/xml/_utility_2_background_tasks_8cs.xml
2013-10-18 09:32:53 +02:00

92 lines
19 KiB
XML
Raw Permalink Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.4">
<compounddef id="_utility_2_background_tasks_8cs" kind="file">
<compoundname>BackgroundTasks.cs</compoundname>
<innerclass refid="class_campus_app_w_p8_1_1_utility_1_1_background_tasks" prot="public">CampusAppWP8::Utility::BackgroundTasks</innerclass>
<innernamespace refid="namespace_campus_app_w_p8_1_1_utility">CampusAppWP8::Utility</innernamespace>
<innernamespace refid="namespace_microsoft_1_1_phone_1_1_scheduler">Microsoft::Phone::Scheduler</innernamespace>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<programlisting>
<codeline lineno="1"><highlight class="normal"></highlight><highlight class="comment">//-----------------------------------------------------------------------</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="2"><highlight class="normal"></highlight><highlight class="comment">//<sp/>&lt;copyright<sp/>file=&quot;BackgroundTasks.cs&quot;<sp/>company=&quot;BTU/IIT&quot;&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="3"><highlight class="normal"></highlight><highlight class="comment">//<sp/>The<sp/>MIT<sp/>License<sp/>(MIT).<sp/>Copyright<sp/>(c)<sp/>2013<sp/>BTU/IIT.</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="4"><highlight class="normal"></highlight><highlight class="comment">//<sp/>&lt;/copyright&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="5"><highlight class="normal"></highlight><highlight class="comment">//<sp/>&lt;author&gt;Stubbfel&lt;/author&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="6"><highlight class="normal"></highlight><highlight class="comment">//<sp/>&lt;date&gt;15.10.2013&lt;/date&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="7"><highlight class="normal"></highlight><highlight class="comment">//<sp/>&lt;summary&gt;Implements<sp/>the<sp/>background<sp/>tasks<sp/>class&lt;/summary&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="8"><highlight class="normal"></highlight><highlight class="comment">//-----------------------------------------------------------------------</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="9"><highlight class="normal"></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal">CampusAppWP8.Utility</highlight></codeline>
<codeline lineno="10"><highlight class="normal">{</highlight></codeline>
<codeline lineno="11"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using</highlight><highlight class="normal"><sp/>System;</highlight></codeline>
<codeline lineno="12"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using</highlight><highlight class="normal"><sp/>CampusAppWP8ScheduledTaskAgent.Resources;</highlight></codeline>
<codeline lineno="13"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using</highlight><highlight class="normal"><sp/>CampusAppWPortalLib8.Utility;</highlight></codeline>
<codeline lineno="14"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using</highlight><highlight class="normal"><sp/>Microsoft.Phone.Scheduler;</highlight></codeline>
<codeline lineno="15"><highlight class="normal"></highlight></codeline>
<codeline lineno="19" refid="class_campus_app_w_p8_1_1_utility_1_1_background_tasks" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">public</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">class<sp/></highlight><highlight class="normal"><ref refid="class_campus_app_w_p8_1_1_utility_1_1_background_tasks" kindref="compound" tooltip="Class provide some static methods for background tasks. ">BackgroundTasks</ref><sp/>:<sp/><ref refid="class_campus_app_w_portal_lib8_1_1_utility_1_1_abstract_background_tasks" kindref="compound" tooltip="abstract class for BackGroundTask. ">AbstractBackgroundTasks</ref></highlight></codeline>
<codeline lineno="20"><highlight class="normal"><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="25" refid="class_campus_app_w_p8_1_1_utility_1_1_background_tasks_1ab3797775554c71c936356be2b91f5022" refkind="member"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">public</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">static</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/><ref refid="class_campus_app_w_p8_1_1_utility_1_1_background_tasks_1ab3797775554c71c936356be2b91f5022" kindref="member" tooltip="Method start a certain PerodicTask. ">StartPerodicTask</ref>(</highlight><highlight class="keywordtype">string</highlight><highlight class="normal"><sp/>taskName,<sp/></highlight><highlight class="keywordtype">string</highlight><highlight class="normal"><sp/>taskDesc)</highlight></codeline>
<codeline lineno="26"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="27"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="class_campus_app_w_p8_1_1_utility_1_1_background_tasks" kindref="compound" tooltip="Class provide some static methods for background tasks. ">BackgroundTasks</ref>.<ref refid="class_campus_app_w_p8_1_1_utility_1_1_background_tasks_1a49da287dcb03efd9e9ac7c79321a6c3f" kindref="member" tooltip="Method stop a certain PerodicTask. ">StopPerodicTask</ref>(<ref refid="class_campus_app_w_p8_1_1_utility_1_1_background_tasks" kindref="compound" tooltip="Class provide some static methods for background tasks. ">BackgroundTasks</ref>.<ref refid="class_campus_app_w_portal_lib8_1_1_utility_1_1_abstract_background_tasks_1aa7f4f5936508e7182780b1e58091add9" kindref="member" tooltip="Gets or sets the name of the last running task. ">LastAddedTaskName</ref>);</highlight></codeline>
<codeline lineno="28"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="class_campus_app_w_p8_1_1_utility_1_1_background_tasks" kindref="compound" tooltip="Class provide some static methods for background tasks. ">BackgroundTasks</ref>.<ref refid="class_campus_app_w_p8_1_1_utility_1_1_background_tasks_1a49da287dcb03efd9e9ac7c79321a6c3f" kindref="member" tooltip="Method stop a certain PerodicTask. ">StopPerodicTask</ref>(taskName);</highlight></codeline>
<codeline lineno="29"><highlight class="normal"></highlight></codeline>
<codeline lineno="30"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>PeriodicTask<sp/>periodicTask<sp/>=<sp/></highlight><highlight class="keyword">new</highlight><highlight class="normal"><sp/>PeriodicTask(taskName);</highlight></codeline>
<codeline lineno="31"><highlight class="normal"></highlight></codeline>
<codeline lineno="32"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="comment">//<sp/>load<sp/>description<sp/>from<sp/>localized<sp/>strings</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="33"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>periodicTask.Description<sp/>=<sp/>taskDesc;</highlight></codeline>
<codeline lineno="34"><highlight class="normal"></highlight></codeline>
<codeline lineno="35"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">try</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="36"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="37"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>ScheduledActionService.Add(periodicTask);</highlight></codeline>
<codeline lineno="38"><highlight class="normal"></highlight></codeline>
<codeline lineno="39"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="comment">//<sp/>ScheduledActionService.LaunchForTest(taskName,<sp/>new<sp/>TimeSpan(10));</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="40"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="41"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">catch</highlight><highlight class="normal"><sp/>(Exception<sp/>e)</highlight></codeline>
<codeline lineno="42"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="43"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="class_campus_app_w_portal_lib8_1_1_utility_1_1_logger" kindref="compound" tooltip="This Class creates logs for the app. ">Logger</ref>.<ref refid="class_campus_app_w_portal_lib8_1_1_utility_1_1_logger_1a04176403d58a1ccce2d004cd9dc8c1ac" kindref="member" tooltip="Method log a Exception. ">LogException</ref>(e);</highlight></codeline>
<codeline lineno="44"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="45"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="46"><highlight class="normal"></highlight></codeline>
<codeline lineno="47"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="class_campus_app_w_p8_1_1_utility_1_1_background_tasks" kindref="compound" tooltip="Class provide some static methods for background tasks. ">BackgroundTasks</ref>.<ref refid="class_campus_app_w_portal_lib8_1_1_utility_1_1_abstract_background_tasks_1aa7f4f5936508e7182780b1e58091add9" kindref="member" tooltip="Gets or sets the name of the last running task. ">LastAddedTaskName</ref><sp/>=<sp/>taskName;</highlight></codeline>
<codeline lineno="48"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="49"><highlight class="normal"></highlight></codeline>
<codeline lineno="53" refid="class_campus_app_w_p8_1_1_utility_1_1_background_tasks_1a49da287dcb03efd9e9ac7c79321a6c3f" refkind="member"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">public</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">static</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/><ref refid="class_campus_app_w_p8_1_1_utility_1_1_background_tasks_1a49da287dcb03efd9e9ac7c79321a6c3f" kindref="member" tooltip="Method stop a certain PerodicTask. ">StopPerodicTask</ref>(</highlight><highlight class="keywordtype">string</highlight><highlight class="normal"><sp/>taskName)</highlight></codeline>
<codeline lineno="54"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="55"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal"><sp/>(taskName<sp/>==<sp/>null)</highlight></codeline>
<codeline lineno="56"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="57"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="58"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="59"><highlight class="normal"></highlight></codeline>
<codeline lineno="60"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>PeriodicTask<sp/>periodicTask<sp/>=<sp/>ScheduledActionService.Find(taskName)<sp/>as<sp/>PeriodicTask;</highlight></codeline>
<codeline lineno="61"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal"><sp/>(periodicTask<sp/>!=<sp/>null)</highlight></codeline>
<codeline lineno="62"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="63"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">try</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="64"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="65"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>ScheduledActionService.Remove(taskName);</highlight></codeline>
<codeline lineno="66"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="67"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">catch</highlight><highlight class="normal"><sp/>(Exception<sp/>e)</highlight></codeline>
<codeline lineno="68"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="69"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="class_campus_app_w_portal_lib8_1_1_utility_1_1_logger" kindref="compound" tooltip="This Class creates logs for the app. ">Logger</ref>.<ref refid="class_campus_app_w_portal_lib8_1_1_utility_1_1_logger_1a04176403d58a1ccce2d004cd9dc8c1ac" kindref="member" tooltip="Method log a Exception. ">LogException</ref>(e);</highlight></codeline>
<codeline lineno="70"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="71"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="72"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="73"><highlight class="normal"></highlight></codeline>
<codeline lineno="76" refid="class_campus_app_w_p8_1_1_utility_1_1_background_tasks_1a6a0e549845c1ebbfbca4a0db3e592c55" refkind="member"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">public</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">static</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/><ref refid="class_campus_app_w_p8_1_1_utility_1_1_background_tasks_1a6a0e549845c1ebbfbca4a0db3e592c55" kindref="member" tooltip="Method start BTUCampusAppBackgroundTask. ">StartBTUCampusAppTask</ref>()</highlight></codeline>
<codeline lineno="77"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="78"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>campusId<sp/>=<sp/>(int)Settings.UserProfil.DefaultCampus;</highlight></codeline>
<codeline lineno="79"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="class_campus_app_w_p8_1_1_utility_1_1_background_tasks" kindref="compound" tooltip="Class provide some static methods for background tasks. ">BackgroundTasks</ref>.<ref refid="class_campus_app_w_p8_1_1_utility_1_1_background_tasks_1ab3797775554c71c936356be2b91f5022" kindref="member" tooltip="Method start a certain PerodicTask. ">StartPerodicTask</ref>(<ref refid="class_campus_app_w_p8_1_1_resources_1_1_constants" kindref="compound" tooltip="Eine stark typisierte Ressourcenklasse zum Suchen von lokalisierten Zeichenfolgen usw...">Constants</ref>.BackgroundTask_BTUCampusApp,<sp/><ref refid="class_campus_app_w_p8_1_1_resources_1_1_app_resources" kindref="compound" tooltip="Eine stark typisierte Ressourcenklasse zum Suchen von lokalisierten Zeichenfolgen usw...">AppResources</ref>.BackGroundTaskDesc_BTUCampusApp<sp/>+<sp/></highlight><highlight class="stringliteral">&quot;<sp/>-<sp/><sp/>Feed<sp/>&quot;</highlight><highlight class="normal"><sp/>+<sp/>campusId);</highlight></codeline>
<codeline lineno="80"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="81"><highlight class="normal"></highlight></codeline>
<codeline lineno="84" refid="class_campus_app_w_p8_1_1_utility_1_1_background_tasks_1a8c77a25e56c0e83280c3a78ce73eb6ef" refkind="member"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">public</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">static</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/><ref refid="class_campus_app_w_p8_1_1_utility_1_1_background_tasks_1a8c77a25e56c0e83280c3a78ce73eb6ef" kindref="member" tooltip="Method stop BTUCampusAppBackgroundTask. ">StopBTUCampusAppTask</ref>()</highlight></codeline>
<codeline lineno="85"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="86"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="class_campus_app_w_p8_1_1_utility_1_1_background_tasks" kindref="compound" tooltip="Class provide some static methods for background tasks. ">BackgroundTasks</ref>.<ref refid="class_campus_app_w_p8_1_1_utility_1_1_background_tasks_1a49da287dcb03efd9e9ac7c79321a6c3f" kindref="member" tooltip="Method stop a certain PerodicTask. ">StopPerodicTask</ref>(<ref refid="class_campus_app_w_p8_1_1_resources_1_1_constants" kindref="compound" tooltip="Eine stark typisierte Ressourcenklasse zum Suchen von lokalisierten Zeichenfolgen usw...">Constants</ref>.BackgroundTask_BTUCampusApp);</highlight></codeline>
<codeline lineno="87"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="88"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="89"><highlight class="normal">}</highlight></codeline>
</programlisting>
<location file="C:/Users/stubbfel/gitrepos/CampusAppWP8/CampusAppWP8/CampusAppWP8/Utility/BackgroundTasks.cs"/>
</compounddef>
</doxygen>