ArcGIS Developers
Dashboard

<PortalTypes.h> - Portal Enums

Collection of Portal enumerations. More...

Header: #include <PortalTypes.h>

Types

enum class PortalAccess { Unknown, Organization, Private, Public, Shared }
enum class PortalFileType { Unknown, CSV, Shapefile, TilePackage, FeatureService, …, ServiceDefinition }
enum class PortalGroupSortField { AverageRating, Created, Modified, Owner, Title, …, ViewCount }
enum class PortalItemType { Unknown, ArcGISProAddIn, ArcPadPackage, CADDrawing, CSV, …, Style }
enum class PortalMode { Unknown, MultiTenant, SingleTenant }
enum class PortalPrivilegeRealm { Unknown, Portal, Features, OpenData, Premium, Marketplace }
enum class PortalPrivilegeRole { Unknown, Administrator, Publisher, User }
enum class PortalPrivilegeType { Unknown, Edit, FullEdit, Manage, Purchase, …, ViewTacks }
enum class PortalQuerySortOrder { Ascending, Descending }
enum class PortalReadyState { Uninitialized, Loading, Errored, Completed, Aborting }
enum class PortalStatus { Unknown, Partial, Processing, Failed, Completed }
enum class PortalUserRole { Unknown, Publisher, Admin, User }
enum class SubscriptionState { Unknown, Active, Canceled, Deleted, Expired, …, Suspended }

Detailed Description

Type Documentation

enum class PortalAccess

Enumerates the access privileges that determine who can see and access a Portal object.

The PortalAccess can be one of:

ConstantValueDescription
PortalAccess::Unknown-1Unknown access.
PortalAccess::Organization0Members of the user's organization.
PortalAccess::Private1Only the owner.
PortalAccess::Public2Any user.
PortalAccess::Shared3Shared with one or more groups.

- For the PortalInfo object, it determines the level of access to an organization for anonymous users.

- For the PortalItemInfo object, it determines who can see and access the item.

- For the PortalGroupInfo object, it determines who can see and access the group.

- For the PortalUserInfo object, it determines what level of access to the user information will be available to others and whether it will be searchable.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class PortalFileType

Enumerates types of files that can be items in a portal.

The PortalFileType can be one of:

ConstantValueDescription
PortalFileType::Unknown-1Unknown file type.
PortalFileType::CSV0Comma-separated value text file.
PortalFileType::Shapefile1Shapefile.
PortalFileType::TilePackage2Tile package.
PortalFileType::FeatureService3Feature service.
PortalFileType::FeatureCollection4Feature collection.
PortalFileType::ServiceDefinition5Service definition.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class PortalGroupSortField

Enumerates fields to sort by.

The PortalGroupSortField can be one of:

ConstantValueDescription
PortalGroupSortField::AverageRating0AverageRating.
PortalGroupSortField::Created1Created.
PortalGroupSortField::Modified2Modified.
PortalGroupSortField::Owner3Owner.
PortalGroupSortField::Title4Title.
PortalGroupSortField::Unknown5Unknown.
PortalGroupSortField::ViewCount6ViewCount.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class PortalItemType

Enumerates types of items that may be stored in a portal.

The PortalItemType can be one of:

