Class UserService

Hierarchy

BaseService
- UserService

Index

Constructors

constructor

Properties

Constructors

constructor

new UserService(options: IRocosClientOptions): UserService

Inherited from BaseService.constructor
- Defined in src/services/base-service.ts:9
Parameters
- options: IRocosClientOptions
Returns UserService

Properties

Protected httpRequest

httpRequest: HttpRequest

Protected options

options: IRocosClientOptions

Methods

acceptInvitation

acceptInvitation(invitationId: string): Observable<RocosResponse<any>>

- Defined in src/services/user-service.ts:88
Accept invitation by id

Parameters
- invitationId: string
  
  Invitation Id
Returns Observable<RocosResponse<any>>

accountDetails

accountDetails(accountId: string): Observable<RocosResponse<any>>

- Defined in src/services/user-service.ts:268
Parameters
- accountId: string
Returns Observable<RocosResponse<any>>

accountSettings

accountSettings(accountId: string): Observable<RocosResponse<any>>

- Defined in src/services/user-service.ts:411
Get account settings.

Parameters
- accountId: string
  
  The account ID
Returns Observable<RocosResponse<any>>

activateAccount

activateAccount(accountId: string): Observable<RocosResponse<any>>

- Defined in src/services/user-service.ts:113
Activate account by id

Parameters
- accountId: string
  
  Account Id
Returns Observable<RocosResponse<any>>

applicationAuth

applicationAuth(appId: string, appKey: string): Observable<RocosResponse<any>>

- Defined in src/services/user-service.ts:287
Parameters
- appId: string
- appKey: string
Returns Observable<RocosResponse<any>>

checkInvitation

checkInvitation(invitationId: string): Observable<RocosResponse<IInvitationExists>>

- Defined in src/services/user-service.ts:101
Check invitation by id

Parameters
- invitationId: string
  
  Invitation Id
Returns Observable<RocosResponse<IInvitationExists>>

createAccount

createAccount(accountName: string): Observable<RocosResponse<any>>

- Defined in src/services/user-service.ts:276
Parameters
- accountName: string
Returns Observable<RocosResponse<any>>

createApplication

createApplication(accountId: string, projectId: string, model: IProjectApplication): Observable<RocosResponse<IProjectApplication>>

- Defined in src/services/user-service.ts:307
Create a new application

Parameters
- accountId: string
  
  The account ID
- projectId: string
  
  The project ID
- model: IProjectApplication
  
  Payload
Returns Observable<RocosResponse<IProjectApplication>>

createInvitation

createInvitation(invitation: Invitation): Observable<RocosResponse<any>>

- Defined in src/services/user-service.ts:47
Create a new invitation

Parameters
- invitation: Invitation
  
  Invitation body
Returns Observable<RocosResponse<any>>

createPAT

createPAT(pat: PersonalAccessToken): Observable<RocosResponse<PersonalAccessToken>>

- Defined in src/services/user-service.ts:224
Parameters
- pat: PersonalAccessToken
Returns Observable<RocosResponse<PersonalAccessToken>>

deleteApplication

deleteApplication(accountId: string, projectId: string, applicationId: string): Observable<RocosResponse<any>>

- Defined in src/services/user-service.ts:391
Delete application

Parameters
- accountId: string
  
  The account ID
- projectId: string
  
  The project ID
- applicationId: string
  
  The application ID
Returns Observable<RocosResponse<any>>

deleteInvitations

deleteInvitations(email: string, inviteType: string): Observable<RocosResponse<any>>

- Defined in src/services/user-service.ts:71
Delete invitations by email and invite ytpe

Parameters
- email: string
  
  Email
- inviteType: string
  
  Invite type, e.g. PROJECT, ACCOUNT
Returns Observable<RocosResponse<any>>

getAllApplications

getAllApplications(accountId: string, projectId: string): Observable<RocosResponse<any>>

- Defined in src/services/user-service.ts:327
List all applications

Parameters
- accountId: string
  
  The account ID
- projectId: string
  
  The project ID
Returns Observable<RocosResponse<any>>

getAllPATs

getAllPATs(projectId: string, robotDefinitionId: string): Observable<RocosResponse<any>>

