Update User Information

Update User Information

Update current user information, including display name, avatar, user description, metadata, etc., using the updateUser method in the 'amityClient' class. This method updateUser accepts these optional parameters:

The method accepts the following optional parameters:

• displayName - user's display name

• description - user's description

• avatarFile - file ID of the user's avatar

• avatarCustomUrl - custom url of the user's avatar

• roles - user's role

• metadata - user's metadata

iOS

Update the current user data

Android

JavaScript

The updateCurrentUser method accepts the following optional parameters:

• displayName - user's display name

• description - user's description

• avatarFile - file ID of the user's avatar

• avatarCustomUrl - custom url of the user's avatar

• roles - user's role

• metadata - user's metadata

Below is a sample code on how to update the current user's display name, description, and metadata. This method returns a promise. If the update is successful, the method will return true, else it throws an error.

const myMetadata = { whatever: “i want”, toPass: “is ok” }

const success = await amityClient.updateCurrentUser({
  displayName: "Batman",
  description : "Hero that Gotham needs",
  metadata: myMetadata,
})

TypeScript

Flag/Unflag Users

To flag a user, call the following method:

To unflag a user, call the following method:

To check if the user is flagged by the current user:

Flutter

Update Current User's Avatar

You can upload an image and set it as an avatar for the current user.

iOS

First, you need to upload image using AmityFileRepository and then update the image info.

Step 1 — Upload an image:

Create AmityFileRepository

Upload an image with AmityFileRepository

Step 2 — Passing AmityImageData from step 1 into the builder, and call user update API.

Update the current user avatar

If you have an avatar present in your current system/server and just want to integrate that existing avatar to AmitySDK, you can just set the URL for the avatar directly.

Update user custom avatar

Note: getAvatarInfo provides the information associated with a particular Avatar

Android

First, you need to upload image and then update the image info. If you have an avatar present in your current system/server and just want to integrate that existing avatar to AmitySDK, you can just set the URL for the avatar directly.

If you have an avatar present in your current system/server and just want to integrate that existing avatar to AmitySDK, you can just set the URL for the avatar directly.

JavaScript

Either you wish to let us handle your user's avatar, or if you already have a system for it we got you covered. The 2 properties avatarFileId and avatarCustomUrl answer those two use-cases separately.

You can easily retrieve the url of a file from our FileRepository object and use it to display in your app later on. Here's an example in React:

import { useState, useEffect, useMemo } from 'react'

// our image component
const FileImage = ({ fileId }) => {
  const [fileUrl, setFileUrl] = useState()

  useEffect(() => {
    const liveObject = FileRepository.fileInformationForId(fileId)

    liveObject.on('dataUpdated', model => setFileUrl(model.fileUrl))
    liveObject.model && setFileUrl(liveObject.model.fileUrl)

    return () => {
      liveObject.dispose()
    }
  }, [fileId])

  return fileUrl ? <img src={fileUrl} /> : null
}

// our user component
const UserHeader = ({ userId }) => {
  const [user, setUser] = useState({})

  const displayName = useMemo(
    () => user?.displayName ?? user?.userId,
    [user],
  )

  useEffect(() => {
    const liveObject = UserRepository.getUser(userId)

    liveObject.on('dataUpdated', setUser)
    liveObject.model && setUser(liveObject.model)

    return () => {
      liveObject.dispose()
    }
  }, [userId])

  return (
    <div>
     {user.avatarFileId && <FileImage fileId={user.avatarFileId} />}
     {user.avatarCustomUrl && <img src={user.avatarCustomUrl} />}
    </div>
  )
} 

TypeScript

You can easily retrieve the url of a file using observeFile and use it to display in your app later on. Here's an example in React:​

Flutter