ArcGIS Pro 3.2 API Reference Guide
ArcGIS.Desktop.Core Namespace / ArcGISPortal Class
Properties Methods


In This Topic
    ArcGISPortal Class Members
    In This Topic

    The following tables list the members exposed by ArcGISPortal.

    Public Properties
     NameDescription
    Public PropertyPortalUri Gets the portal Uri for this portal instance  
    Top
    Public Methods
     NameDescription
    Public MethodEnsureValid Ensure the portal is a valid.  
    Public MethodGetSignOnUsernameGets the username for the current connection This method should be called from within a QueuedTask or System.Threading.Task unless the caller is within ArcGIS.Desktop.Framework.Contracts.ConfigurationManager.OnApplicationInitializing in which case the main thread should be used.
     
    Public MethodGetTokenGets the current token for the session. The ArcGISPortal class automatically manages the token expiration. This value should not be cached. This method should be called from within a QueuedTask or System.Threading.Task unless the caller is within ArcGIS.Desktop.Framework.Contracts.ConfigurationManager.OnApplicationInitializing in which case the main thread should be used.
     
    Public MethodIsActivePortal Gets whether this portal instance is the active portal  
    Public MethodIsSignedOnGets the sign on status of the portal instance. This method should be called from within a QueuedTask or System.Threading.Task unless the caller is within ArcGIS.Desktop.Framework.Contracts.ConfigurationManager.OnApplicationInitializing in which case the main thread should be used.
     
    Public MethodSignIn Synchronous method to Sign on to this portal instance.  
    Public MethodSignInAsync Asynchronous method to Sign on to this portal instance.  
    Public MethodSignInWithCredentials Synchronous method to Sign on to this portal instance. This method must be called from within a QueuedTask or BackgroundTask.  
    Public MethodSignOutSign out from this portal instance This method should be called from within a QueuedTask or System.Threading.Task unless the caller is within ArcGIS.Desktop.Framework.Contracts.ConfigurationManager.OnApplicationInitializing in which case the main thread should be used.
     
    Top
    Extension Methods
     NameDescription
    Public Extension MethodGetBasemapsAsync Gets the list of base maps that are configured for the given portal.
    Public Extension MethodGetGroupsFromUserAsync Gets the groups from the user's community information.
    Public Extension MethodGetPortalInfoAsyncExecutes a self query on the specified portal to return its ArcGIS.Desktop.Core.Portal.PortalInfo.
    Public Extension MethodGetUserContentAsync Gets the given username's content. Items are either in the home folder for the user, e.g. /content/users/{username} or in a subfolder of the home folder with the given folder ID. Multilevel folders are not supported.
    Public Extension MethodSearchForContentAsync Searches for portal items from a query string.
    Top
    See Also

    Reference

    ArcGISPortal Class
    ArcGIS.Desktop.Core Namespace

     

     

    ©2023 Esri Inc., All Rights Reserved. Generated on Wednesday, October 25, 2023

    Send feedback