Interface MetadataCurrentUser

This object contains all the data related to a user within formcycle. To access the user currently signed in, use XFC_METADATA.currentUser. In case the user is not signed in, the user data refers to an anonymous user. For example, the username will be null.

deprecated

This object refers to XFC_METADATA.currentUser, which should not be used anymore. Instead, use XFC_METADATA.user instead.

Hierarchy

  • MetadataCurrentUser

Index

Properties

Properties

Optional WARNING!

WARNING!: string

A warning message informing you that this object is deprecated and scheduled to be removed soon.

Optional active

active: boolean | null
deprecated

The property active was removed, as it is superfluous. Any user that can sign in must necessarily be active. Previously, XFC_METADATA.currentUser.active could never have been false. There is not alternative, as the user is now always active.

Optional email

email: string | null

The email address of this user.

Optional forename

forename: string | null

The first or given name of this user.

Optional ldap

ldap: Record<string, JSON>

Raw user data from the LDAP.

deprecated

See the rawData property of this user for data retrieved from the LDAP.

Optional mandant

mandant: string | null
deprecated

You might want use XFC_METADATA.currentClient instead (the client owning the current form).

Optional role

role: string | null

The (optional) role to which this user was assigned.

Optional surename

surename: string | null

The user's family name or last name.

Optional title

title: "KEINE_ANGABE" | "HERR" | "FRAU" | "DIVERS" | null

The form of address of this user.

Optional usergroups

usergroups: string[]

User groups of the user.

Optional username

username: string | null

The user's username.