dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components
PortalItem Class
An item (a unit of content) in the Portal.
ArcGIS Maps SDK for JavaScript
public class PortalItem : dymaptic.GeoBlazor.Core.Components.MapComponent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 PortalItem
Constructors
PortalItem() Constructor
Parameterless constructor for use as a Razor Component.
public PortalItem();
PortalItem(string, Nullable, string, string, Nullable, IReadOnlyList, Nullable, string, string, Extent, IReadOnlyList, string, Nullable, string, Nullable, Nullable, Nullable, string, string, Portal, IReadOnlyList, Nullable, string, IReadOnlyList, string, IReadOnlyList, string) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public PortalItem(string portalItemId, System.Nullable<dymaptic.GeoBlazor.Core.Enums.PortalItemAccess> access=null, string? accessInformation=null, string? apiKey=null, System.Nullable<double> avgRating=null, System.Collections.Generic.IReadOnlyList<string>? categories=null, System.Nullable<System.DateTime> created=null, string? culture=null, string? description=null, dymaptic.GeoBlazor.Core.Components.Geometries.Extent? extent=null, System.Collections.Generic.IReadOnlyList<string>? groupCategories=null, string? licenseInfo=null, System.Nullable<System.DateTime> modified=null, string? name=null, System.Nullable<double> numComments=null, System.Nullable<double> numRatings=null, System.Nullable<double> numViews=null, string? owner=null, string? ownerFolder=null, dymaptic.GeoBlazor.Core.Components.Portal? portal=null, System.Collections.Generic.IReadOnlyList<string>? screenshots=null, System.Nullable<long> size=null, string? snippet=null, System.Collections.Generic.IReadOnlyList<string>? tags=null, string? title=null, System.Collections.Generic.IReadOnlyList<string>? typeKeywords=null, string? url=null);
Parameters
portalItemId
System.String
The unique id for the item.
ArcGIS Maps SDK for JavaScript
access
System.Nullable<PortalItemAccess>
Indicates the level of access to this item: private
, shared
, org
, or public
.
ArcGIS Maps SDK for JavaScript
accessInformation
System.String
Information on the source of the item and its copyright status.
ArcGIS Maps SDK for JavaScript
apiKey
System.String
An authorization string used to access the portal item.
ArcGIS Maps SDK for JavaScript
avgRating
System.Nullable<System.Double>
Average rating.
ArcGIS Maps SDK for JavaScript
categories
System.Collections.Generic.IReadOnlyList<System.String>
An array of organization categories that are set on the item.
ArcGIS Maps SDK for JavaScript
created
System.Nullable<System.DateTime>
The date the item was created.
ArcGIS Maps SDK for JavaScript
culture
System.String
The item’s locale information (language and country).
ArcGIS Maps SDK for JavaScript
description
System.String
The detailed description of the item.
ArcGIS Maps SDK for JavaScript
extent
Extent
The geographic extent, or bounding rectangle, of the item.
ArcGIS Maps SDK for JavaScript
groupCategories
System.Collections.Generic.IReadOnlyList<System.String>
An array of group categories set on the item.
ArcGIS Maps SDK for JavaScript
licenseInfo
System.String
Information on license or restrictions related to the item.
ArcGIS Maps SDK for JavaScript
modified
System.Nullable<System.DateTime>
The date the item was last modified.
ArcGIS Maps SDK for JavaScript
name
System.String
The name of the item.
ArcGIS Maps SDK for JavaScript
numComments
System.Nullable<System.Double>
Number of comments on the item.
ArcGIS Maps SDK for JavaScript
numRatings
System.Nullable<System.Double>
Number of ratings on the item.
ArcGIS Maps SDK for JavaScript
numViews
System.Nullable<System.Double>
Number of views on the item.
ArcGIS Maps SDK for JavaScript
owner
System.String
The username of the user who owns this item.
ArcGIS Maps SDK for JavaScript
ownerFolder
System.String
The ID of the folder in which the owner has stored the item.
ArcGIS Maps SDK for JavaScript
portal
Portal
The portal that contains the item.
ArcGIS Maps SDK for JavaScript
screenshots
System.Collections.Generic.IReadOnlyList<System.String>
An array of string URLs.
default null
ArcGIS Maps SDK for JavaScript
size
System.Nullable<System.Int64>
The size of the item (in bytes).
ArcGIS Maps SDK for JavaScript
snippet
System.String
A summary description of the item.
ArcGIS Maps SDK for JavaScript
tags
System.Collections.Generic.IReadOnlyList<System.String>
User defined tags that describe the item.
ArcGIS Maps SDK for JavaScript
title
System.String
The title for the item.
ArcGIS Maps SDK for JavaScript
typeKeywords
System.Collections.Generic.IReadOnlyList<System.String>
Type keywords that describe the type of content of this item.
ArcGIS Maps SDK for JavaScript
url
System.String
The service URL of this item.
ArcGIS Maps SDK for JavaScript
Properties
PortalItem.Access Property
Indicates the level of access to this item: private
, shared
, org
, or public
.
ArcGIS Maps SDK for JavaScript
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.PortalItemAccess> Access { get; set; }
Property Value
System.Nullable<PortalItemAccess>
PortalItem.AccessInformation Property
Information on the source of the item and its copyright status.
ArcGIS Maps SDK for JavaScript
public string? AccessInformation { get; set; }
Property Value
PortalItem.ApiKey Property
An authorization string used to access the portal item. API keys are generated and managed in the ArcGIS Developer Portal. An API key is tied explicitly to an ArcGIS account; it is also used to monitor service usage.
public string? ApiKey { get; set; }
Property Value
PortalItem.ApplicationProxies Property
Contains an array of objects containing proxy information for premium platform services.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Model.PortalItemApplicationProxies>? ApplicationProxies { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<PortalItemApplicationProxies>
PortalItem.AvgRating Property
Average rating.
ArcGIS Maps SDK for JavaScript
public System.Nullable<double> AvgRating { get; set; }
Property Value
System.Nullable<System.Double>
PortalItem.Categories Property
An array of organization categories that are set on the item.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<string>? Categories { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<System.String>
PortalItem.Classification Property
The classification information for the item.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.Dictionary<string,string?>? Classification { get; set; }
Property Value
System.Collections.Generic.Dictionary<System.String,System.String>
PortalItem.Created Property
The date the item was created.
ArcGIS Maps SDK for JavaScript
public System.Nullable<System.DateTime> Created { get; set; }
Property Value
System.Nullable<System.DateTime>
PortalItem.Culture Property
The item’s locale information (language and country).
ArcGIS Maps SDK for JavaScript
public string? Culture { get; set; }
Property Value
PortalItem.Description Property
The detailed description of the item.
ArcGIS Maps SDK for JavaScript
public string? Description { get; set; }
Property Value
PortalItem.ExcludeApiKey Property
For WebMaps and layers that are public and throw an error when given an ApiKey or Token,
this setting allows you to exclude the ApiKey or Token from the WebMap request.
public System.Nullable<bool> ExcludeApiKey { get; set; }
Property Value
System.Nullable<System.Boolean>
PortalItem.Extent Property
The geographic extent, or bounding rectangle, of the item.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.Geometries.Extent? Extent { get; set; }
Property Value
PortalItem.GroupCategories Property
An array of group categories set on the item.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<string>? GroupCategories { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<System.String>
PortalItem.IsLayer Property
Indicates whether a layer can be created from this item using Layer.fromPortalItem().
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> IsLayer { get; set; }
Property Value
System.Nullable<System.Boolean>
PortalItem.IsOrgItem Property
Indicates whether this item and the user whose credential was used to fetch this item belong
to the same ArcGIS Enterprise Portal or ArcGIS Online Organization.
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> IsOrgItem { get; set; }
Property Value
System.Nullable<System.Boolean>
PortalItem.ItemControl Property
Indicates whether an item can be updated and deleted.
ArcGIS Maps SDK for JavaScript
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.ItemControl> ItemControl { get; set; }
Property Value
PortalItem.ItemPageUrl Property
The URL to the Item page on the portal.
ArcGIS Maps SDK for JavaScript
public string? ItemPageUrl { get; set; }
Property Value
PortalItem.ItemUrl Property
The URL to the item.
ArcGIS Maps SDK for JavaScript
public string? ItemUrl { get; set; }
Property Value
PortalItem.LicenseInfo Property
Information on license or restrictions related to the item.
ArcGIS Maps SDK for JavaScript
public string? LicenseInfo { get; set; }
Property Value
PortalItem.Loaded Property
Indicates whether the item’s resources have loaded from the portal.
default false
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> Loaded { get; set; }
Property Value
System.Nullable<System.Boolean>
PortalItem.Modified Property
The date the item was last modified.
ArcGIS Maps SDK for JavaScript
public System.Nullable<System.DateTime> Modified { get; set; }
Property Value
System.Nullable<System.DateTime>
PortalItem.Name Property
The name of the item.
ArcGIS Maps SDK for JavaScript
public string? Name { get; set; }
Property Value
PortalItem.NumComments Property
Number of comments on the item.
ArcGIS Maps SDK for JavaScript
public System.Nullable<double> NumComments { get; set; }
Property Value
System.Nullable<System.Double>
PortalItem.NumRatings Property
Number of ratings on the item.
ArcGIS Maps SDK for JavaScript
public System.Nullable<double> NumRatings { get; set; }
Property Value
System.Nullable<System.Double>
PortalItem.NumViews Property
Number of views on the item.
ArcGIS Maps SDK for JavaScript
public System.Nullable<double> NumViews { get; set; }
Property Value
System.Nullable<System.Double>
PortalItem.Owner Property
The username of the user who owns this item.
ArcGIS Maps SDK for JavaScript
public string? Owner { get; set; }
Property Value
PortalItem.OwnerFolder Property
The ID of the folder in which the owner has stored the item.
ArcGIS Maps SDK for JavaScript
public string? OwnerFolder { get; set; }
Property Value
PortalItem.Portal Property
The portal that contains the item.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.Portal? Portal { get; set; }
Property Value
PortalItem.PortalItemId Property
The unique id for the item.
ArcGIS Maps SDK for JavaScript
public string PortalItemId { get; set; }
Property Value
PortalItem.Screenshots Property
An array of string URLs.
default null
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<string>? Screenshots { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<System.String>
PortalItem.Size Property
The size of the item (in bytes).
ArcGIS Maps SDK for JavaScript
public System.Nullable<long> Size { get; set; }
Property Value
PortalItem.Snippet Property
A summary description of the item.
ArcGIS Maps SDK for JavaScript
public string? Snippet { get; set; }
Property Value
PortalItem.SourceJSON Property
The JSON used to create the property values when the PortalItem
is loaded.
ArcGIS Maps SDK for JavaScript
public string? SourceJSON { get; set; }
Property Value
PortalItem.Tags Property
User defined tags that describe the item.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<string>? Tags { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<System.String>
PortalItem.ThumbnailUrl Property
The URL to the thumbnail used for the item.
ArcGIS Maps SDK for JavaScript
public string? ThumbnailUrl { get; set; }
Property Value
PortalItem.Title Property
The title for the item.
ArcGIS Maps SDK for JavaScript
public string? Title { get; set; }
Property Value
PortalItem.TypeKeywords Property
Type keywords that describe the type of content of this item.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<string>? TypeKeywords { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<System.String>
PortalItem.Url Property
The service URL of this item.
ArcGIS Maps SDK for JavaScript
public string? Url { get; set; }
Property Value
Methods
PortalItem.AddRating(double) Method
Adds a rating to an accessible item.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.PortalRating?> AddRating(double rating);
Parameters
rating
System.Double
Rating to set for the item. Rating must be a number between 1.0 and 5.0.
Returns
System.Threading.Tasks.Task<PortalRating>
PortalItem.AddResource(PortalItemResource, Stream, PortalItemAddResourceOptions, CancellationToken) Method
Adds a new resource to the portal item.
param content The resource content.
param options.access Indicates the level of access to the resource. The default is “inherit” which causes the resource to have the same access level as the owning item.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<string?> AddResource(dymaptic.GeoBlazor.Core.Model.PortalItemResource resource, System.IO.Stream content, dymaptic.GeoBlazor.Core.Options.PortalItemAddResourceOptions options, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));
Parameters
resource
PortalItemResource
The resource to add to the portal item.
content
System.IO.Stream
The resource content.
options
PortalItemAddResourceOptions
An object wih the following properties.
- options.signal: Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named
AbortError
when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.
cancellationToken
System.Threading.CancellationToken
The CancellationToken to cancel an asynchronous operation.
Returns
System.Threading.Tasks.Task<System.String>
PortalItem.AddToCategories(string[]) Method
Asynchronously adds elements to the Categories property.
public System.Threading.Tasks.Task AddToCategories(params string[] values);
Parameters
values
System.String[]
The elements to add.
Returns
PortalItem.AddToGroupCategories(string[]) Method
Asynchronously adds elements to the GroupCategories property.
public System.Threading.Tasks.Task AddToGroupCategories(params string[] values);
Parameters
values
System.String[]
The elements to add.
Returns
PortalItem.AddToScreenshots(string[]) Method
Asynchronously adds elements to the Screenshots property.
public System.Threading.Tasks.Task AddToScreenshots(params string[] values);
Parameters
values
System.String[]
The elements to add.
Returns
PortalItem.AddToTags(string[]) Method
Asynchronously adds elements to the Tags property.
public System.Threading.Tasks.Task AddToTags(params string[] values);
Parameters
values
System.String[]
The elements to add.
Returns
PortalItem.AddToTypeKeywords(string[]) Method
Asynchronously adds elements to the TypeKeywords property.
public System.Threading.Tasks.Task AddToTypeKeywords(params string[] values);
Parameters
values
System.String[]
The elements to add.
Returns
PortalItem.CancelLoad() Method
Cancels a load() operation if it is already in progress.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task CancelLoad();
Returns
PortalItem.DeleteRating() Method
Deletes a rating for the specified item.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<string?> DeleteRating();
Returns
System.Threading.Tasks.Task<System.String>
PortalItem.FetchData(ResponseType, CancellationToken) Method
Requests a PortalItem in the format specified in responseType
.
param options An object with the following properties.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<string?> FetchData(dymaptic.GeoBlazor.Core.Enums.ResponseType responseType, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));
Parameters
responseType
ResponseType
The format of the response.
cancellationToken
System.Threading.CancellationToken
The CancellationToken to cancel an asynchronous operation.
Returns
System.Threading.Tasks.Task<System.String>
PortalItem.FetchRating(CancellationToken) Method
Returns the rating (if any) given to the item.
param options.signal Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError
when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.PortalRating?> FetchRating(System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));
Parameters
cancellationToken
System.Threading.CancellationToken
The CancellationToken to cancel an asynchronous operation.
Returns
System.Threading.Tasks.Task<PortalRating>
PortalItem.FetchRelatedItems(string, RelationshipDirection, CancellationToken) Method
Gets all the related items of a certain relationship type for the portal item.
param params.relationshipType The type of relationship between the two items. See Relationship types for a complete listing of types.
param options An object with the following properties.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.PortalItem[]?> FetchRelatedItems(string relationshipType, dymaptic.GeoBlazor.Core.Enums.RelationshipDirection direction, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));
Parameters
relationshipType
System.String
The type of relationship between the two items.
ArcGIS Maps SDK for JavaScript
direction
RelationshipDirection
The direction of the relationship.
ArcGIS Maps SDK for JavaScript
cancellationToken
System.Threading.CancellationToken
The CancellationToken to cancel an asynchronous operation.
Returns
System.Threading.Tasks.Task<PortalItem[]>
PortalItem.FetchResources(double, double, PortalQuerySortOrder, SortField, CancellationToken) Method
Retrieves references to all the portal item resources.
param options Additional options with the following properties.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Results.FetchResourcesResult?> FetchResources(double num, double start, dymaptic.GeoBlazor.Core.Enums.PortalQuerySortOrder sortOrder, dymaptic.GeoBlazor.Core.Enums.SortField sortField, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));
Parameters
num
System.Double
The maximum number of results to be included in the result set response.
ArcGIS Maps SDK for JavaScript
start
System.Double
The index of the first entry in the result set response.
ArcGIS Maps SDK for JavaScript
sortOrder
PortalQuerySortOrder
The order in which to sort the results.
ArcGIS Maps SDK for JavaScript
sortField
SortField
A field to sort the results.
ArcGIS Maps SDK for JavaScript
cancellationToken
System.Threading.CancellationToken
The CancellationToken to cancel an asynchronous operation.
Returns
System.Threading.Tasks.Task<FetchResourcesResult>
PortalItem.GetAccess() Method
Asynchronously retrieve the current value of the Access property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.PortalItemAccess>> GetAccess();
Returns
System.Threading.Tasks.Task<System.Nullable<PortalItemAccess>>
PortalItem.GetAccessInformation() Method
Asynchronously retrieve the current value of the AccessInformation property.
public System.Threading.Tasks.Task<string?> GetAccessInformation();
Returns
System.Threading.Tasks.Task<System.String>
PortalItem.GetApiKey() Method
Asynchronously retrieve the current value of the ApiKey property.
public System.Threading.Tasks.Task<string?> GetApiKey();
Returns
System.Threading.Tasks.Task<System.String>
PortalItem.GetApplicationProxies() Method
Asynchronously retrieve the current value of the ApplicationProxies property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Model.PortalItemApplicationProxies>?> GetApplicationProxies();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<PortalItemApplicationProxies>>
PortalItem.GetAvgRating() Method
Asynchronously retrieve the current value of the AvgRating property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetAvgRating();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
PortalItem.GetCategories() Method
Asynchronously retrieve the current value of the Categories property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<string>?> GetCategories();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<System.String>>
PortalItem.GetClassification() Method
Asynchronously retrieve the current value of the Classification property.
public System.Threading.Tasks.Task<System.Collections.Generic.Dictionary<string,string?>?> GetClassification();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.Dictionary<System.String,System.String>>
PortalItem.GetCreated() Method
Asynchronously retrieve the current value of the Created property.
public System.Threading.Tasks.Task<System.Nullable<System.DateTime>> GetCreated();
Returns
System.Threading.Tasks.Task<System.Nullable<System.DateTime>>
PortalItem.GetCulture() Method
Asynchronously retrieve the current value of the Culture property.
public System.Threading.Tasks.Task<string?> GetCulture();
Returns
System.Threading.Tasks.Task<System.String>
PortalItem.GetDescription() Method
Asynchronously retrieve the current value of the Description property.
public System.Threading.Tasks.Task<string?> GetDescription();
Returns
System.Threading.Tasks.Task<System.String>
PortalItem.GetExtent() Method
Asynchronously retrieve the current value of the Extent property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Geometries.Extent?> GetExtent();
Returns
System.Threading.Tasks.Task<Extent>
PortalItem.GetGroupCategories() Method
Asynchronously retrieve the current value of the GroupCategories property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<string>?> GetGroupCategories();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<System.String>>
PortalItem.GetIsLayer() Method
Asynchronously retrieve the current value of the IsLayer property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetIsLayer();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
PortalItem.GetIsOrgItem() Method
Asynchronously retrieve the current value of the IsOrgItem property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetIsOrgItem();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
PortalItem.GetItemControl() Method
Asynchronously retrieve the current value of the ItemControl property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.ItemControl>> GetItemControl();
Returns
System.Threading.Tasks.Task<System.Nullable<ItemControl>>
PortalItem.GetItemPageUrl() Method
Asynchronously retrieve the current value of the ItemPageUrl property.
public System.Threading.Tasks.Task<string?> GetItemPageUrl();
Returns
System.Threading.Tasks.Task<System.String>
PortalItem.GetItemUrl() Method
Asynchronously retrieve the current value of the ItemUrl property.
public System.Threading.Tasks.Task<string?> GetItemUrl();
Returns
System.Threading.Tasks.Task<System.String>
PortalItem.GetLicenseInfo() Method
Asynchronously retrieve the current value of the LicenseInfo property.
public System.Threading.Tasks.Task<string?> GetLicenseInfo();
Returns
System.Threading.Tasks.Task<System.String>
PortalItem.GetLoaded() Method
Asynchronously retrieve the current value of the Loaded property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetLoaded();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
PortalItem.GetModified() Method
Asynchronously retrieve the current value of the Modified property.
public System.Threading.Tasks.Task<System.Nullable<System.DateTime>> GetModified();
Returns
System.Threading.Tasks.Task<System.Nullable<System.DateTime>>
PortalItem.GetName() Method
Asynchronously retrieve the current value of the Name property.
public System.Threading.Tasks.Task<string?> GetName();
Returns
System.Threading.Tasks.Task<System.String>
PortalItem.GetNumComments() Method
Asynchronously retrieve the current value of the NumComments property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetNumComments();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
PortalItem.GetNumRatings() Method
Asynchronously retrieve the current value of the NumRatings property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetNumRatings();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
PortalItem.GetNumViews() Method
Asynchronously retrieve the current value of the NumViews property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetNumViews();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
PortalItem.GetOwner() Method
Asynchronously retrieve the current value of the Owner property.
public System.Threading.Tasks.Task<string?> GetOwner();
Returns
System.Threading.Tasks.Task<System.String>
PortalItem.GetOwnerFolder() Method
Asynchronously retrieve the current value of the OwnerFolder property.
public System.Threading.Tasks.Task<string?> GetOwnerFolder();
Returns
System.Threading.Tasks.Task<System.String>
PortalItem.GetPortal() Method
Asynchronously retrieve the current value of the Portal property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Portal?> GetPortal();
Returns
System.Threading.Tasks.Task<Portal>
PortalItem.GetPortalItemId() Method
Asynchronously retrieve the current value of the PortalItemId property.
public System.Threading.Tasks.Task<string?> GetPortalItemId();
Returns
System.Threading.Tasks.Task<System.String>
PortalItem.GetScreenshots() Method
Asynchronously retrieve the current value of the Screenshots property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<string>?> GetScreenshots();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<System.String>>
PortalItem.GetSize() Method
Asynchronously retrieve the current value of the Size property.
public System.Threading.Tasks.Task<System.Nullable<long>> GetSize();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Int64>>
PortalItem.GetSnippet() Method
Asynchronously retrieve the current value of the Snippet property.
public System.Threading.Tasks.Task<string?> GetSnippet();
Returns
System.Threading.Tasks.Task<System.String>
PortalItem.GetSourceJSON() Method
Asynchronously retrieve the current value of the SourceJSON property.
public System.Threading.Tasks.Task<string?> GetSourceJSON();
Returns
System.Threading.Tasks.Task<System.String>
PortalItem.GetTags() Method
Asynchronously retrieve the current value of the Tags property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<string>?> GetTags();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<System.String>>
PortalItem.GetThumbnailUrl(int) Method
Get the URL to the thumbnail image for the item.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<string?> GetThumbnailUrl(int width);
Parameters
width
System.Int32
The desired image width.
Returns
System.Threading.Tasks.Task<System.String>
PortalItem.GetTitle() Method
Asynchronously retrieve the current value of the Title property.
public System.Threading.Tasks.Task<string?> GetTitle();
Returns
System.Threading.Tasks.Task<System.String>
PortalItem.GetTypeKeywords() Method
Asynchronously retrieve the current value of the TypeKeywords property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<string>?> GetTypeKeywords();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<System.String>>
PortalItem.GetUrl() Method
Asynchronously retrieve the current value of the Url property.
public System.Threading.Tasks.Task<string?> GetUrl();
Returns
System.Threading.Tasks.Task<System.String>
PortalItem.IsFulfilled() Method
isFulfilled()
may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<System.Nullable<bool>> IsFulfilled();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
PortalItem.IsRejected() Method
isRejected()
may be used to verify if creating an instance of the class is rejected.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<System.Nullable<bool>> IsRejected();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
PortalItem.IsResolved() Method
isResolved()
may be used to verify if creating an instance of the class is resolved.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<System.Nullable<bool>> IsResolved();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
PortalItem.Load(CancellationToken) Method
Loads the resources referenced by this class.
param options.signal Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError
when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<string?> Load(System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));
Parameters
cancellationToken
System.Threading.CancellationToken
The CancellationToken to cancel an asynchronous operation.
Returns
System.Threading.Tasks.Task<System.String>
PortalItem.Reload() Method
Reloads a loaded item’s properties from the portal.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.PortalItem?> Reload();
Returns
System.Threading.Tasks.Task<PortalItem>
PortalItem.RemoveAllResources(CancellationToken) Method
Removes all the resources from the portal item.
param options.signal Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError
when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<string?> RemoveAllResources(System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));
Parameters
cancellationToken
System.Threading.CancellationToken
The CancellationToken to cancel an asynchronous operation.
Returns
System.Threading.Tasks.Task<System.String>
PortalItem.RemoveFromCategories(string[]) Method
Asynchronously remove an element from the Categories property.
public System.Threading.Tasks.Task RemoveFromCategories(params string[] values);
Parameters
values
System.String[]
The elements to remove.
Returns
PortalItem.RemoveFromGroupCategories(string[]) Method
Asynchronously remove an element from the GroupCategories property.
public System.Threading.Tasks.Task RemoveFromGroupCategories(params string[] values);
Parameters
values
System.String[]
The elements to remove.
Returns
PortalItem.RemoveFromScreenshots(string[]) Method
Asynchronously remove an element from the Screenshots property.
public System.Threading.Tasks.Task RemoveFromScreenshots(params string[] values);
Parameters
values
System.String[]
The elements to remove.
Returns
PortalItem.RemoveFromTags(string[]) Method
Asynchronously remove an element from the Tags property.
public System.Threading.Tasks.Task RemoveFromTags(params string[] values);
Parameters
values
System.String[]
The elements to remove.
Returns
PortalItem.RemoveFromTypeKeywords(string[]) Method
Asynchronously remove an element from the TypeKeywords property.
public System.Threading.Tasks.Task RemoveFromTypeKeywords(params string[] values);
Parameters
values
System.String[]
The elements to remove.
Returns
PortalItem.RemoveResource(PortalItemResource, CancellationToken) Method
Removes a resource from the portal item.
param options An object wih the following properties.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<string?> RemoveResource(dymaptic.GeoBlazor.Core.Model.PortalItemResource resource, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));
Parameters
resource
PortalItemResource
The resource to remove from the portal item.
cancellationToken
System.Threading.CancellationToken
The CancellationToken to cancel an asynchronous operation.
Returns
System.Threading.Tasks.Task<System.String>
PortalItem.SetAccess(Nullable) Method
Asynchronously set the value of the Access property after render.
public System.Threading.Tasks.Task SetAccess(System.Nullable<dymaptic.GeoBlazor.Core.Enums.PortalItemAccess> value);
Parameters
value
System.Nullable<PortalItemAccess>
The value to set.
Returns
PortalItem.SetAccessInformation(string) Method
Asynchronously set the value of the AccessInformation property after render.
public System.Threading.Tasks.Task SetAccessInformation(string? value);
Parameters
value
System.String
The value to set.
Returns
PortalItem.SetApiKey(string) Method
Asynchronously set the value of the ApiKey property after render.
public System.Threading.Tasks.Task SetApiKey(string? value);
Parameters
value
System.String
The value to set.
Returns
PortalItem.SetAvgRating(Nullable) Method
Asynchronously set the value of the AvgRating property after render.
public System.Threading.Tasks.Task SetAvgRating(System.Nullable<double> value);
Parameters
value
System.Nullable<System.Double>
The value to set.
Returns
PortalItem.SetCategories(IReadOnlyList) Method
Asynchronously set the value of the Categories property after render.
public System.Threading.Tasks.Task SetCategories(System.Collections.Generic.IReadOnlyList<string>? value);
Parameters
value
System.Collections.Generic.IReadOnlyList<System.String>
The value to set.
Returns
PortalItem.SetClassification(Dictionary<string,string>) Method
Asynchronously set the value of the Classification property after render.
public System.Threading.Tasks.Task SetClassification(System.Collections.Generic.Dictionary<string,string?>? value);
Parameters
value
System.Collections.Generic.Dictionary<System.String,System.String>
The value to set.
Returns
PortalItem.SetCreated(Nullable) Method
Asynchronously set the value of the Created property after render.
public System.Threading.Tasks.Task SetCreated(System.Nullable<System.DateTime> value);
Parameters
value
System.Nullable<System.DateTime>
The value to set.
Returns
PortalItem.SetCulture(string) Method
Asynchronously set the value of the Culture property after render.
public System.Threading.Tasks.Task SetCulture(string? value);
Parameters
value
System.String
The value to set.
Returns
PortalItem.SetDescription(string) Method
Asynchronously set the value of the Description property after render.
public System.Threading.Tasks.Task SetDescription(string? value);
Parameters
value
System.String
The value to set.
Returns
PortalItem.SetExtent(Extent) Method
Asynchronously set the value of the Extent property after render.
public System.Threading.Tasks.Task SetExtent(dymaptic.GeoBlazor.Core.Components.Geometries.Extent? value);
Parameters
value
Extent
The value to set.
Returns
PortalItem.SetGroupCategories(IReadOnlyList) Method
Asynchronously set the value of the GroupCategories property after render.
public System.Threading.Tasks.Task SetGroupCategories(System.Collections.Generic.IReadOnlyList<string>? value);
Parameters
value
System.Collections.Generic.IReadOnlyList<System.String>
The value to set.
Returns
PortalItem.SetLicenseInfo(string) Method
Asynchronously set the value of the LicenseInfo property after render.
public System.Threading.Tasks.Task SetLicenseInfo(string? value);
Parameters
value
System.String
The value to set.
Returns
PortalItem.SetModified(Nullable) Method
Asynchronously set the value of the Modified property after render.
public System.Threading.Tasks.Task SetModified(System.Nullable<System.DateTime> value);
Parameters
value
System.Nullable<System.DateTime>
The value to set.
Returns
PortalItem.SetName(string) Method
Asynchronously set the value of the Name property after render.
public System.Threading.Tasks.Task SetName(string? value);
Parameters
value
System.String
The value to set.
Returns
PortalItem.SetNumComments(Nullable) Method
Asynchronously set the value of the NumComments property after render.
public System.Threading.Tasks.Task SetNumComments(System.Nullable<double> value);
Parameters
value
System.Nullable<System.Double>
The value to set.
Returns
PortalItem.SetNumRatings(Nullable) Method
Asynchronously set the value of the NumRatings property after render.
public System.Threading.Tasks.Task SetNumRatings(System.Nullable<double> value);
Parameters
value
System.Nullable<System.Double>
The value to set.
Returns
PortalItem.SetNumViews(Nullable) Method
Asynchronously set the value of the NumViews property after render.
public System.Threading.Tasks.Task SetNumViews(System.Nullable<double> value);
Parameters
value
System.Nullable<System.Double>
The value to set.
Returns
PortalItem.SetOwner(string) Method
Asynchronously set the value of the Owner property after render.
public System.Threading.Tasks.Task SetOwner(string? value);
Parameters
value
System.String
The value to set.
Returns
PortalItem.SetOwnerFolder(string) Method
Asynchronously set the value of the OwnerFolder property after render.
public System.Threading.Tasks.Task SetOwnerFolder(string? value);
Parameters
value
System.String
The value to set.
Returns
PortalItem.SetPortal(Portal) Method
Asynchronously set the value of the Portal property after render.
public System.Threading.Tasks.Task SetPortal(dymaptic.GeoBlazor.Core.Components.Portal? value);
Parameters
value
Portal
The value to set.
Returns
PortalItem.SetPortalItemId(string) Method
Asynchronously set the value of the PortalItemId property after render.
public System.Threading.Tasks.Task SetPortalItemId(string value);
Parameters
value
System.String
The value to set.
Returns
PortalItem.SetScreenshots(IReadOnlyList) Method
Asynchronously set the value of the Screenshots property after render.
public System.Threading.Tasks.Task SetScreenshots(System.Collections.Generic.IReadOnlyList<string>? value);
Parameters
value
System.Collections.Generic.IReadOnlyList<System.String>
The value to set.
Returns
PortalItem.SetSize(Nullable) Method
Asynchronously set the value of the Size property after render.
public System.Threading.Tasks.Task SetSize(System.Nullable<long> value);
Parameters
value
System.Nullable<System.Int64>
The value to set.
Returns
PortalItem.SetSnippet(string) Method
Asynchronously set the value of the Snippet property after render.
public System.Threading.Tasks.Task SetSnippet(string? value);
Parameters
value
System.String
The value to set.
Returns
PortalItem.SetTags(IReadOnlyList) Method
Asynchronously set the value of the Tags property after render.
public System.Threading.Tasks.Task SetTags(System.Collections.Generic.IReadOnlyList<string>? value);
Parameters
value
System.Collections.Generic.IReadOnlyList<System.String>
The value to set.
Returns
PortalItem.SetTitle(string) Method
Asynchronously set the value of the Title property after render.
public System.Threading.Tasks.Task SetTitle(string? value);
Parameters
value
System.String
The value to set.
Returns
PortalItem.SetTypeKeywords(IReadOnlyList) Method
Asynchronously set the value of the TypeKeywords property after render.
public System.Threading.Tasks.Task SetTypeKeywords(System.Collections.Generic.IReadOnlyList<string>? value);
Parameters
value
System.Collections.Generic.IReadOnlyList<System.String>
The value to set.
Returns
PortalItem.SetUrl(string) Method
Asynchronously set the value of the Url property after render.
public System.Threading.Tasks.Task SetUrl(string? value);
Parameters
value
System.String
The value to set.
Returns
PortalItem.Update(string) Method
Updates the item’s properties to the portal, and optionally its data.
param params.data Optional. The component used to stream the data represented by the item to the client.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.PortalItem?> Update(string data);
Parameters
data
System.String
Optional.
ArcGIS Maps SDK for JavaScript
Returns
System.Threading.Tasks.Task<PortalItem>
PortalItem.UpdateThumbnail(Stream, string) Method
Updates the item’s thumbnail on the portal.
param params.thumbnail A URL, Data URI, Blob, or File. The accepted formats are GIF
, JPG
, and PNG
.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.PortalItem?> UpdateThumbnail(System.IO.Stream thumbnail, string filename);
Parameters
thumbnail
System.IO.Stream
A URL, Data URI, Blob, or File.
ArcGIS Maps SDK for JavaScript
filename
System.String
The file name used for the thumbnail in thumbnailUrl.
ArcGIS Maps SDK for JavaScript
Returns
System.Threading.Tasks.Task<PortalItem>
PortalItem.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()
PortalItem.When(Func, Func) Method
when()
may be leveraged once an instance of the class is created.
param errback The function to execute when the promise fails.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<string?> When(System.Func<System.Threading.Tasks.Task> callback, System.Func<System.Threading.Tasks.Task> errback);
Parameters
callback
System.Func<System.Threading.Tasks.Task>
The function to call when the promise resolves.
errback
System.Func<System.Threading.Tasks.Task>
The function to execute when the promise fails.