ConstantValueDescription
PortalItemType::Unknown-1Unknown item type.
PortalItemType::ArcGISProAddIn0ArcGISProAddIn
PortalItemType::ArcPadPackage1ArcPad package.
PortalItemType::CADDrawing2CAD Drawing.
PortalItemType::CSV3Comma-separated value text file.
PortalItemType::CityEngineWebScene4CityEngine WebScene.
PortalItemType::CodeAttachment5Code attachment.
PortalItemType::CodeSample6Code sample.
PortalItemType::ColorSet7Color set.
PortalItemType::DesktopAddIn8ArcGIS Desktop add-in.
PortalItemType::DesktopApplication9ArcGIS Desktop application.
PortalItemType::DesktopApplicationTemplate10ArcGIS Desktop application template.
PortalItemType::DesktopStyle11Desktop style.
PortalItemType::DocumentLink12Document link.
PortalItemType::ExplorerAddIn13ArcGIS Explorer add-in.
PortalItemType::ExplorerLayer14ArcGIS Explorer layer.
PortalItemType::ExplorerMap15ArcGIS Explorer map.
PortalItemType::FeatureCollection16Feature collection.
PortalItemType::FeatureCollectionTemplate17Feature collection template.
PortalItemType::FeatureService18Feature service.
PortalItemType::FileGeodatabase19Geodatabase file.
PortalItemType::Form20Form.
PortalItemType::GeocodingService21Geocoding service.
PortalItemType::GeodataService22Geodata service.
PortalItemType::GeometryService23Geometry service.
PortalItemType::GeoprocessingPackage24Geoprocessing package.
PortalItemType::GeoprocessingPackageProVersion25Geoprocessing package pro version.
PortalItemType::GeoprocessingSample26Geoprocessing sample.
PortalItemType::GeoprocessingService27Geoprocessing service.
PortalItemType::GlobeDocument28ArcGlobe document.
PortalItemType::GlobeService29ArcGlobe service.
PortalItemType::Image30Image file.
PortalItemType::ImageCollection31Image collection.
PortalItemType::ImageService32Image service.
PortalItemType::InsightsModel33Insights model.
PortalItemType::InsightsPage34Insights page.
PortalItemType::InsightsWorkbook35Insights workbook.
PortalItemType::IWorkKeynote36IWork keynote.
PortalItemType::IWorkNumbers37IWork numbers.
PortalItemType::IWorkPages38IWork pages.
PortalItemType::KML39KML document.
PortalItemType::KMLCollection40KML collection.
PortalItemType::Layer41Layer.
PortalItemType::LayerPackage42Layer package.
PortalItemType::Layout43Layout.
PortalItemType::LocatorPackage44Locator package.
PortalItemType::MapDocument45ArcMap document.
PortalItemType::MapPackage46Map package.
PortalItemType::MapService47Map service.
PortalItemType::MapTemplate48Map template.
PortalItemType::MicrosoftExcel49Microsoft Excel spreadsheet document.
PortalItemType::MicrosoftPowerpoint50Microsoft PowerPoint document.
PortalItemType::MicrosoftWord51Microsoft Word document.
PortalItemType::MobileApplication52Mobile application.
PortalItemType::MobileBasemapPackage53Mobile basemap package.
PortalItemType::MobileMapPackage54Mobile map package.
PortalItemType::NativeApplication55Native application.
PortalItemType::NativeApplicationInstaller56Native Application Installer for ArcGIS AppStudio.
PortalItemType::NativeApplicationTemplate57Native Application Template for ArcGIS AppStudio.
PortalItemType::NetCDF58Net CDF.
PortalItemType::NetworkAnalysisService59Network Analysis service.
PortalItemType::OperationView60Operations Dashboard operation view.
PortalItemType::OperationsDashboardAddIn61Operations dashboard add-in.
PortalItemType::OperationsDashboardExtension62Operations dashboard extension.
PortalItemType::PDF63Adobe PDF document.
PortalItemType::ProjectPackage64ArcGIS Pro project package.
PortalItemType::ProjectTemplate65Project template.
PortalItemType::ProMap66Pro map.
PortalItemType::PublishedMap67Published map file.
PortalItemType::RasterFunctionTemplate68Raster function template.
PortalItemType::RelationalDatabaseConnection69Relational database connection.
PortalItemType::ReportTemplate70Report template.
PortalItemType::RulePackage71CityEngine rule package.
PortalItemType::SceneDocument72ArcGIS scene document.
PortalItemType::ScenePackage73ArcGIS scene package.
PortalItemType::SceneService74ArcGIS scene service.
PortalItemType::ServiceDefinition75Service definition file.
PortalItemType::ShapeFile76Shapefile.
PortalItemType::StatisticalDataCollection77Statistical data collection.
PortalItemType::SymbolSet78ArcGIS symbol set file.
PortalItemType::TaskFile79Task file.
PortalItemType::TilePackage80Tile package.
PortalItemType::VectorTilePackage81Vector tile package.
PortalItemType::VectorTileService82Vector tile service.
PortalItemType::VisioDocument83Microsoft Visio document.
PortalItemType::Vr360Experience84Vr360 experience.
PortalItemType::WFS85OGC web feature service.
PortalItemType::WMS86OGC web map service (WMS).
PortalItemType::WMTS87OGC web map tile service (WMTS).
PortalItemType::WebMap88Web map.
PortalItemType::WebMappingApplication89Web mapping application.
PortalItemType::WebScene90WebScene.
PortalItemType::WindowsMobilePackage91Windows Mobile package.
PortalItemType::WorkflowManagerPackage92Workflow Manager package.
PortalItemType::WorkflowManagerService93Workflow Manager service.
PortalItemType::WorkforceProject94Workforce project.
PortalItemType::SQLiteGeodatabase95SQLite Geodatabase.
PortalItemType::MapArea96Map Area.
PortalItemType::HubInitiative97Hub Initiative.
PortalItemType::HubSiteApplication98Hub Site Application.
PortalItemType::HubPage99Hub Page.
PortalItemType::AppBuilderExtension100AppBuilder Extension for ArcGIS Web AppBuilder.
PortalItemType::AppBuilderWidgetPackage101AppBuilder Widget Package for ArcGIS Web AppBuilder. Custom widget in a zip file that can be downloaded for use in Web AppBuilder Developer Edition or ArcGIS Enterprise 10.5.1 or above.
PortalItemType::Dashboard102Dashboard.
PortalItemType::ArcGISProConfiguration103ArcGIS Pro Configuration.
PortalItemType::ContentCategorySet104Content Category Set.
PortalItemType::InsightsTheme105Insights Theme.
PortalItemType::MobileScenePackage106Mobile Scene Package.
PortalItemType::OrientedImageryCatalog107Oriented Imagery Catalog.
PortalItemType::OrthoMappingProject108Ortho Mapping Project.
PortalItemType::OrthoMappingTemplate109Ortho Mapping Template.
PortalItemType::Solution110Solution.
PortalItemType::BuildingSceneLayer111Building Scene Layer.
PortalItemType::CompactTilePackage112Compact Tile Package.
PortalItemType::DataStore113Data Store.
PortalItemType::DeepLearningPackage114Deep Learning Package.
PortalItemType::ExcaliburImageryProject115Excalibur Imagery Project.
PortalItemType::GeoPackage116GeoPackage.
PortalItemType::Mission117Mission.
PortalItemType::SiteApplication118Site Application.
PortalItemType::SitePage119Site Page.
PortalItemType::BigDataAnalytic120Big Data Analytic.
PortalItemType::Feed121Feed.
PortalItemType::RealTimeAnalytic122Real Time Analytic.
PortalItemType::ProReport123Pro Report.
PortalItemType::QuickCaptureProject124QuickCapture Project.
PortalItemType::Survey123AddIn125Survey123 Add In.
PortalItemType::UrbanModel126Urban Model.
PortalItemType::WebExperience127Web Experience.
PortalItemType::Style135A webstyle item.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class PortalMode

