formcycle 8.3.6 - JavaScript für Formulare
    Bereite Suchindex vor...

    Schnittstelle MetadataUser

    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.

    interface MetadataUser {
        authTypeId?: string;
        displayName: string;
        familyName: string;
        firstName: string;
        gender: "FEMALE" | "MALE" | "DIVERSE" | "UNSPECIFIED";
        groups: string[];
        hasProfile: boolean;
        id?: string;
        linkedId?: string;
        locale?: string;
        location?: string;
        mail: string;
        phone?: string;
        pictureUrl?: string;
        profileUrl?: string;
        rawData?: Record<string, JSON>;
        roles: string[];
        title: "KEINE_ANGABE" | "HERR" | "FRAU" | "DIVERS";
        typedId?: string;
        universalReferenceId: string;
        userName: string;
    }
    Index

    Eigenschaften

    authTypeId? displayName familyName firstName gender groups hasProfile id? linkedId? locale? location? mail phone? pictureUrl? profileUrl? rawData? roles title typedId? universalReferenceId userName

    Eigenschaften

    authTypeId?: string

    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: string

    Der bevorzugte Anzeigename dieses Benutzers.

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

    familyName: string

    Der Nachname dieses Benutzers.

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

    firstName: string

    Der Vorname dieses Benutzers.

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

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

    Das Geschlecht dieses Benutzers.

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

    groups: string[]

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

    hasProfile: boolean

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

    id?: string

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

    Nicht gesetzt, wenn der Benutzer kein Profil hat.

    linkedId?: string

    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).

    locale?: string

    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).

    location?: string

    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: string

    Optionale E-Mail-Adresse dieses Benutzers.

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

    phone?: string

    Die (optionale) Telefonnummer dieses Benutzers.

    Soll entfernt werden. Wird fast immer null sein.

    pictureUrl?: string

    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).

    profileUrl?: string

    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).

    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: string[]

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

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

    Die Anrede dieses Benutzers.

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

    Verwenden Sie gender.

    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: 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: string

    Der Benutzername dieses Benutzers.

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

    Einstellungen

    Member-Sichtbarkeit

    Auf dieser Seite

    Eigenschaften