UserManagement

Methods

(static) blockUser(userId) → {Promise.<(any|string|null)>}

Description:
  • Block the provided user
Source:
Parameters:
Name Type Description
userId
Returns:
Type
Promise.<(any|string|null)>

(static) blockedUsers() → {Promise.<Array.<BlockedUsersDTO>>}

Description:
  • Fetches the blocked users for the current user.
Source:
Returns:
Type
Promise.<Array.<BlockedUsersDTO>>

(static) deletePicture(pictureUrl) → {Promise.<any>}

Source:
Parameters:
Name Type Description
pictureUrl string
Returns:
Type
Promise.<any>

(static) getUserData(userIdopt) → {Promise.<(User|null)>}

Source:
Parameters:
Name Type Attributes Default Description
userId number <optional>
 globalConfig.sessionConfig.userId
Returns:
Type
Promise.<(User|null)>

(static) getUserSignature() → {Promise.<{signature: string}>}

Description:
  • Retrieves the current signature for the authenticated user.
Source:
Returns:
- A promise that resolves with the user's current signature data.
Type
Promise.<{signature: string}>

(static) isUsernameAvailable(userName) → {Promise.<{available: boolean}>}

Source:
Parameters:
Name Type Description
userName The display name to check for availability.
Returns:
- An object indicating if the display name is available.
Type
Promise.<{available: boolean}>

(static) setUserSignature(params) → {Promise.<{signature: string}>}

Description:
  • Updates the user's signature.
Source:
Parameters:
Name Type Description
params SetUserSignatureParams Parameters containing the user's signature.
Returns:
- A promise that resolves with the updated signature data.
Type
Promise.<{signature: string}>

(static) toggleSignaturePrivate(showSignatureopt) → {Promise.<{show_signature: boolean}>}

Description:
  • Toggles whether the user's signature is displayed publicly.
Source:
Parameters:
Name Type Attributes Default Description
showSignature boolean <optional>
 true Whether to show (`true`) or hide (`false`) the user's signature.
Returns:
- A promise that resolves with the updated visibility state.
Type
Promise.<{show_signature: boolean}>

(static) unblockUser(userId) → {Promise.<(any|string|null)>}

Description:
  • Unblock the provided user. Returns a 422 if the user wasn't blocked
Source:
Parameters:
Name Type Description
userId
Returns:
Type
Promise.<(any|string|null)>

(static) updateBrand(brand) → {Promise.<{brand: string}>}

Description:
  • Updates the user's brand.
Source:
Parameters:
Name Type Description
brand string The brand to assign to the user.
Returns:
- A promise that resolves with the updated brand.
Type
Promise.<{brand: string}>

(static) updateDisplayName(newDisplayName) → {Promise.<User>}

Source:
Parameters:
Name Type Description
newDisplayName The new display name to set for the user.
Returns:
- A promise that resolves when the display name is updated.
Type
Promise.<User>

(static) uploadPicture(fieldKey, file) → {Promise.<string>}

Description:
  • Upload a picture to the server
Source:
Parameters:
Name Type Description
fieldKey string
file File
Returns:
Type
Promise.<string>

(static) uploadPictureFromS3(fieldKey, s3_bucket_path) → {Promise.<(any|string|null)>}

Description:
  • Saves a picture uploaded to S3
Source:
Parameters:
Name Type Description
fieldKey string
s3_bucket_path string
Returns:
Type
Promise.<(any|string|null)>