Interface PortalLoginService

Service to access security information of ArcGIS services like ArcGIS Enterprise portal.

interface PortalLoginService {
    getPortalCredential(): any;
    getPortalUserSelfInfo(): Promise<Record<string, any>>;
    isSignedIn(): boolean;
    on<Name extends EventNames<PortalLoginServiceEvents>>(
        eventName: Name,
        callback: EventCallback<PortalLoginServiceEvents[Name]>,
    ): EventHandle;
    on(eventName: "*", callback: EventCallback<void>): EventHandle;
    on(
        eventName: string | string[],
        callback: EventCallback<unknown>,
    ): EventHandle;
    signIn(): Promise<any>;
    signOut(): void;
}

Hierarchy (View Summary)

EventSource<PortalLoginServiceEvents>
- PortalLoginService

Index

Methods

getPortalCredential getPortalUserSelfInfo isSignedIn on signIn signOut

Methods

getPortalCredential

getPortalCredential(): any
Gets the token for the portal or undefined if user is not signed in.

Returns any
The user's credentials.
- Defined in arcgisportal/portal-security/api.ts:47

getPortalUserSelfInfo

getPortalUserSelfInfo(): Promise<Record<string, any>>
Gets the response of the community/self endpoint of ArcGIS Online or undefined if user is not signed in.

Returns Promise<Record<string, any>>
- Defined in arcgisportal/portal-security/api.ts:52

isSignedIn

isSignedIn(): boolean
Checks if the user is signed in to ArcGIS Online

Returns boolean
- Defined in arcgisportal/portal-security/api.ts:28

on

on<Name extends EventNames<PortalLoginServiceEvents>>(
eventName: Name,
callback: EventCallback<PortalLoginServiceEvents[Name]>,
): EventHandle
Register event listener for specific events.
Type Parameters
- Name extends EventNames<PortalLoginServiceEvents>
Parameters
- eventName: Name
  name of the event
- callback: EventCallback<PortalLoginServiceEvents[Name]>
  the event handler callback will be invoked when the event has been emitted
Returns EventHandle
a handle to unregister from the event
Inherited from EventSource.on
- Defined in apprt/apprt-core/Events.ts:76
on(eventName: "*", callback: EventCallback<void>): EventHandle
Register event listener for any event.
Parameters
- eventName: "*"
  must be "*" for this overload
- callback: EventCallback<void>
  the event handler callback will be invoked when any event has been emitted
Returns EventHandle
a handle to unregister from the events
Inherited from EventSource.on
- Defined in apprt/apprt-core/Events.ts:85
on(eventName: string | string[], callback: EventCallback<unknown>): EventHandle
Register event listener for the events listed in eventName. Comma separated event names are possible, for example "eventA,eventB".
Parameters
- eventName: string | string[]
  the event name or list of names
- callback: EventCallback<unknown>
  the event handler callback
Returns EventHandle
a handle to unregister from the event(s)
Inherited from EventSource.on
- Defined in apprt/apprt-core/Events.ts:95

signIn

signIn(): Promise<any>
Forces a sign-in to ArcGIS Online. The user is prompted to enter credentials.

Returns Promise<any>
The user's credentials, wrapped in a promise.
- Defined in arcgisportal/portal-security/api.ts:35

signOut

signOut(): void
Clears all ArcGIS Online Tokens.

Returns void
- Defined in arcgisportal/portal-security/api.ts:40