Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AsteroidUser

Hierarchy

  • AsteroidUser

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private currentAccessToken

currentAccessToken: string | undefined

Private currentRefreshToken

currentRefreshToken: string | undefined

Private logger

logger: Logger

Private options

options: AsteroidUserOptions

Accessors

accessToken

  • get accessToken(): string | undefined

asteroidDomainUserBaseUrl

  • get asteroidDomainUserBaseUrl(): string

asteroidDomainWorkerBaseUrl

  • get asteroidDomainWorkerBaseUrl(): string

id

  • get id(): string

refreshToken

  • get refreshToken(): string | undefined

Methods

claimTask

  • claimTask(taskId: string): Promise<void>

createAttributes

createClaim

createProfile

  • createProfile(remark: string, profileType: ProfileType): Promise<string>

createProfilePrivToken

  • createProfilePrivToken(profileId: string, remark: string, active?: boolean): Promise<ProfilePrivItem>

createTask

  • createTask(taskType: string, taskVersion: string, taskPriority: number, payload: object): Promise<string>

  • Parameters

    • taskType: string
    • taskVersion: string
    • taskPriority: number
    • payload: object

    Returns Promise<string>

    ID of the newly created task

deleteAttributes

deleteProfile

  • deleteProfile(profileId: string): Promise<void>

deleteProfilePriv

  • deleteProfilePriv(privilegeId: string): Promise<void>

exchangeCode

  • exchangeCode(code: string): Promise<string>

  • exchanges a vivid oauth2 code for a profile token

    Parameters

    • code: string

      the code provided by the authenticated user

    Returns Promise<string>

getActiveTaskIds

  • getActiveTaskIds(): Promise<string[]>

getAttributeHeadersByTypes

getAttributesByIds

getClaimById

  • getClaimById(claimId: string): Promise<UserClaim>

getFlatProfileById

  • getFlatProfileById(profileId: string): Promise<UserProfile>

getLatestLogsByTypes

  • getLatestLogsByTypes(types: string[]): Promise<UserLog[]>

getLogHeadersByTypes

  • getLogHeadersByTypes(types: string[], startTimestamp: number, endTimestamp: number): Promise<UserLogHeader[]>

getLogsByIds

getOwnedProfileHeaders

getPrivUniqueViews

getPrivViews

getPrivViewsSeries

getProfileById

  • getProfileById(profileId: string): Promise<UserProfile>

getProfilePrivs

getProfileUniqueViews

getProfileViews

getProfileViewsSeries

getTaskById

getTasksByState

getUnclaimedTask

getUserMnemonic

Private invokeOrRefreshToken

  • invokeOrRefreshToken(baseUrl: string, method: any, req: any): Promise<any>

logout

  • logout(): Promise<void>

modifyProfileComponents

quarantineTask

  • quarantineTask(taskId: string, quarantineReason: string): Promise<void>

registerWorker

  • registerWorker(accessPoint: string): Promise<void>

reissueClaim

  • reissueClaim(claimId: string): Promise<void>

resetTask

resolveTask

  • resolveTask(taskId: string): Promise<void>

sendProfileTokenByEmail

  • sendProfileTokenByEmail(privilegeId: string, targetEmails: string[], message: string): Promise<void>

  • Parameters

    • privilegeId: string
    • targetEmails: string[]
    • message: string

    Returns Promise<void>

setAccessToken

  • setAccessToken(token: string): void

setRefreshToken

  • setRefreshToken(token: string): void

setUserGroupByEmail

  • setUserGroupByEmail(email: string, group: string, secret: string): Promise<void>

submitWorkflowToken

  • submitWorkflowToken(dynamicToken: string, payload?: undefined | object): Promise<void>

  • Parameters

    • dynamicToken: string
    • Optional payload: undefined | object

    Returns Promise<void>

unclaimTask

  • unclaimTask(taskId: string): Promise<void>

updateAttributes

updatePasswordJwt

  • updatePasswordJwt(password: string): Promise<void>

updateProfile

  • updateProfile(profileId: string, remark: string): Promise<void>

updateProfilePriv

  • updateProfilePriv(privilegeId: string, remark: string, active: boolean): Promise<void>

  • Parameters

    • privilegeId: string
    • remark: string
    • active: boolean

    Returns Promise<void>

Private validateOptionalParameters

  • validateOptionalParameters(): void

vividCreateProfile

vividCreateProfilePrivCode

vividGetAppInformation

Generated using TypeDoc