summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMike Norman <mknorman@gmail.com>2016-11-09 18:21:18 -0600
committerGitHub <noreply@github.com>2016-11-09 18:21:18 -0600
commitecbec0344336409b68493c8e38a6c9e43804bde5 (patch)
treea1a03b7b77ffb466bda6ee9a8d7b0a7b77d1f804 /docs
parent7e730a47bf5c4f8341377c010bad585c7195940f (diff)
downloadxamarin-forms-ecbec0344336409b68493c8e38a6c9e43804bde5.tar.gz
xamarin-forms-ecbec0344336409b68493c8e38a6c9e43804bde5.tar.bz2
xamarin-forms-ecbec0344336409b68493c8e38a6c9e43804bde5.zip
Applinks API docs, and a link fix in BindableProperty.xml. (#519)
Diffstat (limited to 'docs')
-rw-r--r--docs/Xamarin.Forms.Core/Xamarin.Forms/AppLinkEntry.xml56
-rw-r--r--docs/Xamarin.Forms.Core/Xamarin.Forms/Application.xml14
-rw-r--r--docs/Xamarin.Forms.Core/Xamarin.Forms/BindableProperty.xml2
-rw-r--r--docs/Xamarin.Forms.Core/Xamarin.Forms/IAppLinkEntry.xml35
-rw-r--r--docs/Xamarin.Forms.Core/Xamarin.Forms/IAppLinks.xml24
5 files changed, 76 insertions, 55 deletions
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/AppLinkEntry.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/AppLinkEntry.xml
index fdf39732..23ceff6c 100644
--- a/docs/Xamarin.Forms.Core/Xamarin.Forms/AppLinkEntry.xml
+++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/AppLinkEntry.xml
@@ -14,8 +14,9 @@
</Interface>
</Interfaces>
<Docs>
- <summary>To be added.</summary>
+ <summary>A deep application link in an app link search index.</summary>
<remarks>To be added.</remarks>
+ <related type="article" href="https://developer.xamarin.com/guides/xamarin-forms/working-with/deep-linking/">Application Indexing and Deep Linking</related>
</Docs>
<Members>
<Member MemberName=".ctor">
@@ -27,7 +28,7 @@
</AssemblyInfo>
<Parameters />
<Docs>
- <summary>To be added.</summary>
+ <summary>Creates a new <see cref="T:Xamrin.Forms.AppLinkEntry" /> with default values.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
@@ -42,9 +43,10 @@
<ReturnType>System.Uri</ReturnType>
</ReturnValue>
<Docs>
- <summary>To be added.</summary>
- <value>To be added.</value>
+ <summary>Gets or sets an application-specific URI that uniquely describes content within an app.</summary>
+ <value>An application-specific URI that uniquely describes content within an app.</value>
<remarks>To be added.</remarks>
+ <related type="article" href="https://developer.xamarin.com/guides/xamarin-forms/working-with/deep-linking/">Application Indexing and Deep Linking</related>
</Docs>
</Member>
<Member MemberName="AppLinkUriProperty">
@@ -58,7 +60,7 @@
<ReturnType>Xamarin.Forms.BindableProperty</ReturnType>
</ReturnValue>
<Docs>
- <summary>To be added.</summary>
+ <summary>Backing store for the <see cref="P:Xamarin.Forms.AppLinkEntry.AppLinkUri" /> property.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
@@ -73,9 +75,10 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
- <summary>To be added.</summary>
- <value>To be added.</value>
+ <summary>Gets or sets a description that appears with the item in search results.</summary>
+ <value>The description that appears with the item in search results.</value>
<remarks>To be added.</remarks>
+ <related type="article" href="https://developer.xamarin.com/guides/xamarin-forms/working-with/deep-linking/">Application Indexing and Deep Linking</related>
</Docs>
</Member>
<Member MemberName="DescriptionProperty">
@@ -89,7 +92,7 @@
<ReturnType>Xamarin.Forms.BindableProperty</ReturnType>
</ReturnValue>
<Docs>
- <summary>To be added.</summary>
+ <summary>Backing store for the <see cref="P:Xamarin.Forms.AppLinkEntry.Description" /> property.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
@@ -108,7 +111,7 @@
</Parameters>
<Docs>
<param name="uri">To be added.</param>
- <summary>To be added.</summary>
+ <summary>Creates and returns a new <see cref="T:Xamrin.Forms.AppLinkEntry" /> for the specified <paramref name="uri" />.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
@@ -124,9 +127,10 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
- <summary>To be added.</summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
+ <summary>Gets or sets a value that tells whether the item that is identified by the link entry is currently open.</summary>
+ <value>A value that tells whether the item that is identified by the link entry is currently open.</value>
+ <remarks>Application developers can set this value in <see cref="M:Xamarin.Forms.Application.OnAppearing" /> and <see cref="M:Xamarin.Forms.Application.OnDisappearing" /> methods to control whether the app link is shown for indexing or Handoff.</remarks>
+ <related type="article" href="https://developer.xamarin.com/guides/xamarin-forms/working-with/deep-linking/">Application Indexing and Deep Linking</related>
</Docs>
</Member>
<Member MemberName="IsLinkActiveProperty">
@@ -140,8 +144,9 @@
<ReturnType>Xamarin.Forms.BindableProperty</ReturnType>
</ReturnValue>
<Docs>
- <summary>To be added.</summary>
+ <summary>Backing store for the <see cref="P:Xamarin.Forms.AppLinkEntry.IsLinkActive" /> property.</summary>
<remarks>To be added.</remarks>
+ <related type="article" href="https://developer.xamarin.com/guides/xamarin-forms/working-with/deep-linking/">Application Indexing and Deep Linking</related>
</Docs>
</Member>
<Member MemberName="KeyValues">
@@ -155,9 +160,10 @@
<ReturnType>System.Collections.Generic.IDictionary&lt;System.String,System.String&gt;</ReturnType>
</ReturnValue>
<Docs>
- <summary>To be added.</summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
+ <summary>Gets a dictionary of application-specific key-value pairs.</summary>
+ <value>A dictionary of standard and application-specific key-value pairs that is used for Handoff on the iOS platform.</value>
+ <remarks>The standard keys are <c>contentType</c>, <c>associatedWebPage</c>, and <c>shouldAddToPublicIndex</c>.</remarks>
+ <related type="article" href="https://developer.xamarin.com/guides/xamarin-forms/working-with/deep-linking/">Application Indexing and Deep Linking</related>
</Docs>
</Member>
<Member MemberName="Thumbnail">
@@ -171,9 +177,10 @@
<ReturnType>Xamarin.Forms.ImageSource</ReturnType>
</ReturnValue>
<Docs>
- <summary>To be added.</summary>
- <value>To be added.</value>
+ <summary>Gets or sets a small image that appears with the item in search results.</summary>
+ <value>A small image that appears with the item in search results</value>
<remarks>To be added.</remarks>
+ <related type="article" href="https://developer.xamarin.com/guides/xamarin-forms/working-with/deep-linking/">Application Indexing and Deep Linking</related>
</Docs>
</Member>
<Member MemberName="ThumbnailProperty">
@@ -187,7 +194,7 @@
<ReturnType>Xamarin.Forms.BindableProperty</ReturnType>
</ReturnValue>
<Docs>
- <summary>To be added.</summary>
+ <summary>Backing store for the <see cref="P:Xamarin.Forms.AppLinkEntry.Thumbnail" /> property.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
@@ -202,9 +209,10 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
- <summary>To be added.</summary>
- <value>To be added.</value>
+ <summary>Gets or sets the title of the item.</summary>
+ <value>The title of the item.</value>
<remarks>To be added.</remarks>
+ <related type="article" href="https://developer.xamarin.com/guides/xamarin-forms/working-with/deep-linking/">Application Indexing and Deep Linking</related>
</Docs>
</Member>
<Member MemberName="TitleProperty">
@@ -218,7 +226,7 @@
<ReturnType>Xamarin.Forms.BindableProperty</ReturnType>
</ReturnValue>
<Docs>
- <summary>To be added.</summary>
+ <summary>Backing store for the <see cref="P:Xamarin.Forms.AppLinkEntry.Title" /> property.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
@@ -234,8 +242,8 @@
</ReturnValue>
<Parameters />
<Docs>
- <summary>To be added.</summary>
- <returns>To be added.</returns>
+ <summary>Returns a string representation of this <see cref="T:Xamrin.Forms.AppLinkEntry" />.</summary>
+ <returns>A string representation of this <see cref="T:Xamrin.Forms.AppLinkEntry" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/Application.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/Application.xml
index 8bc252aa..9e4cf715 100644
--- a/docs/Xamarin.Forms.Core/Xamarin.Forms/Application.xml
+++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/Application.xml
@@ -53,9 +53,10 @@
<ReturnType>Xamarin.Forms.IAppLinks</ReturnType>
</ReturnValue>
<Docs>
- <summary>To be added.</summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
+ <summary>Gets the object that developers use to register or unregister application links.</summary>
+ <value>The object that developers use to register or unregister application links.</value>
+ <remarks>It is not possible to unregister an app link on the Android platform.</remarks>
+ <related type="article" href="https://developer.xamarin.com/guides/xamarin-forms/working-with/deep-linking/">Application Indexing and Deep Linking</related>
</Docs>
</Member>
<Member MemberName="Current">
@@ -209,9 +210,10 @@
<Parameter Name="uri" Type="System.Uri" />
</Parameters>
<Docs>
- <param name="uri">To be added.</param>
- <summary>To be added.</summary>
+ <param name="uri">The URI for the request.</param>
+ <summary>App developers override this method to respond when the user initiates an app link request.</summary>
<remarks>To be added.</remarks>
+ <related type="article" href="https://developer.xamarin.com/guides/xamarin-forms/working-with/deep-linking/">Application Indexing and Deep Linking</related>
</Docs>
</Member>
<Member MemberName="OnParentSet">
@@ -377,7 +379,7 @@
</Parameters>
<Docs>
<param name="provider">To be added.</param>
- <summary>To be added.</summary>
+ <summary>Internal. Do not use.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/BindableProperty.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/BindableProperty.xml
index fd026a5b..985473ce 100644
--- a/docs/Xamarin.Forms.Core/Xamarin.Forms/BindableProperty.xml
+++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/BindableProperty.xml
@@ -28,7 +28,7 @@
<summary>A BindableProperty is a backing store for properties allowing bindings on <see cref="T:Xamarin.Forms.BindableObject" />.</summary>
<remarks>
</remarks>
- <related type="article" href="https://blog.xamarin.com/introduction-to-data-binding/" />
+ <related type="article" href="https://blog.xamarin.com/introduction-to-data-binding/">Introduction To Data Binding</related>
</Docs>
<Members>
<Member MemberName="Create">
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/IAppLinkEntry.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/IAppLinkEntry.xml
index e92f892a..421f0945 100644
--- a/docs/Xamarin.Forms.Core/Xamarin.Forms/IAppLinkEntry.xml
+++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/IAppLinkEntry.xml
@@ -7,8 +7,9 @@
</AssemblyInfo>
<Interfaces />
<Docs>
- <summary>To be added.</summary>
+ <summary>Interface that represents a deep application link in an app link search index.</summary>
<remarks>To be added.</remarks>
+ <related type="article" href="https://developer.xamarin.com/guides/xamarin-forms/working-with/deep-linking/">Application Indexing and Deep Linking</related>
</Docs>
<Members>
<Member MemberName="AppLinkUri">
@@ -22,9 +23,10 @@
<ReturnType>System.Uri</ReturnType>
</ReturnValue>
<Docs>
- <summary>To be added.</summary>
- <value>To be added.</value>
+ <summary>Gets or sets an application-specific URI that uniquely describes content within an app.</summary>
+ <value>An application-specific URI that uniquely describes content within an app.</value>
<remarks>To be added.</remarks>
+ <related type="article" href="https://developer.xamarin.com/guides/xamarin-forms/working-with/deep-linking/">Application Indexing and Deep Linking</related>
</Docs>
</Member>
<Member MemberName="Description">
@@ -38,9 +40,10 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
- <summary>To be added.</summary>
+ <summary>Gets or sets a description that appears with the item in search results.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
+ <related type="article" href="https://developer.xamarin.com/guides/xamarin-forms/working-with/deep-linking/">Application Indexing and Deep Linking</related>
</Docs>
</Member>
<Member MemberName="IsLinkActive">
@@ -54,9 +57,10 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
- <summary>To be added.</summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
+ <summary>Gets or sets a value that tells whether the item that is identified by the link entry is currently open.</summary>
+ <value>A value that tells whether the item that is identified by the link entry is currently open.</value>
+ <remarks>Application developers can set this value in <see cref="M:Xamarin.Forms.Application.OnAppearing" /> and <see cref="M:Xamarin.Forms.Application.OnDisappearing" /> methods to control whether the app link is shown for indexing or Handoff.</remarks>
+ <related type="article" href="https://developer.xamarin.com/guides/xamarin-forms/working-with/deep-linking/">Application Indexing and Deep Linking</related>
</Docs>
</Member>
<Member MemberName="KeyValues">
@@ -70,9 +74,10 @@
<ReturnType>System.Collections.Generic.IDictionary&lt;System.String,System.String&gt;</ReturnType>
</ReturnValue>
<Docs>
- <summary>To be added.</summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
+ <summary>Gets a dictionary of application-specific key-value pairs.</summary>
+ <value>A dictionary of standard and application-specific key-value pairs that is used for Handoff on the iOS platform.</value>
+ <remarks>The standard keys are <c>contentType</c>, <c>associatedWebPage</c>, and <c>shouldAddToPublicIndex</c>.</remarks>
+ <related type="article" href="https://developer.xamarin.com/guides/xamarin-forms/working-with/deep-linking/">Application Indexing and Deep Linking</related>
</Docs>
</Member>
<Member MemberName="Thumbnail">
@@ -86,9 +91,10 @@
<ReturnType>Xamarin.Forms.ImageSource</ReturnType>
</ReturnValue>
<Docs>
- <summary>To be added.</summary>
- <value>To be added.</value>
+ <summary>Gets or sets a small image that appears with the item in search results.</summary>
+ <value>A small image that appears with the item in search results</value>
<remarks>To be added.</remarks>
+ <related type="article" href="https://developer.xamarin.com/guides/xamarin-forms/working-with/deep-linking/">Application Indexing and Deep Linking</related>
</Docs>
</Member>
<Member MemberName="Title">
@@ -102,9 +108,10 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
- <summary>To be added.</summary>
- <value>To be added.</value>
+ <summary>Gets or sets the title of the item.</summary>
+ <value>The title of the item.</value>
<remarks>To be added.</remarks>
+ <related type="article" href="https://developer.xamarin.com/guides/xamarin-forms/working-with/deep-linking/">Application Indexing and Deep Linking</related>
</Docs>
</Member>
</Members>
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/IAppLinks.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/IAppLinks.xml
index 9ae31b08..e71b0ae1 100644
--- a/docs/Xamarin.Forms.Core/Xamarin.Forms/IAppLinks.xml
+++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/IAppLinks.xml
@@ -7,8 +7,9 @@
</AssemblyInfo>
<Interfaces />
<Docs>
- <summary>To be added.</summary>
- <remarks>To be added.</remarks>
+ <summary>Interface that defines the methods that are required for registering and deregistering links to content in apps.</summary>
+ <remarks>Developers should note that extra steps are required to enable deep linking on the Android platform. See the related article that is linked below.</remarks>
+ <related type="article" href="https://developer.xamarin.com/guides/xamarin-forms/working-with/deep-linking/">Application Indexing and Deep Linking</related>
</Docs>
<Members>
<Member MemberName="DeregisterLink">
@@ -25,9 +26,10 @@
<Parameter Name="appLinkUri" Type="System.Uri" />
</Parameters>
<Docs>
- <param name="appLinkUri">To be added.</param>
- <summary>To be added.</summary>
- <remarks>To be added.</remarks>
+ <param name="appLinkUri">The <see cref="T:System.Uri" /> that represents the link to remove from the app index.</param>
+ <summary>Removes the provided application link from the application index.</summary>
+ <remarks>This method has no effect on the Android platform.</remarks>
+ <related type="article" href="https://developer.xamarin.com/guides/xamarin-forms/working-with/deep-linking/">Application Indexing and Deep Linking</related>
</Docs>
</Member>
<Member MemberName="DeregisterLink">
@@ -44,9 +46,10 @@
<Parameter Name="appLink" Type="Xamarin.Forms.IAppLinkEntry" />
</Parameters>
<Docs>
- <param name="appLink">To be added.</param>
- <summary>To be added.</summary>
- <remarks>To be added.</remarks>
+ <param name="appLinkUri">The <see cref="T:Xamarin.Forms.IAppLinkEntry" /> to remove from the app index.</param>
+ <summary>Removes the provided application link from the application index.</summary>
+ <remarks>This method has no effect on the Android platform.</remarks>
+ <related type="article" href="https://developer.xamarin.com/guides/xamarin-forms/working-with/deep-linking/">Application Indexing and Deep Linking</related>
</Docs>
</Member>
<Member MemberName="RegisterLink">
@@ -63,9 +66,10 @@
<Parameter Name="appLink" Type="Xamarin.Forms.IAppLinkEntry" />
</Parameters>
<Docs>
- <param name="appLink">To be added.</param>
- <summary>To be added.</summary>
+ <param name="appLink">The <see cref="T:Xamarin.Forms.IAppLinkEntry" /> to add to the app index.</param>
+ <summary>Adds the provided application link to the application index.</summary>
<remarks>To be added.</remarks>
+ <related type="article" href="https://developer.xamarin.com/guides/xamarin-forms/working-with/deep-linking/">Application Indexing and Deep Linking</related>
</Docs>
</Member>
</Members>