com.esri.arcgis.systemUI
Interface IArcGISSingleSignon

All Superinterfaces:

Serializable

All Known Implementing Classes:

ArcGISSingleSignon

public interface IArcGISSingleSignon
extends Serializable

Provides access to the IArcGISSingleSignon Interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

void	getCurrentToken(String[] bsToken, String[] bsReferer, int[] lExpiration, String[] bsUser) Returns the current token and matching referer.
void	getToken(int hParentHWND, String[] bsToken, String[] bsReferer, int[] lExpiration, String[] bsUser) Signs the user in to ArcGIS Online if required, and returns the current token and matching referer.
void	getURI(int eType, String[] bsURI) Returns the requested ArcGIS online URI
void	signOut() Signs the user out of ArcGIS Online.

Method Detail

getToken

void getToken(int hParentHWND,
              String[] bsToken,
              String[] bsReferer,
              int[] lExpiration,
              String[] bsUser)
              throws IOException,
                     AutomationException

Signs the user in to ArcGIS Online if required, and returns the current token and matching referer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

hParentHWND - The hParentHWND (in)

bsToken - The bsToken (in/out: use single element array)

bsReferer - The bsReferer (in/out: use single element array)

lExpiration - The lExpiration (in/out: use single element array)

bsUser - The bsUser (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

signOut

void signOut()
             throws IOException,
                    AutomationException

Signs the user out of ArcGIS Online.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentToken

void getCurrentToken(String[] bsToken,
                     String[] bsReferer,
                     int[] lExpiration,
                     String[] bsUser)
                     throws IOException,
                            AutomationException

Returns the current token and matching referer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

bsToken - The bsToken (in/out: use single element array)

bsReferer - The bsReferer (in/out: use single element array)

lExpiration - The lExpiration (in/out: use single element array)

bsUser - The bsUser (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getURI

void getURI(int eType,
            String[] bsURI)
            throws IOException,
                   AutomationException

Returns the requested ArcGIS online URI

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

eType - A com.esri.arcgis.systemUI.esriArcGISUri constant (in)

bsURI - The bsURI (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.