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

Commit

Permalink
Name Alignment for BrowserLaunchMode (#408)
Browse files Browse the repository at this point in the history
* Rename BrowserLaunchType to BrowserLaunchMode

* update nuget

* Rename parameter
  • Loading branch information
jamesmontemagno authored and Redth committed Jul 25, 2018
1 parent 7c85f9c commit 6603686
Show file tree
Hide file tree
Showing 16 changed files with 67 additions and 66 deletions.
2 changes: 1 addition & 1 deletion Samples/Samples/View/BrowserPage.xaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

<Label Text="Browser Launch Type:" />
<Picker HorizontalOptions="FillAndExpand"
ItemsSource="{Binding BrowserLaunchTypes}"
ItemsSource="{Binding BrowserLaunchModes}"
SelectedIndex="{Binding BrowserType, Mode=TwoWay}" />

<Label Text="{Binding BrowserStatus}" />
Expand Down
6 changes: 3 additions & 3 deletions Samples/Samples/ViewModel/BrowserViewModel.cs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ public class BrowserViewModel : BaseViewModel
{
string browserStatus;
string uri = "http://xamarin.com";
int browserType = (int)BrowserLaunchType.SystemPreferred;
int browserType = (int)BrowserLaunchMode.SystemPreferred;

public BrowserViewModel()
{
Expand All @@ -32,7 +32,7 @@ public string Uri
set => SetProperty(ref uri, value);
}

public List<string> BrowserLaunchTypes { get; } =
public List<string> BrowserLaunchModes { get; } =
new List<string>
{
$"Use Default Browser App",
Expand All @@ -53,7 +53,7 @@ async void OpenUri()
IsBusy = true;
try
{
await Browser.OpenAsync(uri, (BrowserLaunchType)BrowserType);
await Browser.OpenAsync(uri, (BrowserLaunchMode)BrowserType);
}
catch (Exception e)
{
Expand Down
4 changes: 2 additions & 2 deletions Tests/Browser_Tests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ public async Task Open_Uri_String_NetStandard() =>

[Fact]
public async Task Open_Uri_String_Launch_NetStandard() =>
await Assert.ThrowsAsync<NotImplementedInReferenceAssemblyException>(() => Browser.OpenAsync("http://xamarin.com", BrowserLaunchType.SystemPreferred));
await Assert.ThrowsAsync<NotImplementedInReferenceAssemblyException>(() => Browser.OpenAsync("http://xamarin.com", BrowserLaunchMode.SystemPreferred));

[Fact]
public async Task Open_Uri_NetStandard() =>
await Assert.ThrowsAsync<NotImplementedInReferenceAssemblyException>(() => Browser.OpenAsync(new Uri("http://xamarin.com")));

[Fact]
public async Task Open_Uri_Launch_NetStandard() =>
await Assert.ThrowsAsync<NotImplementedInReferenceAssemblyException>(() => Browser.OpenAsync(new Uri("http://xamarin.com"), BrowserLaunchType.SystemPreferred));
await Assert.ThrowsAsync<NotImplementedInReferenceAssemblyException>(() => Browser.OpenAsync(new Uri("http://xamarin.com"), BrowserLaunchMode.SystemPreferred));

[Theory]
[InlineData("https://xamarin.com", "https://xamarin.com")]
Expand Down
8 changes: 4 additions & 4 deletions Xamarin.Essentials/Browser/Browser.android.cs
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,21 @@ namespace Xamarin.Essentials
{
public static partial class Browser
{
static Task PlatformOpenAsync(Uri uri, BrowserLaunchType launchType)
static Task PlatformOpenAsync(Uri uri, BrowserLaunchMode launchMode)
{
var nativeUri = AndroidUri.Parse(uri.AbsoluteUri);

switch (launchType)
switch (launchMode)
{
case BrowserLaunchType.SystemPreferred:
case BrowserLaunchMode.SystemPreferred:
var tabsBuilder = new CustomTabsIntent.Builder();
tabsBuilder.SetShowTitle(true);
var tabsIntent = tabsBuilder.Build();
tabsIntent.Intent.SetFlags(ActivityFlags.ClearTop);
tabsIntent.Intent.SetFlags(ActivityFlags.NewTask);
tabsIntent.LaunchUrl(Platform.AppContext, nativeUri);
break;
case BrowserLaunchType.External:
case BrowserLaunchMode.External:
var intent = new Intent(Intent.ActionView, nativeUri);
intent.SetFlags(ActivityFlags.ClearTop);
intent.SetFlags(ActivityFlags.NewTask);
Expand Down
8 changes: 4 additions & 4 deletions Xamarin.Essentials/Browser/Browser.ios.cs
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ namespace Xamarin.Essentials
{
public static partial class Browser
{
static Task PlatformOpenAsync(Uri uri, BrowserLaunchType launchType)
static Task PlatformOpenAsync(Uri uri, BrowserLaunchMode launchMode)
{
var nativeUrl = new NSUrl(uri.AbsoluteUri);

switch (launchType)
switch (launchMode)
{
case BrowserLaunchType.SystemPreferred:
case BrowserLaunchMode.SystemPreferred:
var sfViewController = new SFSafariViewController(nativeUrl, false);
var vc = Platform.GetCurrentViewController();

Expand All @@ -23,7 +23,7 @@ static Task PlatformOpenAsync(Uri uri, BrowserLaunchType launchType)
}
vc.PresentViewController(sfViewController, true, null);
break;
case BrowserLaunchType.External:
case BrowserLaunchMode.External:
UIKit.UIApplication.SharedApplication.OpenUrl(nativeUrl);
break;
}
Expand Down
2 changes: 1 addition & 1 deletion Xamarin.Essentials/Browser/Browser.netstandard.cs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ namespace Xamarin.Essentials
{
public static partial class Browser
{
static Task PlatformOpenAsync(Uri uri, BrowserLaunchType launchType) =>
static Task PlatformOpenAsync(Uri uri, BrowserLaunchMode launchMode) =>
throw new NotImplementedInReferenceAssemblyException();
}
}
14 changes: 7 additions & 7 deletions Xamarin.Essentials/Browser/Browser.shared.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,23 @@ namespace Xamarin.Essentials
public static partial class Browser
{
public static Task OpenAsync(string uri) =>
OpenAsync(uri, BrowserLaunchType.SystemPreferred);
OpenAsync(uri, BrowserLaunchMode.SystemPreferred);

public static Task OpenAsync(string uri, BrowserLaunchType launchType)
public static Task OpenAsync(string uri, BrowserLaunchMode launchMode)
{
if (string.IsNullOrWhiteSpace(uri))
{
throw new ArgumentNullException(nameof(uri), $"Uri cannot be empty.");
}

return OpenAsync(new Uri(uri), launchType);
return OpenAsync(new Uri(uri), launchMode);
}

public static Task OpenAsync(Uri uri) =>
OpenAsync(uri, BrowserLaunchType.SystemPreferred);
OpenAsync(uri, BrowserLaunchMode.SystemPreferred);

public static Task OpenAsync(Uri uri, BrowserLaunchType launchType) =>
PlatformOpenAsync(EscapeUri(uri), launchType);
public static Task OpenAsync(Uri uri, BrowserLaunchMode launchMode) =>
PlatformOpenAsync(EscapeUri(uri), launchMode);

internal static Uri EscapeUri(Uri uri)
{
Expand All @@ -35,7 +35,7 @@ internal static Uri EscapeUri(Uri uri)
}
}

public enum BrowserLaunchType
public enum BrowserLaunchMode
{
External,
SystemPreferred
Expand Down
2 changes: 1 addition & 1 deletion Xamarin.Essentials/Browser/Browser.uwp.cs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ namespace Xamarin.Essentials
{
public static partial class Browser
{
static Task PlatformOpenAsync(Uri uri, BrowserLaunchType launchType) =>
static Task PlatformOpenAsync(Uri uri, BrowserLaunchMode launchType) =>
Windows.System.Launcher.LaunchUriAsync(uri).AsTask();
}
}
10 changes: 5 additions & 5 deletions docs/en/FrameworksIndex/xamarin-essentials-android.xml
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,13 @@
</Type>
<Type Name="Xamarin.Essentials.Browser" Id="T:Xamarin.Essentials.Browser">
<Member Id="M:Xamarin.Essentials.Browser.OpenAsync(System.String)" />
<Member Id="M:Xamarin.Essentials.Browser.OpenAsync(System.String,Xamarin.Essentials.BrowserLaunchType)" />
<Member Id="M:Xamarin.Essentials.Browser.OpenAsync(System.String,Xamarin.Essentials.BrowserLaunchMode)" />
<Member Id="M:Xamarin.Essentials.Browser.OpenAsync(System.Uri)" />
<Member Id="M:Xamarin.Essentials.Browser.OpenAsync(System.Uri,Xamarin.Essentials.BrowserLaunchType)" />
<Member Id="M:Xamarin.Essentials.Browser.OpenAsync(System.Uri,Xamarin.Essentials.BrowserLaunchMode)" />
</Type>
<Type Name="Xamarin.Essentials.BrowserLaunchType" Id="T:Xamarin.Essentials.BrowserLaunchType">
<Member Id="F:Xamarin.Essentials.BrowserLaunchType.External" />
<Member Id="F:Xamarin.Essentials.BrowserLaunchType.SystemPreferred" />
<Type Name="Xamarin.Essentials.BrowserLaunchMode" Id="T:Xamarin.Essentials.BrowserLaunchMode">
<Member Id="F:Xamarin.Essentials.BrowserLaunchMode.External" />
<Member Id="F:Xamarin.Essentials.BrowserLaunchMode.SystemPreferred" />
</Type>
<Type Name="Xamarin.Essentials.Clipboard" Id="T:Xamarin.Essentials.Clipboard">
<Member Id="M:Xamarin.Essentials.Clipboard.GetTextAsync" />
Expand Down
10 changes: 5 additions & 5 deletions docs/en/FrameworksIndex/xamarin-essentials-ios.xml
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,13 @@
</Type>
<Type Name="Xamarin.Essentials.Browser" Id="T:Xamarin.Essentials.Browser">
<Member Id="M:Xamarin.Essentials.Browser.OpenAsync(System.String)" />
<Member Id="M:Xamarin.Essentials.Browser.OpenAsync(System.String,Xamarin.Essentials.BrowserLaunchType)" />
<Member Id="M:Xamarin.Essentials.Browser.OpenAsync(System.String,Xamarin.Essentials.BrowserLaunchMode)" />
<Member Id="M:Xamarin.Essentials.Browser.OpenAsync(System.Uri)" />
<Member Id="M:Xamarin.Essentials.Browser.OpenAsync(System.Uri,Xamarin.Essentials.BrowserLaunchType)" />
<Member Id="M:Xamarin.Essentials.Browser.OpenAsync(System.Uri,Xamarin.Essentials.BrowserLaunchMode)" />
</Type>
<Type Name="Xamarin.Essentials.BrowserLaunchType" Id="T:Xamarin.Essentials.BrowserLaunchType">
<Member Id="F:Xamarin.Essentials.BrowserLaunchType.External" />
<Member Id="F:Xamarin.Essentials.BrowserLaunchType.SystemPreferred" />
<Type Name="Xamarin.Essentials.BrowserLaunchMode" Id="T:Xamarin.Essentials.BrowserLaunchMode">
<Member Id="F:Xamarin.Essentials.BrowserLaunchMode.External" />
<Member Id="F:Xamarin.Essentials.BrowserLaunchMode.SystemPreferred" />
</Type>
<Type Name="Xamarin.Essentials.Clipboard" Id="T:Xamarin.Essentials.Clipboard">
<Member Id="M:Xamarin.Essentials.Clipboard.GetTextAsync" />
Expand Down
10 changes: 5 additions & 5 deletions docs/en/FrameworksIndex/xamarin-essentials-uwp.xml
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,13 @@
</Type>
<Type Name="Xamarin.Essentials.Browser" Id="T:Xamarin.Essentials.Browser">
<Member Id="M:Xamarin.Essentials.Browser.OpenAsync(System.String)" />
<Member Id="M:Xamarin.Essentials.Browser.OpenAsync(System.String,Xamarin.Essentials.BrowserLaunchType)" />
<Member Id="M:Xamarin.Essentials.Browser.OpenAsync(System.String,Xamarin.Essentials.BrowserLaunchMode)" />
<Member Id="M:Xamarin.Essentials.Browser.OpenAsync(System.Uri)" />
<Member Id="M:Xamarin.Essentials.Browser.OpenAsync(System.Uri,Xamarin.Essentials.BrowserLaunchType)" />
<Member Id="M:Xamarin.Essentials.Browser.OpenAsync(System.Uri,Xamarin.Essentials.BrowserLaunchMode)" />
</Type>
<Type Name="Xamarin.Essentials.BrowserLaunchType" Id="T:Xamarin.Essentials.BrowserLaunchType">
<Member Id="F:Xamarin.Essentials.BrowserLaunchType.External" />
<Member Id="F:Xamarin.Essentials.BrowserLaunchType.SystemPreferred" />
<Type Name="Xamarin.Essentials.BrowserLaunchMode" Id="T:Xamarin.Essentials.BrowserLaunchMode">
<Member Id="F:Xamarin.Essentials.BrowserLaunchMode.External" />
<Member Id="F:Xamarin.Essentials.BrowserLaunchMode.SystemPreferred" />
</Type>
<Type Name="Xamarin.Essentials.Clipboard" Id="T:Xamarin.Essentials.Clipboard">
<Member Id="M:Xamarin.Essentials.Clipboard.GetTextAsync" />
Expand Down
10 changes: 5 additions & 5 deletions docs/en/FrameworksIndex/xamarin-essentials.xml
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,13 @@
</Type>
<Type Name="Xamarin.Essentials.Browser" Id="T:Xamarin.Essentials.Browser">
<Member Id="M:Xamarin.Essentials.Browser.OpenAsync(System.String)" />
<Member Id="M:Xamarin.Essentials.Browser.OpenAsync(System.String,Xamarin.Essentials.BrowserLaunchType)" />
<Member Id="M:Xamarin.Essentials.Browser.OpenAsync(System.String,Xamarin.Essentials.BrowserLaunchMode)" />
<Member Id="M:Xamarin.Essentials.Browser.OpenAsync(System.Uri)" />
<Member Id="M:Xamarin.Essentials.Browser.OpenAsync(System.Uri,Xamarin.Essentials.BrowserLaunchType)" />
<Member Id="M:Xamarin.Essentials.Browser.OpenAsync(System.Uri,Xamarin.Essentials.BrowserLaunchMode)" />
</Type>
<Type Name="Xamarin.Essentials.BrowserLaunchType" Id="T:Xamarin.Essentials.BrowserLaunchType">
<Member Id="F:Xamarin.Essentials.BrowserLaunchType.External" />
<Member Id="F:Xamarin.Essentials.BrowserLaunchType.SystemPreferred" />
<Type Name="Xamarin.Essentials.BrowserLaunchMode" Id="T:Xamarin.Essentials.BrowserLaunchMode">
<Member Id="F:Xamarin.Essentials.BrowserLaunchMode.External" />
<Member Id="F:Xamarin.Essentials.BrowserLaunchMode.SystemPreferred" />
</Type>
<Type Name="Xamarin.Essentials.Clipboard" Id="T:Xamarin.Essentials.Clipboard">
<Member Id="M:Xamarin.Essentials.Clipboard.GetTextAsync" />
Expand Down
20 changes: 10 additions & 10 deletions docs/en/Xamarin.Essentials/Browser.xml
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,9 @@
</Docs>
</Member>
<Member MemberName="OpenAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task OpenAsync (string uri, Xamarin.Essentials.BrowserLaunchType launchType);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task OpenAsync(string uri, valuetype Xamarin.Essentials.BrowserLaunchType launchType) cil managed" />
<MemberSignature Language="DocId" Value="M:Xamarin.Essentials.Browser.OpenAsync(System.String,Xamarin.Essentials.BrowserLaunchType)" />
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task OpenAsync (string uri, Xamarin.Essentials.BrowserLaunchMode launchMode);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task OpenAsync(string uri, valuetype Xamarin.Essentials.BrowserLaunchMode launchMode) cil managed" />
<MemberSignature Language="DocId" Value="M:Xamarin.Essentials.Browser.OpenAsync(System.String,Xamarin.Essentials.BrowserLaunchMode)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
Expand All @@ -77,11 +77,11 @@
</ReturnValue>
<Parameters>
<Parameter Name="uri" Type="System.String" Index="0" />
<Parameter Name="launchType" Type="Xamarin.Essentials.BrowserLaunchType" Index="1" />
<Parameter Name="launchMode" Type="Xamarin.Essentials.BrowserLaunchMode" Index="1" />
</Parameters>
<Docs>
<param name="uri">Uri to launch.</param>
<param name="launchType">How to launch the browser.</param>
<param name="launchMode">How to launch the browser.</param>
<summary>Open the browser to specified uri.</summary>
<returns>Completed task when browser is launched.</returns>
<remarks>
Expand All @@ -90,9 +90,9 @@
</Docs>
</Member>
<Member MemberName="OpenAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task OpenAsync (Uri uri, Xamarin.Essentials.BrowserLaunchType launchType);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task OpenAsync(class System.Uri uri, valuetype Xamarin.Essentials.BrowserLaunchType launchType) cil managed" />
<MemberSignature Language="DocId" Value="M:Xamarin.Essentials.Browser.OpenAsync(System.Uri,Xamarin.Essentials.BrowserLaunchType)" />
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task OpenAsync (Uri uri, Xamarin.Essentials.BrowserLaunchMode launchMode);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task OpenAsync(class System.Uri uri, valuetype Xamarin.Essentials.BrowserLaunchMode launchMode) cil managed" />
<MemberSignature Language="DocId" Value="M:Xamarin.Essentials.Browser.OpenAsync(System.Uri,Xamarin.Essentials.BrowserLaunchMode)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
Expand All @@ -103,11 +103,11 @@
</ReturnValue>
<Parameters>
<Parameter Name="uri" Type="System.Uri" />
<Parameter Name="launchType" Type="Xamarin.Essentials.BrowserLaunchType" />
<Parameter Name="launchMode" Type="Xamarin.Essentials.BrowserLaunchMode" />
</Parameters>
<Docs>
<param name="uri">Uri to launch.</param>
<param name="launchType">How to launch the browser.</param>
<param name="launchMode">How to launch the browser.</param>
<summary>Open the browser to specified uri.</summary>
<returns>Completed task when browser is launched.</returns>
<remarks>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<Type Name="BrowserLaunchType" FullName="Xamarin.Essentials.BrowserLaunchType">
<TypeSignature Language="C#" Value="public enum BrowserLaunchType" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed BrowserLaunchType extends System.Enum" />
<TypeSignature Language="DocId" Value="T:Xamarin.Essentials.BrowserLaunchType" />
<Type Name="BrowserLaunchMode" FullName="Xamarin.Essentials.BrowserLaunchMode">
<TypeSignature Language="C#" Value="public enum BrowserLaunchMode" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed BrowserLaunchMode extends System.Enum" />
<TypeSignature Language="DocId" Value="T:Xamarin.Essentials.BrowserLaunchMode" />
<AssemblyInfo>
<AssemblyName>Xamarin.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
Expand All @@ -16,15 +16,15 @@
<Members>
<Member MemberName="External">
<MemberSignature Language="C#" Value="External" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Xamarin.Essentials.BrowserLaunchType External = int32(0)" />
<MemberSignature Language="DocId" Value="F:Xamarin.Essentials.BrowserLaunchType.External" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Xamarin.Essentials.BrowserLaunchMode External = int32(0)" />
<MemberSignature Language="DocId" Value="F:Xamarin.Essentials.BrowserLaunchMode.External" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.Essentials</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Xamarin.Essentials.BrowserLaunchType</ReturnType>
<ReturnType>Xamarin.Essentials.BrowserLaunchMode</ReturnType>
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
Expand All @@ -33,15 +33,15 @@
</Member>
<Member MemberName="SystemPreferred">
<MemberSignature Language="C#" Value="SystemPreferred" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Xamarin.Essentials.BrowserLaunchType SystemPreferred = int32(1)" />
<MemberSignature Language="DocId" Value="F:Xamarin.Essentials.BrowserLaunchType.SystemPreferred" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Xamarin.Essentials.BrowserLaunchMode SystemPreferred = int32(1)" />
<MemberSignature Language="DocId" Value="F:Xamarin.Essentials.BrowserLaunchMode.SystemPreferred" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.Essentials</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Xamarin.Essentials.BrowserLaunchType</ReturnType>
<ReturnType>Xamarin.Essentials.BrowserLaunchMode</ReturnType>
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
Expand Down
2 changes: 1 addition & 1 deletion docs/en/index.xml
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
<Type Name="BatteryPowerSource" Kind="Enumeration" />
<Type Name="BatteryState" Kind="Enumeration" />
<Type Name="Browser" Kind="Class" />
<Type Name="BrowserLaunchType" Kind="Enumeration" />
<Type Name="BrowserLaunchMode" Kind="Enumeration" />
<Type Name="Clipboard" Kind="Class" />
<Type Name="Compass" Kind="Class" />
<Type Name="CompassChangedEventArgs" Kind="Class" />
Expand Down
Loading

0 comments on commit 6603686

Please sign in to comment.