- Defined in src/services/user-service.ts:234
Parameters
- projectId: string
- robotDefinitionId: string
Returns Observable<RocosResponse<any>>

getApplication

getApplication(accountId: string, projectId: string, applicationId: string): Observable<RocosResponse<any>>

- Defined in src/services/user-service.ts:346
Get application information

Parameters
- accountId: string
  
  The account ID
- projectId: string
  
  The project ID
- applicationId: string
  
  The application ID
Returns Observable<RocosResponse<any>>

getOnePAT

getOnePAT(token: string): Observable<RocosResponse<any>>

- Defined in src/services/user-service.ts:251
Parameters
- token: string
Returns Observable<RocosResponse<any>>

getToken

getToken(): Observable<RocosResponse<any>>

- Defined in src/services/user-service.ts:37
Get a new valid token

Returns Observable<RocosResponse<any>>

info

info(): Observable<RocosResponse<any>>

- Defined in src/services/user-service.ts:28
Get the information of current user

Returns Observable<RocosResponse<any>>

listAccountUsers

listAccountUsers(accountId: string): Observable<RocosResponse<any>>

- Defined in src/services/user-service.ts:196
List account users

Parameters
- accountId: string
  
  Account Id
Returns Observable<RocosResponse<any>>

listInvitations

listInvitations(): Observable<RocosResponse<any>>

- Defined in src/services/user-service.ts:59
List invitations

Returns Observable<RocosResponse<any>>

listProjectUsers

listProjectUsers(accountId: string, projectId: string): Observable<RocosResponse<any>>

- Defined in src/services/user-service.ts:212
List project users

Parameters
- accountId: string
  
  Account Id
- projectId: string
  
  Project Id
Returns Observable<RocosResponse<any>>

loginWithOnetimeToken

loginWithOnetimeToken(token: string): Observable<RocosResponse<AuthResponse>>

- Defined in src/services/user-service.ts:440
Login with one-time token

Parameters
- token: string
Returns Observable<RocosResponse<AuthResponse>>

removeAccountAccess

removeAccountAccess(accountId: string, userId: string): Observable<RocosResponse<any>>

- Defined in src/services/user-service.ts:178
Revoke user's account access

Parameters
- accountId: string
  
  Account Id
- userId: string
  
  User Id
Returns Observable<RocosResponse<any>>

removePATById

removePATById(id: string): Observable<RocosResponse<any>>

- Defined in src/services/user-service.ts:259
Parameters
- id: string
Returns Observable<RocosResponse<any>>

removeProjectAccess

removeProjectAccess(accountId: string, projectId: string, userId: string): Observable<RocosResponse<any>>

- Defined in src/services/user-service.ts:158
Revoke user's project access

Parameters
- accountId: string
  
  Account Id
- projectId: string
  
  Project Id
- userId: string
  
  User Id
Returns Observable<RocosResponse<any>>

resendVerificationEmail

resendVerificationEmail(email: string): Observable<RocosResponse<any>>

- Defined in src/services/user-service.ts:126
Resend verification email

Parameters
- email: string
  
  Email
Returns Observable<RocosResponse<any>>

sendForgottenPasswordEmail

sendForgottenPasswordEmail(email: string): Observable<RocosResponse<any>>

- Defined in src/services/user-service.ts:141
Send forgotten password email

Parameters
- email: string
  
  Email
Returns Observable<RocosResponse<any>>

updateAccountSettings

updateAccountSettings(accountId: string, settings: any): Observable<RocosResponse<any>>

- Defined in src/services/user-service.ts:425
Update account settings

Parameters
- accountId: string
  
  The account ID
- settings: any
  
  The updated account settings
Returns Observable<RocosResponse<any>>

updateApplication

updateApplication(accountId: string, projectId: string, applicationId: string, model: any): Observable<RocosResponse<any>>

- Defined in src/services/user-service.ts:368
Update application information

Parameters
- accountId: string
  
  The account ID
- projectId: string
  
  The project ID
- applicationId: string
  
  The application ID
- model: any
  
  Payload
Returns Observable<RocosResponse<any>>

Generated using TypeDoc