import ImplicitFlowPopup from '@mapcreator/api/src/oauth/ImplicitFlowPopup.js'

public class | source

ImplicitFlowPopup

OAuth → ImplicitFlow → ImplicitFlowPopup

Implicit OAuth flow using a pop-up.

Static Member Summary

Static Public Members
public static get	popupWindowName: String: string Popup window name

Public Constructor
public	constructor(clientId: String, callbackUrl: String, scopes: Array<String>, useState: Boolean, windowOptions: String) Implicit pop-up authentication flow

Public Members
public	windowOptions: *

Public Methods
public	authenticate(): *

From class OAuth
public get	authenticated: Boolean: * If the current instance has a valid token
public	clientId: *
public	host: *
public	path: *
public	scopes: *
public	token: *
public abstract	authenticate(): Promise<OAuthToken> Authenticate
public	forget() Forget the current session Empty the session token store and forget the api token
public	importToken(token: String, type: String, expires: Date \| Number, scopes: Array<string>) Manually import OAuthToken, usefull for debugging
public	logout(): CancelablePromise Invalidates the session token

From class ImplicitFlow
public	callbackUrl: *
public	path: string
public	token: *
public	useState: *
public	authenticate(): *
protected	_anchorContainsError(): Boolean Test if the anchor contains an OAuth error
protected	_anchorContainsOAuthResponse(): Boolean Test if the anchor contains an OAuth response
protected	_buildRedirectUrl(): String Builds the url for redirection
protected	_cleanAnchorParams() Remove OAuth related anchor parameters
protected	_getAnchorParams(query: String): Object<String, String> Builds an object containing all the anchor parameters
protected	_getError(): OAuthError Get and return the error in the anchor
protected	_getOAuthAnchorParams(query: Object<String, String>): Object<String, String> Fetch OAuth anchor params

Popup window name

window.name of the created pop-up

Implicit pop-up authentication flow

Name	Type	Attribute	Description
clientId	String		OAuth client id
callbackUrl	String		callbackUrl for obtaining the token. This should be a page with this script on it. If left empty the current url will be used.
scopes	Array<String>		A list of required scopes
useState	Boolean		use state verification
windowOptions	String		optional window options for the pop-up window