Dieses Objekt enthält alle Daten zu einem Benutzer innerhalb von formcycle. Um auf den aktuell angemeldeten Benutzer zuzugreifen, verwenden Sie XFC_METADATA.user. Falls der Benutzer nicht angemeldet ist, beziehen sich die Benutzerdaten auf einen anonymen Benutzer. Zum Beispiel ist die universalReferenceId auf ANONYMOUS gesetzt.

Hierarchy

  • MetadataUser

Index

Properties

Optional authTypeId

authTypeId: string | null

Der Name der verwendeten Anmeldemethode.

Nicht gesetzt, wenn der Benutzer kein Profil hat, null wenn die Anmeldemethode unbekannt ist (z.B. ein anonymer Benutzer).

displayName

displayName: string | null

Der bevorzugte Anzeigename dieses Benutzers.

null, wenn der Benutzer keinen Anzeigenamen hat (z.B. ein anonymer Benutzer).

familyName

familyName: string | null

Der Nachname dieses Benutzers.

null, wenn der Benutzer keinen Nachnamen hat (z.B. ein anonymer Benutzer).

firstName

firstName: string | null

Der Vorname dieses Benutzers.

null, wenn der Benutzer keinen Vornamen hat (z.B. ein anonymer Benutzer).

gender

gender: "FEMALE" | "MALE" | "DIVERSE" | "UNSPECIFIED" | null

Das Geschlecht dieses Benutzers.

null, wenn der Benutzer kein Geschlecht hat. Ein anonymer Benutzer hat diese Eigenschaft auf UNSPECIFIED gesetzt.

groups

groups: string[]

Eine Liste von Benutzergruppen, zu denen dieser Benutzer gehört. Kann leer sein, wenn der Benutzer keiner Gruppe angehört.

hasProfile

hasProfile: boolean

Ob der Benutzer ein Profil hat. Das Profil wird verwendet, um benutzerspezifische Einstellungen und Daten zu speichern.

Optional id

id: string

Eine eindeutige ID dieses Benutzers, abhängig von der Anmeldemethode.

Nicht gesetzt, wenn der Benutzer kein Profil hat.

Optional linkedId

linkedId: string | null

Kennung eines anderen Benutzerprofils, das mit diesem Benutzer verknüpft ist. Es gehört normalerweise zum selben physischen Benutzer.

Nicht gesetzt, wenn der Benutzer kein Profil hat, null, wenn er kein verknüpftes Profil hat (z.B. ein anonymer Benutzer).

Optional locale

locale: string | null

Die bevorzugte Sprache oder das bevorzugte Gebietsschema des Benutzers, wie en oder de.

Nicht gesetzt, wenn der Benutzer kein Profil hat, null, wenn er kein bevorzugtes Gebietsschema hat (z.B. ein anonymer Benutzer).

Optional location

location: string | null

Der Standort des Benutzers.

Nicht gesetzt, wenn der Benutzer kein Profil hat, null, wenn er keinen Standort festgelegt hat (z.B. ein anonymer Benutzer).

mail

mail: string | null

Optionale E-Mail-Adresse dieses Benutzers.

null, wenn der Benutzer keine E-Mail-Adresse hat, z.B. ein anonymer Benutzer.

Optional phone

phone: string | null

Die (optionale) Telefonnummer dieses Benutzers.

deprecated

Soll entfernt werden. Wird fast immer null sein.

Optional pictureUrl

pictureUrl: string | null

Eine URL zu einem Bild des Benutzers.

Nicht gesetzt, wenn der Benutzer kein Profil hat, null, wenn er kein Bild festgelegt hat (z.B. ein anonymer Benutzer).

Optional profileUrl

profileUrl: string | null

Eine URL zum Profil des Benutzers.

Nicht gesetzt, wenn der Benutzer kein Profil hat, null, wenn keine Profil-URL verfügbar ist (z.B. ein anonymer Benutzer).

Optional rawData

rawData: Record<string, JSON>

Alle Attribute des Benutzers, die von der Anmeldemethode zurückgegeben wurden. Der Inhalt dieses JSON-Objekts hängt von der Anmeldemethode ab.

Sie sollten zuerst den Wert von authTypeId überprüfen und sicherstellen, dass er mit der erwarteten Anmeldemethode übereinstimmt, bevor Sie auf diese Attribute zugreifen.

Nicht gesetzt, wenn der Benutzer kein Profil hat.

roles

roles: string[]

Die formcycle-Rollen, denen dieser Benutzer zugewiesen wurde. Kann leer sein, wenn der Benutzer keiner Rolle angehört.

title

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

Die Anrede dieses Benutzers.

null, wenn der Benutzer keine Anrede hat. Ein anonymer Benutzer hat diese Eigenschaft auf KEINE_ANGABE gesetzt.

deprecated

Verwenden Sie gender.

Optional typedId

typedId: string

Eine Benutzerkennung mit einem Präfix, das der Profiltyp ist (vollständiger Java-Klassenname mit Paket).

Diese Kennung ist eindeutig für alle Anmeldemethoden.

Nicht gesetzt, wenn der Benutzer kein Profil hat.

universalReferenceId

universalReferenceId: string

Die universelle Referenz-ID dieses Benutzers. Diese ID ist eindeutig für alle Anmeldemethoden und wird verwendet, um denselben Benutzer über verschiedene Anmeldemethoden hinweg zu identifizieren.

Ein anonymer Benutzer hat diese Eigenschaft auf ANONYMOUS gesetzt.

userName

userName: string | null

Der Benutzername dieses Benutzers.

null, wenn der Benutzer keinen Benutzernamen hat (z.B. ein anonymer Benutzer).