Observe logged-in user data

Observe data about the logged-in user to customize the experience


Overview

This method allows you to observe data about the logged-in user, including live updates.
import { user } from '@cord-sdk/react';
const data = user.useViewerData();
Copy

Usage

import { user } from '@cord-sdk/react';
const data = user.useViewerData();
return (
  <div>
    {!data && "Loading..."}
    {data && (
      <p>User name: {data.name}</p>
      <p>User short name: {data.shortName}</p>
      <p>User profile picture: <img src={data.profilePictureURL} /></p>
      <p>Organization ID: {data.organizationID}</p>
    )}
  </div>
);
Copy

Available Data

The API provides an object which has the following fields:


id

UserID
The user's ID. This is unique within an application.

name

string | null
The user's name.

shortName

string | null
The user's short name. In most cases, Cord components will prefer using this name over name when set.

profilePictureURL

string | null
A URL to the user's profile picture.

metadata

EntityMetadata
Any metadata that has been set for the user.

organizationID

OrganizationID
The identifier for the organization that the current user is using.

What this function returns

The hook will initially return undefined while the data loads from our API. Once it has loaded, your component will re-render and the hook will return an object containing the fields described under "Available Data" above. The component will automatically re-render if any of the data changes, i.e., this data is always "live".

Arguments this function takes


None