GoodData JS SDK GoodDataJS
gooddata-js v13.5.0

util Class

Defined in: src/util.ts:8
Module: util

Utility methods. Mostly private

Show:

getAccountInfo

()

Provided by the project module.

Defined in src/user.ts:174

Returns info about currently logged in user from bootstrap resource

getAccountInfoInBootstrap

(
  • bootstrapData
)

Provided by the project module.

Defined in src/user.ts:185

Returns current user info from bootstrapData

Parameters

  • bootstrapData Object
    • data was got from bootstrap resource

getCurrentProfile

() Promise

Provided by the project module.

Defined in src/user.ts:152

Gets current user's profile

Returns

Promise:

Resolves with account setting object

getFeatureFlags

()

Provided by the project module.

Defined in src/user.ts:230

Returns the feature flags valid for the currently logged in user.

getIn

(
  • path
)
private

Defined in src/util.ts:22

Create getter function for accessing nested objects

Parameters

  • path String

    Target path to nested object

isLoggedIn

() Promise

Provided by the project module.

Defined in src/user.ts:26

Find out whether a user is logged in

Returns

Promise:

resolves with true if user logged in, false otherwise

isLoggedInProject

(
  • projectId
)
Promise

Provided by the project module.

Defined in src/user.ts:53

Find out whether a specified project is available to a currently logged user

Parameters

  • projectId String

    A project identifier

Returns

Promise:

Resolves with true if user logged in and project available, resolves with false if user logged in and project not available, rejects if user not logged in

login

(
  • username
  • password
)

Provided by the project module.

Defined in src/user.ts:83

This function provides an authentication entry point to the GD API. It is needed to authenticate by calling this function prior any other API calls. After providing valid credentials every subsequent API call in a current session will be authenticated.

Parameters

  • username String
  • password String

loginSso

(
  • encryptedClaims
  • ssoProvider
  • targetUrl
)

Provided by the project module.

Defined in src/user.ts:108

This function provides an authentication entry point to the GD API via SSO https://help.gooddata.com/display/developer/GoodData+PGP+Single+Sign-On

Parameters

  • encryptedClaims String

    PGP message

  • ssoProvider String
  • targetUrl String

logout

()

Provided by the project module.

Defined in src/user.ts:129

Logs out current user

updateProfileSettings

(
  • profileId
  • profileSetting
)

Provided by the project module.

Defined in src/user.ts:161

Updates user's profile settings

Parameters

  • profileId String
    • User profile identifier
  • profileSetting Object

© GoodData 2019