Skip to content
This repository has been archived by the owner on May 15, 2024. It is now read-only.

Commit

Permalink
Added docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@mattleibow
mattleibow committed Apr 4, 2018
1 parent 2918c75 commit b1931b0
Show file tree
Hide file tree
Showing 3 changed files with 236 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ The following cross-platform APIs are planned for our first release:
- [x] Secure Storage
- [x] SMS
- [ ] Text-to-Speech
- [x] Version Tracking
- [x] Vibrate

## Contributing
Expand Down
234 changes: 234 additions & 0 deletions docs/en/Microsoft.Caboodle/VersionTracking.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,234 @@
<Type Name="VersionTracking" FullName="Microsoft.Caboodle.VersionTracking">
<TypeSignature Language="C#" Value="public static class VersionTracking" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed VersionTracking extends System.Object" />
<AssemblyInfo>
<AssemblyName>Microsoft.Caboodle</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Provides an easy way to track an app's version on a device.</summary>
<remarks></remarks>
</Docs>
<Members>
<Member MemberName="BuildHistory">
<MemberSignature Language="C#" Value="public static System.Collections.Generic.IEnumerable&lt;string&gt; BuildHistory { get; }" />
<MemberSignature Language="ILAsm" Value=".property class System.Collections.Generic.IEnumerable`1&lt;string&gt; BuildHistory" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable&lt;System.String&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the collection of build numbers of the app that ran on this device.</summary>
<value></value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="CurrentBuild">
<MemberSignature Language="C#" Value="public static string CurrentBuild { get; }" />
<MemberSignature Language="ILAsm" Value=".property string CurrentBuild" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the current build of the app.</summary>
<value></value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="CurrentVersion">
<MemberSignature Language="C#" Value="public static string CurrentVersion { get; }" />
<MemberSignature Language="ILAsm" Value=".property string CurrentVersion" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the current version number of the app.</summary>
<value></value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="FirstInstalledBuild">
<MemberSignature Language="C#" Value="public static string FirstInstalledBuild { get; }" />
<MemberSignature Language="ILAsm" Value=".property string FirstInstalledBuild" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the build number of first version of the app that was installed on this device.</summary>
<value></value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="FirstInstalledVersion">
<MemberSignature Language="C#" Value="public static string FirstInstalledVersion { get; }" />
<MemberSignature Language="ILAsm" Value=".property string FirstInstalledVersion" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the version number of the first version of the app that was installed on this device.</summary>
<value></value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="IsFirstLaunchEver">
<MemberSignature Language="C#" Value="public static bool IsFirstLaunchEver { get; }" />
<MemberSignature Language="ILAsm" Value=".property bool IsFirstLaunchEver" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value indicating whether this is the first time this app has ever been launched on this device.</summary>
<value></value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="IsFirstLaunchForBuild">
<MemberSignature Language="C#" Value="public static bool IsFirstLaunchForBuild (string build);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool IsFirstLaunchForBuild(string build) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="build" Type="System.String" />
</Parameters>
<Docs>
<param name="build">The build number.</param>
<summary>Determines if this is the first launch of the app for a specified build number.</summary>
<returns>Returns true if this is the first launch of the app for the specified build number; otherwise false.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="IsFirstLaunchForCurrentBuild">
<MemberSignature Language="C#" Value="public static bool IsFirstLaunchForCurrentBuild { get; }" />
<MemberSignature Language="ILAsm" Value=".property bool IsFirstLaunchForCurrentBuild" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value indicating if this is the first launch of the app for the current build number.</summary>
<value></value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="IsFirstLaunchForCurrentVersion">
<MemberSignature Language="C#" Value="public static bool IsFirstLaunchForCurrentVersion { get; }" />
<MemberSignature Language="ILAsm" Value=".property bool IsFirstLaunchForCurrentVersion" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value indicating if this is the first launch of the app for the current version number.</summary>
<value></value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="IsFirstLaunchForVersion">
<MemberSignature Language="C#" Value="public static bool IsFirstLaunchForVersion (string version);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool IsFirstLaunchForVersion(string version) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="version" Type="System.String" />
</Parameters>
<Docs>
<param name="version">The version number.</param>
<summary>Determines if this is the first launch of the app for a specified version number.</summary>
<returns>Returns true if this is the first launch of the app for the specified version number; otherwise false.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="PreviousBuild">
<MemberSignature Language="C#" Value="public static string PreviousBuild { get; }" />
<MemberSignature Language="ILAsm" Value=".property string PreviousBuild" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the build number for the previously run version.</summary>
<value></value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="PreviousVersion">
<MemberSignature Language="C#" Value="public static string PreviousVersion { get; }" />
<MemberSignature Language="ILAsm" Value=".property string PreviousVersion" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the version number for the previously run version.</summary>
<value></value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="VersionHistory">
<MemberSignature Language="C#" Value="public static System.Collections.Generic.IEnumerable&lt;string&gt; VersionHistory { get; }" />
<MemberSignature Language="ILAsm" Value=".property class System.Collections.Generic.IEnumerable`1&lt;string&gt; VersionHistory" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable&lt;System.String&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the collection of version numbers of the app that ran on this device.</summary>
<value></value>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>
1 change: 1 addition & 0 deletions docs/en/index.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@
<Type Name="ShareTextRequest" Kind="Class" />
<Type Name="Sms" Kind="Class" />
<Type Name="SmsMessage" Kind="Class" />
<Type Name="VersionTracking" Kind="Class" />
<Type Name="Vibration" Kind="Class" />
</Namespace>
</Types>
Expand Down

0 comments on commit b1931b0

Please sign in to comment.