Create and save a map as an ArcGIS PortalItem
(i.e. web map).
Use case
Maps can be created programmatically in code and then serialized and saved as an ArcGIS web map
. A web map
can be shared with others and opened in various applications and APIs throughout the platform, such as ArcGIS Pro, ArcGIS Online, the JavaScript API, Collector, and Explorer.
How to use the sample
- Select the basemap and layers you'd like to add to your map.
- Press the Save button.
- Sign into an ArcGIS Online account.
- Provide a title, tags, and description.
- Save the map.
How it works
- A
Map
is created with aBasemap
and a few operational layers. - A
Portal
object is created and loaded. This will issue an authentication challenge, prompting the user to provide credentials. - Once the user is authenticated,
map.SaveAsAsync
is called and a newMap
is saved with the specified title, tags, and folder.
Relevant API
- AuthenticationManager
- ChallengeHandler
- GenerateCredentialAsync
- IOAuthAuthorizeHandler
- Map
- Map.SaveAsAsync
- Portal
Tags
ArcGIS Online, OAuth, portal, publish, share, web map
Sample Code
// Copyright 2021 Esri.
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
// You may obtain a copy of the License at: http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific
// language governing permissions and limitations under the License.
using Esri.ArcGISRuntime.Security;
using System;
using System.Threading.Tasks;
using Xamarin.Forms;
#if __ANDROID__ || __IOS__
using Xamarin.Essentials;
using System.Collections.Generic;
#endif
#if __ANDROID__
using Android.App;
using Application = Xamarin.Forms.Application;
using Android.Content;
using Android.Content.PM;
#endif
namespace Forms.Helpers
{
internal static class ArcGISLoginPrompt
{
private const string ArcGISOnlineUrl = "https://www.arcgis.com/sharing/rest";
// - The Client ID for an app registered with the server (the ID below is for a public app created by the ArcGIS Runtime team).
public const string AppClientId = @"6wMAmbUEX1rvsOb4";
// - An optional client secret for the app (only needed for the OAuthClientCredentials authorization type).
private const string ClientSecret = "";
// - A URL for redirecting after a successful authorization (this must be a URL configured with the app).
private const string OAuthRedirectUrl = @"forms-samples-app://auth";
public static async Task<bool> EnsureAGOLCredentialAsync()
{
bool loggedIn = false;
try
{
// Create a challenge request for portal credentials (OAuth credential request for arcgis.com)
CredentialRequestInfo challengeRequest = new CredentialRequestInfo
{
// Use the OAuth authorization code workflow.
GenerateTokenOptions = new GenerateTokenOptions
{
TokenAuthenticationType = TokenAuthenticationType.OAuthAuthorizationCode
},
// Indicate the url (portal) to authenticate with (ArcGIS Online)
ServiceUri = new Uri(ArcGISOnlineUrl)
};
// Call GetCredentialAsync on the AuthenticationManager to invoke the challenge handler
Credential cred = await AuthenticationManager.Current.GetCredentialAsync(challengeRequest, false);
loggedIn = cred != null;
}
catch (OperationCanceledException)
{
// OAuth login was canceled, no need to display error to user.
}
catch (Exception ex)
{
await Application.Current.MainPage.DisplayAlert("Login failed", ex.Message, "OK");
}
return loggedIn;
}
public static void SetChallengeHandler()
{
// Define the server information for ArcGIS Online
ServerInfo portalServerInfo = new ServerInfo(new Uri(ArcGISOnlineUrl))
{
TokenAuthenticationType = TokenAuthenticationType.OAuthAuthorizationCode,
OAuthClientInfo = new OAuthClientInfo(AppClientId, new Uri(OAuthRedirectUrl))
};
// If a client secret has been configured, set the authentication type to OAuth client credentials.
if (!string.IsNullOrEmpty(ClientSecret))
{
// If a client secret is specified then use the TokenAuthenticationType.OAuthClientCredentials type.
portalServerInfo.TokenAuthenticationType = TokenAuthenticationType.OAuthClientCredentials;
portalServerInfo.OAuthClientInfo.ClientSecret = ClientSecret;
}
// Register this server with AuthenticationManager.
AuthenticationManager.Current.RegisterServer(portalServerInfo);
// Use a function in this class to challenge for credentials.
AuthenticationManager.Current.ChallengeHandler = new ChallengeHandler(PromptCredentialAsync);
// Set the OAuthAuthorizeHandler component (this class) for Android or iOS platforms.
#if __ANDROID__ || __IOS__
AuthenticationManager.Current.OAuthAuthorizeHandler = new OAuthAuthorize();
#endif
}
// ChallengeHandler function that will be called whenever access to a secured resource is attempted.
public static async Task<Credential> PromptCredentialAsync(CredentialRequestInfo info)
{
Credential credential = null;
try
{
// IOAuthAuthorizeHandler will challenge the user for OAuth credentials.
credential = await AuthenticationManager.Current.GenerateCredentialAsync(info.ServiceUri);
}
// OAuth login was canceled, no need to display error to user.
catch (TaskCanceledException) { }
catch (OperationCanceledException) { }
return credential;
}
}
#region IOAuthAuthorizationHandler implementation
#if __ANDROID__ || __IOS__
public class OAuthAuthorize : IOAuthAuthorizeHandler
{
// Use a TaskCompletionSource to track the completion of the authorization.
private TaskCompletionSource<IDictionary<string, string>> _taskCompletionSource;
// IOAuthAuthorizeHandler.AuthorizeAsync implementation.
public async Task<IDictionary<string, string>> AuthorizeAsync(Uri serviceUri, Uri authorizeUri, Uri callbackUri)
{
try
{
_taskCompletionSource = new TaskCompletionSource<IDictionary<string, string>>();
#if __IOS__
Device.BeginInvokeOnMainThread(async () =>
{
#endif
try
{
var result = await WebAuthenticator.AuthenticateAsync(authorizeUri, callbackUri);
_taskCompletionSource.SetResult(result.Properties);
}
catch (Exception ex)
{
_taskCompletionSource.TrySetException(ex);
}
#if __IOS__
});
#endif
return await _taskCompletionSource.Task;
}
catch (Exception) { }
return null;
}
}
#endif
#if __ANDROID__
[Activity(NoHistory = true, Exported = true, LaunchMode = LaunchMode.SingleTop)]
[IntentFilter(new[] { Intent.ActionView },
Categories = new[] { Intent.CategoryDefault, Intent.CategoryBrowsable },
DataScheme = "forms-samples-app", DataHost = "auth")]
public class WebAuthenticationCallbackActivity : WebAuthenticatorCallbackActivity
{
}
#endif
#endregion IOAuthAuthorizationHandler implementation
}