Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecurityHelper

Internal helper class used to assist in security related actions.

Hierarchy

  • SecurityHelper

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

dialog

dialog: HTMLDivElement

finished

finished: boolean

frame

frame: HTMLIFrameElement

id

id: string

scripts

scripts: Array<HTMLScriptElement>

site

site: Site

Methods

finish

  • finish(): boolean

  • Returns boolean

getExpirationNoticeUrl

  • getExpirationNoticeUrl(): string

  • Returns string

getRefreshUrl

  • getRefreshUrl(): string

  • Returns string

handleSignIn

  • handleSignIn(hash: string, href: string): string

  • Called from the SignInHelper, both before and after token refresh. If there's a token in the hash then refresh has happened, otherwise refresh must start.

    Parameters

    • hash: string
    • href: string

    Returns string

    The URL to redirect to if redirect should happen.

openFrame

  • openFrame(): void

  • This is the preferred refresh method. If this fails we won't hear back from the frame and will decide to open the popup.

    Returns void

openPopup

  • openPopup(): void

  • This is the second choice refresh method.

    Returns void

openSystemBrowser

  • openSystemBrowser(): void

  • This refresh method uses the system browser which is assumed to not be the current browser.

    Returns void

sendRequest

  • sendRequest(url: string): void

  • Parameters

    • url: string

    Returns void

showContent

  • showContent(response: object): boolean

  • Parameters

    • response: object
      • content: string
      • rid: string

    Returns boolean

updateSitePrincipal

  • updateSitePrincipal(rawSite: object): boolean

  • Parameters

    • rawSite: object

    Returns boolean

useSystemBrowser

  • useSystemBrowser(): boolean

  • Always returns false.

    deprecated

    Sign in used to be performed in the system browser for GMAF. As of GMAF 2.0.1, sign in is done within GMAF, and so this method just returns false now.

    Returns boolean

waitForSignIn

  • waitForSignIn(): Promise<void>

  • Returns Promise<void>

Static beginRefresh

  • beginRefresh(site: Site): boolean

  • Parameters

    Returns boolean

Static cancel

  • cancel(): boolean

  • Returns boolean

Static getCurrent

Static waitForSignIn

  • waitForSignIn(): Promise<void>

  • Returns Promise<void>