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 first name (currentUser.surename) is set to [Anonymous].

Hierarchy

  • MetadataCurrentUser

Index

Properties

WARNING!

WARNING!: string

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

active

active: "ACTIVE" | "LOCKED" | "DELETED"
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.

preferred

DOES_NOT_EXIST_ANYMORE_AS_USER_IS_ALWAYS_ACTIVE

Optional email

email: string
deprecated

Use the property mail instead.

preferred

mail

Optional forename

forename: undefined

The first or given name of this user.

deprecated

Use the property firstName instead.

preferred

firstName

ldap

ldap: object

/**

deprecated

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

preferred

rawData

Type declaration

  • [key: string]: any

Optional mandant

mandant: string
deprecated

The property mandant was removed. You might want use XFC_METADATA.currentClient instead, but please note that this is the client owning the current form, not the client of the user.

preferred

MANDANT_DOES_NOT_EXIST_ON_USER_OBJECT_ANYMORE

Optional phonennumber

phonennumber: string
deprecated

Use the property phone instead.

preferred

phone

Optional role

role: string

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

surename

surename: string
deprecated

Use the property familyName instead.

preferred

familyName

title

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

The form of address of this user.

usergroups

usergroups: string[]
deprecated

Use the property groups instead.

preferred

groups

Optional username

username: string
deprecated

Use the property userName instead.

preferred

userName