Enumerates whether the portal is operating in multi-tenant or single-tenant mode.

The PortalMode can be one of:

ConstantValueDescription
PortalMode::Unknown-1Unknown portal mode.
PortalMode::MultiTenant0Multi-tenant mode.
PortalMode::SingleTenant1Single-tenant mode.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class PortalPrivilegeRealm

Enumerates the types of privilege realms available for a portal.

The PortalPrivilegeRealm can be one of:

ConstantValueDescription
PortalPrivilegeRealm::Unknown-1Unknown realm.
PortalPrivilegeRealm::Portal0Used for privileges related to general portal content and usage.
PortalPrivilegeRealm::Features1Used for privileges related to feature editing.
PortalPrivilegeRealm::OpenData2Used for privileges related to ArcGIS Open Data.
PortalPrivilegeRealm::Premium3Used for privileges related to premium content.
PortalPrivilegeRealm::Marketplace4Used for privileges related to the ArcGIS Marketplace.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class PortalPrivilegeRole

Enumerates the types of privileges available for a portal.

The PortalPrivilegeRole can be one of:

ConstantValueDescription
PortalPrivilegeRole::Unknown-1Unknown privilege.
PortalPrivilegeRole::Administrator0Administrator role.
PortalPrivilegeRole::Publisher1Pulblisher role.
PortalPrivilegeRole::User2User role.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class PortalPrivilegeType

