Type alias State

State: {
    getAdminClientId(): string;
    getAdminClientRedirectUri(): string;
    getAllowInsecureConnection(): boolean;
    getAmVersion(): string;
    getAuthenticationHeaderOverrides(): Record<string, string>;
    getAuthenticationService(): string;
    getAutoRefreshTimer(): Timeout;
    getBearerToken(): string;
    getBearerTokenMeta(): AccessTokenMetaType;
    getConnectionProfilesPath(): string;
    getCookieName(): string;
    getCookieValue(): string;
    getCreateProgressHandler(): ((type: ProgressIndicatorType, total?: number, message?: string) => string);
    getCurlirize(): boolean;
    getCurlirizeHandler(): ((message: string) => void);
    getDebug(): boolean;
    getDebugHandler(): ((message: string | object) => void);
    getDeploymentType(): string;
    getDirectory(): string;
    getErrorHandler(): ((error: Error, message?: string) => void);
    getFeatures(): FeatureInterface[];
    getFrodoVersion(): string;
    getHost(): string;
    getIdmHost(): string;
    getLogApiKey(): string;
    getLogApiSecret(): string;
    getMasterKeyPath(): string;
    getOutputFile(): string;
    getPassword(): string;
    getPrintHandler(): ((message: string | object, type?: string, newline?: boolean) => void);
    getRealm(): string;
    getServiceAccountId(): string;
    getServiceAccountJwk(): JwkRsa;
    getServiceAccountScope(): string;
    getState(): StateInterface;
    getStopProgressHandler(): ((id: string, message: string, status?: ProgressIndicatorStatusType) => void);
    getTenant(): string;
    getTokenCachePath(): string;
    getUpdateProgressHandler(): ((id: string, message: string) => void);
    getUseBearerTokenForAmApis(): boolean;
    getUseTokenCache(): boolean;
    getUserSessionTokenMeta(): UserSessionMetaType;
    getUsername(): string;
    getVerbose(): boolean;
    getVerboseHandler(): ((message: string | object) => void);
    reset(): void;
    setAdminClientId(type: string): void;
    setAdminClientRedirectUri(type: string): void;
    setAllowInsecureConnection(allowInsecureConnection: boolean): void;
    setAmVersion(version: string): void;
    setAuthenticationHeaderOverrides(overrides: Record<string, string>): void;
    setAuthenticationService(service: string): void;
    setAutoRefreshTimer(timer: Timeout): void;
    setBearerTokenMeta(token: AccessTokenMetaType): void;
    setConnectionProfilesPath(path: string): void;
    setCookieName(name: string): void;
    setCreateProgressHandler(handler: ((type: ProgressIndicatorType, total?: number, message?: string) => string)): void;
    setCurlirize(curlirize: boolean): void;
    setCurlirizeHandler(handler: ((message: string) => void)): void;
    setDebug(debug: boolean): void;
    setDebugHandler(handler: ((message: string | object) => void)): void;
    setDeploymentType(type: string): void;
    setDirectory(directory: string): void;
    setErrorHandler(handler: ((error: Error, message?: string) => void)): void;
    setFeatures(features: FeatureInterface[]): void;
    setFrodoVersion(version: string): void;
    setHost(host: string): void;
    setIdmHost(host: string): void;
    setLogApiKey(key: string): void;
    setLogApiSecret(secret: string): void;
    setMasterKeyPath(path: string): void;
    setOutputFile(file: string): void;
    setPassword(password: string): void;
    setPrintHandler(handler: ((message: string | object, type?: string, newline?: boolean) => void)): void;
    setRealm(realm: string): void;
    setServiceAccountId(uuid: string): void;
    setServiceAccountJwk(jwk: JwkRsa): void;
    setServiceAccountScope(scope: string): void;
    setStopProgressHandler(handler: ((id: string, message: string, status?: ProgressIndicatorStatusType) => void)): void;
    setTenant(tenant: string): void;
    setTokenCachePath(path: string): void;
    setUpdateProgressHandler(handler: ((id: string, message: string) => void)): void;
    setUseBearerTokenForAmApis(useBearerTokenForAmApis: boolean): void;
    setUseTokenCache(useTokenCache: boolean): void;
    setUserSessionTokenMeta(value: UserSessionMetaType): void;
    setUsername(username: string): void;
    setVerbose(verbose: boolean): void;
    setVerboseHandler(handler: ((message: string | object) => void)): void;
}

