Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OAuthInfo

Hierarchy

Index

Properties

appId

appId: string

The registered application id.

Read more...

authNamespace

authNamespace: string

Applications with the same value will share the stored token on the same host.

Read more...

declaredClass

declaredClass: string

destroyed

destroyed: boolean

expiration

expiration: number

The number of minutes that the token is valid.

Read more...

forceUserId

forceUserId: boolean

Set this property to true to force the user to sign in with the id in userId.

Read more...

initialized

initialized: boolean

locale

locale: string

The locale for the OAuth sign in page.

Read more...

minTimeUntilExpiration

minTimeUntilExpiration: number

The minimum time in minutes before a saved token is due to expire that it should still be considered valid for use.

Read more...

popup

popup: boolean

Set to true to show the OAuth sign in page in a popup window.

Read more...

popupCallbackUrl

popupCallbackUrl: string

Applicable if working with the popup user-login workflow.

Read more...

popupWindowFeatures

popupWindowFeatures: string

The window features passed to window.open().

Read more...

portalUrl

portalUrl: string

The ArcGIS Enterprise portal URL.

Read more...

preserveUrlHash

preserveUrlHash: boolean

Set this property to true when popup is false in order to have the window's location hash value restored after signing in.

Read more...

userId

userId: string

The user id used when forceUserId is true.

Read more...

Methods

Protected _get

  • _get(propertyName: string): any
  • _get<T>(propertyName: string): T
  • Parameters

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • _set<T>(propertyName: string, value: T): OAuthInfo
  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns OAuthInfo

clone

  • Creates a copy of the OAuthInfo object.

    Read more...

    Returns OAuthInfo

destroy

  • destroy(): void
  • Returns void

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any
  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns OAuthInfo

  • Parameters

    Returns OAuthInfo

toJSON

  • toJSON(): any
  • Converts an instance of this class to its ArcGIS portal JSON representation.

    Read more...

    Returns any

watch

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

Generated using TypeDoc