Interface User

interface User {
    accountId?: string;
    accountStatus?: AccountStatus;
    accountType?: AccountType;
    displayName?: string;
    email?: string;
    isExternalCollaborator?: boolean;
    personalSpaceId?: string;
    profilePicture?: null | Icon;
    publicName?: string;
    timeZone?: string;
}

Hierarchy

  • Record<string, unknown>
    • User

Properties

accountId? accountStatus? accountType? displayName? email? isExternalCollaborator? personalSpaceId? profilePicture? publicName? timeZone?

Properties

OptionalaccountId

accountId?: string

Account ID of the user.

OptionalaccountStatus

accountStatus?: AccountStatus

The account status of the user.

OptionalaccountType

accountType?: AccountType

The account type of the user.

OptionaldisplayName

displayName?: string

Display name of the user.

Optionalemail

email?: string

The email address of the user. Depending on the user's privacy setting, this may return an empty string.

OptionalisExternalCollaborator

isExternalCollaborator?: boolean

Whether the user is an external collaborator.

OptionalpersonalSpaceId

personalSpaceId?: string

Space ID of the user's personal space. Returns null, if no personal space for the user.

OptionalprofilePicture

profilePicture?: null | Icon

This object represents an icon. If used as a profilePicture, this may be returned as null, depending on the user's privacy setting.

OptionalpublicName

publicName?: string

Public name of the user.

OptionaltimeZone

timeZone?: string

Time zone of the user. Depending on the user's privacy setting, this may return null.

Settings

Member Visibility

On This Page

Properties