Type declaration

  • getAdminClientId:function
  • getAdminClientRedirectUri:function
  • getAllowInsecureConnection:function
  • getAmVersion:function
  • getAuthenticationHeaderOverrides:function
    • getAuthenticationHeaderOverrides(): Record<string, string>

    • Returns Record<string, string>

  • getAuthenticationService:function
  • getAutoRefreshTimer:function
  • getBearerToken:function
  • getBearerTokenMeta:function
  • getConnectionProfilesPath:function
  • getCookieName:function
  • getCookieValue:function
  • getCreateProgressHandler:function
  • getCurlirize:function
  • getCurlirizeHandler:function
    • getCurlirizeHandler(): ((message: string) => void)

    • Returns ((message: string) => void)

        • (message: string): void

        • Parameters

          • message: string

          Returns void

  • getDebug:function
  • getDebugHandler:function
    • getDebugHandler(): ((message: string | object) => void)

    • Returns ((message: string | object) => void)

        • (message: string | object): void

        • Parameters

          • message: string | object

          Returns void

  • getDeploymentType:function
  • getDirectory:function
  • getErrorHandler:function
    • getErrorHandler(): ((error: Error, message?: string) => void)

    • Returns ((error: Error, message?: string) => void)

        • (error: Error, message?: string): void

        • Parameters

          • error: Error
          • Optional message: string

          Returns void

  • getFeatures:function
  • getFrodoVersion:function
  • getHost:function
    • getHost(): string

    • Get the AM host base URL

      Returns string

      the AM host base URL

  • getIdmHost:function
    • getIdmHost(): string

    • Get the IDM host base URL

      Returns string

      the IDM host base URL

  • getLogApiKey:function
  • getLogApiSecret:function
  • getMasterKeyPath:function
  • getOutputFile:function
  • getPassword:function
  • getPrintHandler:function
    • getPrintHandler(): ((message: string | object, type?: string, newline?: boolean) => void)

    • Returns ((message: string | object, type?: string, newline?: boolean) => void)

        • (message: string | object, type?: string, newline?: boolean): void

        • Parameters

          • message: string | object
          • Optional type: string
          • Optional newline: boolean

          Returns void

  • getRealm:function
  • getServiceAccountId:function
  • getServiceAccountJwk:function
  • getServiceAccountScope:function
  • getState:function
  • getStopProgressHandler:function
  • getTenant:function
    • getTenant(): string

    • Returns string

      Deprecated

      since v0.17.0 use getHost instead

  • getTokenCachePath:function
  • getUpdateProgressHandler:function
    • getUpdateProgressHandler(): ((id: string, message: string) => void)

    • Returns ((id: string, message: string) => void)

        • (id: string, message: string): void

        • Parameters

          • id: string
          • message: string

          Returns void

  • getUseBearerTokenForAmApis:function
  • getUseTokenCache:function
  • getUserSessionTokenMeta:function
  • getUsername:function
  • getVerbose:function
  • getVerboseHandler:function
    • getVerboseHandler(): ((message: string | object) => void)

    • Returns ((message: string | object) => void)

        • (message: string | object): void

        • Parameters

          • message: string | object

          Returns void

  • reset:function
  • setAdminClientId:function
    • setAdminClientId(type: string): void

    • Parameters

      • type: string

      Returns void

  • setAdminClientRedirectUri:function
    • setAdminClientRedirectUri(type: string): void

    • Parameters

      • type: string

      Returns void

  • setAllowInsecureConnection:function
    • setAllowInsecureConnection(allowInsecureConnection: boolean): void

    • Parameters

      • allowInsecureConnection: boolean

      Returns void

  • setAmVersion:function
    • setAmVersion(version: string): void

    • Parameters

      • version: string

      Returns void

  • setAuthenticationHeaderOverrides:function
    • setAuthenticationHeaderOverrides(overrides: Record<string, string>): void

    • Parameters

      • overrides: Record<string, string>

      Returns void

  • setAuthenticationService:function
    • setAuthenticationService(service: string): void

    • Parameters

      • service: string

      Returns void

  • setAutoRefreshTimer:function
    • setAutoRefreshTimer(timer: Timeout): void

    • Parameters

      • timer: Timeout

      Returns void

  • setBearerTokenMeta:function
  • setConnectionProfilesPath:function
    • setConnectionProfilesPath(path: string): void

    • Parameters

      • path: string

      Returns void

  • setCookieName:function
    • setCookieName(name: string): void

    • Parameters

      • name: string

      Returns void

  • setCreateProgressHandler:function
  • setCurlirize:function
    • setCurlirize(curlirize: boolean): void

    • Parameters

      • curlirize: boolean

      Returns void

  • setCurlirizeHandler:function
    • setCurlirizeHandler(handler: ((message: string) => void)): void

    • Parameters

      • handler: ((message: string) => void)
          • (message: string): void

          • Parameters

            • message: string

            Returns void

      Returns void

  • setDebug:function
    • setDebug(debug: boolean): void

    • Parameters

      • debug: boolean

      Returns void

  • setDebugHandler:function
    • setDebugHandler(handler: ((message: string | object) => void)): void

    • Parameters

      • handler: ((message: string | object) => void)
          • (message: string | object): void

          • Parameters

            • message: string | object

            Returns void

      Returns void

  • setDeploymentType:function
    • setDeploymentType(type: string): void

    • Parameters

      • type: string

      Returns void

  • setDirectory:function
    • setDirectory(directory: string): void

    • Parameters

      • directory: string

      Returns void

  • setErrorHandler:function
    • setErrorHandler(handler: ((error: Error, message?: string) => void)): void

    • Parameters

      • handler: ((error: Error, message?: string) => void)
          • (error: Error, message?: string): void

          • Parameters

            • error: Error
            • Optional message: string

            Returns void

      Returns void

  • setFeatures:function
  • setFrodoVersion:function
    • setFrodoVersion(version: string): void

    • Parameters

      • version: string

      Returns void

  • setHost:function
    • setHost(host: string): void

    • Set the AM host base URL

      Parameters

      Returns void

  • setIdmHost:function
  • setLogApiKey:function
    • setLogApiKey(key: string): void

    • Parameters

      • key: string

      Returns void

  • setLogApiSecret:function
    • setLogApiSecret(secret: string): void

    • Parameters

      • secret: string

      Returns void

  • setMasterKeyPath:function
    • setMasterKeyPath(path: string): void

    • Parameters

      • path: string

      Returns void

  • setOutputFile:function
    • setOutputFile(file: string): void

    • Parameters

      • file: string

      Returns void

  • setPassword:function
    • setPassword(password: string): void

    • Parameters

      • password: string

      Returns void

  • setPrintHandler:function
    • setPrintHandler(handler: ((message: string | object, type?: string, newline?: boolean) => void)): void

    • Parameters

      • handler: ((message: string | object, type?: string, newline?: boolean) => void)
          • (message: string | object, type?: string, newline?: boolean): void

          • Parameters

            • message: string | object
            • Optional type: string
            • Optional newline: boolean

            Returns void

      Returns void

  • setRealm:function
    • setRealm(realm: string): void

    • Parameters

      • realm: string

      Returns void

  • setServiceAccountId:function
    • setServiceAccountId(uuid: string): void

    • Parameters

      • uuid: string

      Returns void

  • setServiceAccountJwk:function
  • setServiceAccountScope:function
    • setServiceAccountScope(scope: string): void

    • Parameters

      • scope: string

      Returns void

  • setStopProgressHandler:function
  • setTenant:function
    • setTenant(tenant: string): void

    • Parameters

      • tenant: string

      Returns void

      Deprecated

      since v0.17.0 use setHost(host: string) instead

  • setTokenCachePath:function
    • setTokenCachePath(path: string): void

    • Parameters

      • path: string

      Returns void

  • setUpdateProgressHandler:function
    • setUpdateProgressHandler(handler: ((id: string, message: string) => void)): void

    • Parameters

      • handler: ((id: string, message: string) => void)
          • (id: string, message: string): void

          • Parameters

            • id: string
            • message: string

            Returns void

      Returns void

  • setUseBearerTokenForAmApis:function
    • setUseBearerTokenForAmApis(useBearerTokenForAmApis: boolean): void

    • Parameters

      • useBearerTokenForAmApis: boolean

      Returns void

  • setUseTokenCache:function
    • setUseTokenCache(useTokenCache: boolean): void

    • Parameters

      • useTokenCache: boolean

      Returns void

  • setUserSessionTokenMeta:function
  • setUsername:function
    • setUsername(username: string): void

    • Parameters

      • username: string

      Returns void

  • setVerbose:function
    • setVerbose(verbose: boolean): void

    • Parameters

      • verbose: boolean

      Returns void

  • setVerboseHandler:function
    • setVerboseHandler(handler: ((message: string | object) => void)): void

    • Parameters

      • handler: ((message: string | object) => void)
          • (message: string | object): void

          • Parameters

            • message: string | object

            Returns void

      Returns void

Settings

Member Visibility

Theme