Interface IUserUpdater

Updating a user is a more granular approach, since it is one of the more sensitive aspects of Rocket.Chat - or any other system for that matter.

Allowing apps to modify all the aspects of a user would open a critical surface for them to abuse such power and "take hold" of a server, for instance.

Hierarchy

IUserUpdater

Index

Methods

deactivate updateBio updateCustomFields updateStatus updateStatusText

Methods

deactivate

deactivate(userId, confirmRelinquish): Promise<boolean>
Parameters
- userId: string
- confirmRelinquish: boolean
Returns Promise<boolean>
- Defined in src/definition/accessors/IUserUpdater.ts:17

updateBio

updateBio(user, bio): Promise<boolean>
Parameters
- user: IUser
- bio: string
Returns Promise<boolean>
- Defined in src/definition/accessors/IUserUpdater.ts:15

updateCustomFields

updateCustomFields(user, customFields): Promise<boolean>
Parameters
- user: IUser
- customFields: {
  [key: string]: any;
  }
  - [key: string]: any
Returns Promise<boolean>
- Defined in src/definition/accessors/IUserUpdater.ts:16

updateStatus

updateStatus(user, statusText, status): Promise<boolean>
Parameters
- user: IUser
- statusText: string
- status: string
Returns Promise<boolean>
- Defined in src/definition/accessors/IUserUpdater.ts:14

updateStatusText

updateStatusText(user, statusText): Promise<boolean>
Parameters
- user: IUser
- statusText: string
Returns Promise<boolean>
- Defined in src/definition/accessors/IUserUpdater.ts:13

Generated using TypeDoc