Enumerates the particular type of operation a privilege permits.

The PortalPrivilegeType can be one of:

ConstantValueDescription
PortalPrivilegeType::Unknown-1Unknown.
PortalPrivilegeType::Edit0Edit.
PortalPrivilegeType::FullEdit1Full Edit.
PortalPrivilegeType::Manage2Manage.
PortalPrivilegeType::Purchase3Purchase.
PortalPrivilegeType::StartTrial4Start Trial.
PortalPrivilegeType::DesignateGroup5Designate Group.
PortalPrivilegeType::OpenDataAdmin6OpenData Admin.
PortalPrivilegeType::AssignToGroups7Assign To Groups.
PortalPrivilegeType::ChangeUserRoles8Change User Roles.
PortalPrivilegeType::DeleteGroups9Delete Groups.
PortalPrivilegeType::DeleteItems10Delete Items.
PortalPrivilegeType::DeleteUsers11Delete Users.
PortalPrivilegeType::DisableUsers12Disable Users.
PortalPrivilegeType::InviteUsers13Invite Users.
PortalPrivilegeType::ManageEnterpriseGroups14Manage Enterprise Groups.
PortalPrivilegeType::ManageLicenses15Manage Licenses.
PortalPrivilegeType::ReassignGroups16Reassign Groups.
PortalPrivilegeType::ReassignItems17Reassign Items.
PortalPrivilegeType::ReassignUsers18Reassign Users.
PortalPrivilegeType::UpdateGroups19Update Groups.
PortalPrivilegeType::UpdateItems20Update Items.
PortalPrivilegeType::UpdateUsers21Update Users.
PortalPrivilegeType::ViewGroups22View Groups.
PortalPrivilegeType::ViewItems23View Items.
PortalPrivilegeType::ViewUsers24View Users.
PortalPrivilegeType::PublishFeatures25Publish Features.
PortalPrivilegeType::PublishScenes26Publish Scenes.
PortalPrivilegeType::PublishTiles27Publish Tiles.
PortalPrivilegeType::CreateGroup28Create Group.
PortalPrivilegeType::CreateItem29Create Item.
PortalPrivilegeType::JoinGroup30Join Group.
PortalPrivilegeType::JoinNonOrgGroup31Join Non Org Group.
PortalPrivilegeType::ShareGroupToOrg32Share Group To Org.
PortalPrivilegeType::ShareGroupToPublic33Share Group To Public.
PortalPrivilegeType::ShareToGroup34Share To Group.
PortalPrivilegeType::ShareToOrg35Share To Org.
PortalPrivilegeType::ShareToPublic36Share To Public.
PortalPrivilegeType::Demographics37Demographics.
PortalPrivilegeType::Elevation38Elevation.
PortalPrivilegeType::Geocode39Geocode.
PortalPrivilegeType::Geoenrichment40Geoenrichment.
PortalPrivilegeType::NetworkAnalysis41NetworkAnalysis.
PortalPrivilegeType::SpatialAnalysis42SpatialAnalysis.
PortalPrivilegeType::CreateUpdateCapableGroup43CreateUpdateCapableGroup.
PortalPrivilegeType::ViewOrgGroups44ViewOrgGroups.
PortalPrivilegeType::ViewOrgItems45ViewOrgItems.
PortalPrivilegeType::ViewOrgUsers46ViewOrgUsers.
PortalPrivilegeType::Geoanalytics47Geoanalytics.
PortalPrivilegeType::Rasteranalysis48Rasteranalysis.
PortalPrivilegeType::PublishServerGPServices49Grants the ability to publish non-hosted server geoprocessing services.
PortalPrivilegeType::PublishServerServices50Grants the ability to publish non-hosted server services.
PortalPrivilegeType::UpdateItemCategorySchema51Grants the ability to configure the organization content category schema.
PortalPrivilegeType::FeatureReport52Grants the ability to generate feature reports.
PortalPrivilegeType::ManageCollaborations53Grants the ability to manage the organization's collaborations.
PortalPrivilegeType::ManageCredits54Grants the ability to manage the organization's credit settings.
PortalPrivilegeType::ManageRoles55Grants the ability to manage the organization's member roles.
PortalPrivilegeType::ManageSecurity56Grants the ability to manage the organization's security settings.
PortalPrivilegeType::ManageServers57Grants the ability to manage the portal's server settings.
PortalPrivilegeType::ManageUtilityServices58Grants the ability to manage the organization's utility service settings.
PortalPrivilegeType::ManageWebsite59Grants the ability to manage the organization's website settings.
PortalPrivilegeType::ManageReplications60Grants the ability to manage replications and utilize the collaborations API.
PortalPrivilegeType::CreateNotebooks61Grants the ability to create and edit interactive notebook documents.
PortalPrivilegeType::CreateAdvancedNotebooks62Grants the ability to publish a notebook as a geoprocessing service.
PortalPrivilegeType::BulkPublishFromDataStores63Grants the ability to publish web layers from a registered data store.
PortalPrivilegeType::EnumerateDataStores64Grants the ability to get the list of datasets from a registered data store.
PortalPrivilegeType::RegisterDataStores65Grants the ability to register data stores to the portal.
PortalPrivilegeType::CategorizeItems66Grants the ability to categorize items in groups.
PortalPrivilegeType::ViewTacks67Grants the ability to view members' location tracks via shared track views when location tracking is enabled.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class PortalQuerySortOrder

