Method CreateAsync

CreateAsync()

Creates asynchronously a new instance of the ArcGISPortal class that represents ArcGIS Online (i.e https://www.arcgis.com as Portal Uri).

Declaration

public static Task<ArcGISPortal> CreateAsync()

Returns

Type	Description
System.Threading.Tasks.Task<ArcGISPortal>	The task object representing the asynchronous create operation. The value of the task result is a ArcGISPortal object.

Applies to

Platforms and versions

Target	Versions
.NET Standard 2.0	100.3 - 200.8
.NET	100.13 - 200.8
.NET Windows	100.13 - 200.8
.NET Android	200.0 - 200.8
.NET iOS	200.0 - 200.8
.NET Framework	100.0 - 200.8
Xamarin.Android	100.0 - 100.15
Xamarin.iOS	100.0 - 100.15
UWP	100.0 - 200.8

Relevant samples

Display KML: Display KML from a URL, portal item, or local KML file.

CreateAsync(CancellationToken)

Creates asynchronously a new instance of the ArcGISPortal class that represents ArcGIS Online (i.e https://www.arcgis.com as Portal Uri).

Declaration

public static Task<ArcGISPortal> CreateAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	A System.Threading.CancellationToken with which to cancel the operation if required.

Returns

Type	Description
System.Threading.Tasks.Task<ArcGISPortal>	The task object representing the asynchronous create operation. The value of the task result is a ArcGISPortal object.

Applies to

Platforms and versions

Target	Versions
.NET Standard 2.0	100.3 - 200.8
.NET	100.13 - 200.8
.NET Windows	100.13 - 200.8
.NET Android	200.2 - 200.8
.NET iOS	200.0 - 200.8
.NET Framework	100.0 - 200.8
Xamarin.Android	100.0 - 100.14
Xamarin.iOS	100.0 - 100.15
UWP	100.0 - 200.8

Relevant samples

Access load status: Determine the map's load status which can be `NotLoaded`, `FailedToLoad`, `Loading`, `Loaded`.

Add an integrated mesh layer: View an integrated mesh layer from a scene service.

Add ENC exchange set: Display nautical charts per the ENC specification.

Add features: Add features to a feature layer.

CreateAsync(Uri)

Creates asynchronously a new instance of the ArcGISPortal class from the specified portal Uri.

Declaration

public static Task<ArcGISPortal> CreateAsync(Uri portalUri)

Parameters

Type	Name	Description
System.Uri	portalUri	The portal URI.

Returns

Type	Description
System.Threading.Tasks.Task<ArcGISPortal>	The task object representing the asynchronous create operation. The value of the task result is a ArcGISPortal object.

Remarks

If the URI is null, ArcGIS Online is used by default (https://www.arcgis.com). Access is to the portal resources is anonymous.

The supported URL formats are:

• The URL of the portal (Example: http://www.arcgis.com).
• The URL of the portal REST endpoint (Example: http://www.arcgis.com/sharing/rest).
• The URL of the deprecated portal REST endpoint (Example: http://www.arcgis.com/sharing).

Applies to

Platforms and versions

Target	Versions
.NET Standard 2.0	100.3 - 200.8
.NET	100.13 - 200.8
.NET Windows	100.13 - 200.8
.NET Android	200.2 - 200.8
.NET iOS	200.0 - 200.8
.NET Framework	100.0 - 200.8
Xamarin.Android	100.0 - 100.14
Xamarin.iOS	100.0 - 100.15
UWP	100.0 - 200.8

Relevant samples

Map reference scale: Set the map's reference scale and which feature layers should honor the reference scale.

CreateAsync(Uri, CancellationToken)

Creates asynchronously a new instance of the ArcGISPortal class from the specified portal Uri. If the URI is null, ArcGIS Online is used by default (https://www.arcgis.com).

Declaration

public static Task<ArcGISPortal> CreateAsync(Uri portalUri, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Uri	portalUri	The portal URI.
System.Threading.CancellationToken	cancellationToken	A System.Threading.CancellationToken with which to cancel the operation if required.

Returns

Type	Description
System.Threading.Tasks.Task<ArcGISPortal>	The task object representing the asynchronous create operation. The value of the task result is a ArcGISPortal object.

Remarks

Use this method to create a portal from a URI and a cancellation token.

The supported URL formats are:

• The URL of the portal (Example: http://www.arcgis.com).
• The URL of the portal rest end point (Example: http://www.arcgis.com/sharing/rest).
• The URL of the deprecated portal rest end point (Example: http://www.arcgis.com/sharing).

Applies to

Platforms and versions

Target	Versions
.NET Standard 2.0	100.3 - 200.8
.NET	100.13 - 200.8
.NET Windows	100.13 - 200.8
.NET Android	200.2 - 200.8
.NET iOS	200.0 - 200.8
.NET Framework	100.0 - 200.8
Xamarin.Android	100.0 - 100.14
Xamarin.iOS	100.0 - 100.15
UWP	100.0 - 200.8

CreateAsync(Uri, CultureInfo)

Creates asynchronously a new instance of the ArcGISPortal class from the specified portal Uri. If the URI is null, ArcGIS Online is used by default (https://www.arcgis.com).

Declaration

public static Task<ArcGISPortal> CreateAsync(Uri portalUri, CultureInfo culture)

Parameters

Type	Name	Description
System.Uri	portalUri	The portal URI.
System.Globalization.CultureInfo	culture	The culture for the portal.

Returns

Type	Description
System.Threading.Tasks.Task<ArcGISPortal>	The task object representing the asynchronous create operation. The value of the task result is a ArcGISPortal object.

Remarks

Use this method to create a portal from a URI and an ArcGIS portal culture.

The supported URL formats are:

• The URL of the portal (Example: http://www.arcgis.com).
• The URL of the portal rest end point (Example: http://www.arcgis.com/sharing/rest).
• The URL of the deprecated portal rest end point (Example: http://www.arcgis.com/sharing).

Applies to

Platforms and versions

Target	Versions
.NET Standard 2.0	100.3 - 200.8
.NET	100.13 - 200.8
.NET Windows	100.13 - 200.8
.NET Android	200.2 - 200.8
.NET iOS	200.0 - 200.8
.NET Framework	100.0 - 200.8
Xamarin.Android	100.0 - 100.14
Xamarin.iOS	100.0 - 100.15
UWP	100.0 - 200.8

CreateAsync(Uri, CultureInfo, CancellationToken)

Creates asynchronously a new instance of the ArcGISPortal class from the specified portal Uri. If the URI is null, ArcGIS Online is used by default (https://www.arcgis.com).

Declaration

public static Task<ArcGISPortal> CreateAsync(Uri portalUri, CultureInfo culture, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Uri	portalUri	The portal URI.
System.Globalization.CultureInfo	culture	The culture for the portal.
System.Threading.CancellationToken	cancellationToken	A System.Threading.CancellationToken with which to cancel the operation if required.

Returns

Type	Description
System.Threading.Tasks.Task<ArcGISPortal>	The task object representing the asynchronous create operation. The value of the task result is a ArcGISPortal object.

Remarks

Use this method to create a portal from a URI, an ArcGIS portal culture, and a cancellation token.

The supported URL formats are:

• The URL of the portal (Example: http://www.arcgis.com).
• The URL of the portal rest end point (Example: http://www.arcgis.com/sharing/rest).
• The URL of the deprecated portal rest end point (Example: http://www.arcgis.com/sharing).

Applies to

Platforms and versions

Target	Versions
.NET Standard 2.0	100.3 - 200.8
.NET	100.13 - 200.8
.NET Windows	100.13 - 200.8
.NET Android	200.2 - 200.8
.NET iOS	200.0 - 200.8
.NET Framework	100.0 - 200.8
Xamarin.Android	100.0 - 100.14
Xamarin.iOS	100.0 - 100.15
UWP	100.0 - 200.8

CreateAsync(Uri, Boolean)

Creates asynchronously a new instance of the ArcGISPortal class. If the URI is null, ArcGIS Online is used by default (https://www.arcgis.com).

Declaration

public static Task<ArcGISPortal> CreateAsync(Uri portalUri, bool loginRequired)

Parameters

Type	Name	Description
System.Uri	portalUri	The portal URI.
System.Boolean	loginRequired	Login required flag. Use true to require the user to log in to the portal, false allows anonymous access.

Returns

Type	Description
System.Threading.Tasks.Task<ArcGISPortal>	The task object representing the asynchronous create operation. The value of the task result is a ArcGISPortal object.

Remarks

If user credentials are added to AuthenticationManager ahead of time, the portal is created for that user. Otherwise, authentication behavior depends on the loginRequired flag:

• If loginRequired is true, the method first tries any existing credentials, then challenges for new ones (and fails if the challenge handler throws or returns null), guaranteeing a non‐anonymous portal.
• If loginRequired is false, the method attempts an anonymous connection first (if the server allows it) and only prompts for login if anonymous access is not permitted. Stated another way, if false the user must log in only if the portal does not support anonymous access.

The supported URL formats are:

• The URL of the portal (Example: http://www.arcgis.com).
• The URL of the portal rest end point (Example: http://www.arcgis.com/sharing/rest).
• The URL of the deprecated portal rest end point (Example: http://www.arcgis.com/sharing).

Applies to

Platforms and versions

Target	Versions
.NET Standard 2.0	100.3 - 200.8
.NET	100.13 - 200.8
.NET Windows	100.13 - 200.8
.NET Android	200.2 - 200.8
.NET iOS	200.0 - 200.8
.NET Framework	100.2.1 - 200.8
Xamarin.Android	100.2.1 - 100.14
Xamarin.iOS	100.2.1 - 100.15
UWP	100.2.1 - 200.8

CreateAsync(Uri, Boolean, CancellationToken)

Creates asynchronously a new instance of the ArcGISPortal class. If the URI is null, ArcGIS Online is used by default (https://www.arcgis.com).

Declaration

public static Task<ArcGISPortal> CreateAsync(Uri portalUri, bool loginRequired, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Uri	portalUri	The portal URI.
System.Boolean	loginRequired	Login required flag. Use true to force user login, false to only login if required by the portal.
System.Threading.CancellationToken	cancellationToken	A System.Threading.CancellationToken with which to cancel the operation if required.

Returns

Type	Description
System.Threading.Tasks.Task<ArcGISPortal>	The task object representing the asynchronous create operation. The value of the task result is a ArcGISPortal object.

Remarks

If user credentials are added to AuthenticationManager ahead of time, the portal is created for that user. Otherwise, authentication behavior depends on the loginRequired flag:

• If loginRequired is true, the method first tries any existing credentials, then challenges for new ones (and fails if the challenge handler throws or returns null), guaranteeing a non‐anonymous portal.
• If loginRequired is false, the method attempts an anonymous connection first (if the server allows it) and only prompts for login if anonymous access is not permitted.

The supported URL formats are:

• The URL of the portal (Example: http://www.arcgis.com).
• The URL of the portal rest end point (Example: http://www.arcgis.com/sharing/rest).
• The URL of the deprecated portal rest end point (Example: http://www.arcgis.com/sharing).

Applies to

Platforms and versions

Target	Versions
.NET Standard 2.0	100.3 - 200.8
.NET	100.13 - 200.8
.NET Windows	100.13 - 200.8
.NET Android	200.2 - 200.8
.NET iOS	200.0 - 200.8
.NET Framework	100.2.1 - 200.8
Xamarin.Android	100.2.1 - 100.14
Xamarin.iOS	100.2.1 - 100.15
UWP	100.2.1 - 200.8

CreateAsync(Uri, Boolean, CultureInfo)

Creates asynchronously a new instance of the ArcGISPortal class. If the URI is null, ArcGIS Online is used by default (https://www.arcgis.com).

Declaration

public static Task<ArcGISPortal> CreateAsync(Uri portalUri, bool loginRequired, CultureInfo culture)

Parameters

Type	Name	Description
System.Uri	portalUri	The portal URI.
System.Boolean	loginRequired	Login required flag. Use true to force user login, false to only login if required by the portal.
System.Globalization.CultureInfo	culture	The culture for the portal.

Returns

Type	Description
System.Threading.Tasks.Task<ArcGISPortal>	The task object representing the asynchronous create operation. The value of the task result is a ArcGISPortal object.

Remarks

If user credentials are added to AuthenticationManager ahead of time, the portal is created for that user. Otherwise, authentication behavior depends on the loginRequired flag:

• If loginRequired is true, the method first tries any existing credentials, then challenges for new ones (and fails if the challenge handler throws or returns null), guaranteeing a non‐anonymous portal.
• If loginRequired is false, the method attempts an anonymous connection first (if the server allows it) and only prompts for login if anonymous access is not permitted.

The supported URL formats are:

• The URL of the portal (Example: http://www.arcgis.com).
• The URL of the portal rest end point (Example: http://www.arcgis.com/sharing/rest).
• The URL of the deprecated portal rest end point (Example: http://www.arcgis.com/sharing).

Applies to

Platforms and versions

Target	Versions
.NET Standard 2.0	100.3 - 200.8
.NET	100.13 - 200.8
.NET Windows	100.13 - 200.8
.NET Android	200.2 - 200.8
.NET iOS	200.0 - 200.8
.NET Framework	100.2.1 - 200.8
Xamarin.Android	100.2.1 - 100.14
Xamarin.iOS	100.2.1 - 100.15
UWP	100.2.1 - 200.8

CreateAsync(Uri, Boolean, CultureInfo, CancellationToken)

Creates asynchronously a new instance of the ArcGISPortal class. If the URI is null, ArcGIS Online is used by default (https://www.arcgis.com).

Declaration

public static async Task<ArcGISPortal> CreateAsync(Uri portalUri, bool loginRequired, CultureInfo culture, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Uri	portalUri	The portal URI.
System.Boolean	loginRequired	Login required flag. Use true to force user login, false to only login if required by the portal.
System.Globalization.CultureInfo	culture	The culture for the portal.
System.Threading.CancellationToken	cancellationToken	A System.Threading.CancellationToken with which to cancel the operation if required.

Returns

Type	Description
System.Threading.Tasks.Task<ArcGISPortal>	The task object representing the asynchronous create operation. The value of the task result is a ArcGISPortal object.

Remarks

If user credentials are added to AuthenticationManager ahead of time, the portal is created for that user. Otherwise, authentication behavior depends on the loginRequired flag:

• If loginRequired is true, the method first tries any existing credentials, then challenges for new ones (and fails if the challenge handler throws or returns null), guaranteeing a non‐anonymous portal.
• If loginRequired is false, the method attempts an anonymous connection first (if the server allows it) and only prompts for login if anonymous access is not permitted.

The supported URL formats are:

• The URL of the portal (Example: http://www.arcgis.com).
• The URL of the portal rest end point (Example: http://www.arcgis.com/sharing/rest).
• The URL of the deprecated portal rest end point (Example: http://www.arcgis.com/sharing).

Applies to

Platforms and versions

Target	Versions
.NET Standard 2.0	100.3 - 200.8
.NET	100.13 - 200.8
.NET Windows	100.13 - 200.8
.NET Android	200.2 - 200.8
.NET iOS	200.0 - 200.8
.NET Framework	100.2.1 - 200.8
Xamarin.Android	100.2.1 - 100.14
Xamarin.iOS	100.2.1 - 100.15
UWP	100.2.1 - 200.8