Enumerates sort order for returned results.

The PortalQuerySortOrder can be one of:

ConstantValueDescription
PortalQuerySortOrder::Ascending0Ascending.
PortalQuerySortOrder::Descending1Descending.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class PortalReadyState

Enumerates possible readiness states of a portal.

The PortalReadyState can be one of:

ConstantValueDescription
PortalReadyState::Uninitialized0Portal is uninitialized.
PortalReadyState::Loading1Portal is loading the results from a request.
PortalReadyState::Errored2Last request failed.
PortalReadyState::Completed3Last request completed successfully.
PortalReadyState::Aborting4Last request is aborting.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class PortalStatus

Enumerates portal status when publishing an item, adding an item in async mode, or adding with a multipart upload.

The PortalStatus can be one of:

ConstantValueDescription
PortalStatus::Unknown-1Unknown.
PortalStatus::Partial0For Add Item Multipart, when only a part is uploaded and the item is not committed.
PortalStatus::Processing1In progress.
PortalStatus::Failed2Process failed.
PortalStatus::Completed3Process completed successfully.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class PortalUserRole

Enumerates portal user roles.

The PortalUserRole can be one of:

ConstantValueDescription
PortalUserRole::Unknown-1Unknown.
PortalUserRole::Publisher0Publisher.
PortalUserRole::Admin1Administrator.
PortalUserRole::User2User.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class SubscriptionState

Enumerates the state of the user's subscription.

The SubscriptionState can be one of:

ConstantValueDescription
SubscriptionState::Unknown-1Subscription state is unknown.
SubscriptionState::Active0Subscription is active and allows all functionality.
SubscriptionState::Canceled1Subscription was canceled.
SubscriptionState::Deleted2Subscription was deleted.
SubscriptionState::Expired3Subscription has expired.
SubscriptionState::Restricted4Subscription has run out of credits.
SubscriptionState::Suspended5Subscription was suspended.

This enum was introduced or modified in Esri::ArcGISRuntime 100.9.


Feedback on this topic?