Hilfe-Center

Enum

Enums sind feste Wertelisten, die direkt über den Code angesprochen und verarbeitet werden können.

Enums werden in den API-Funktionen bislang nur als Rückgabewert bestimmter Funktionen verwendet. Sie finden dann Verwendung, wenn sich z.B. der Status einer Funktion nicht sinnvoll durch andere Rückgabewerte wie Integer oder Boolean darstellen lässt. 

API.Enum.Person

Stellt den Typ ("Rolle") des Personenobjekts dar.

  • Administrator
  • User

API.Enum.LoginState

Stellt den aktuellen Status des Loginvorgangs dar.

Mögliche Werte:

  • EmptyIdentity: Kein Benutzername eingegeben
  • InvalidIdentity: Kein passender Benutzername gefunden
  • EmptyPassword: Kein Passwort eingegeben
  • InvalidPassword: Passwort passt nicht zum Benutzer
  • LoggedIn: Benutzer ist eingeloggt
  • Locked: Benutzer ist gesperrt
  • Inactive: Benutzer ist nicht aktiv geschaltet

API.Enum.SaveResult [V2]

Stellt den Status eines Speichervorgangs dar. Welche Werte dieses Enums im Detail von welcher Methode zurückgegeben wird, findet sich als Angabe bei der jeweiligen Funktion. Disabled, NotAllowed, Saved, NoChanges und Failed können immer geliefert werden.

Mögliche Werte:

  • Saved: Das Element wurde gespeichert
  • NoChanges: Es gibt keine Änderungen auf dem Element
  • Failed: Das Element konnte nicht gespeichert werden
  • NotAllowed: Die Aktion ist für die ausführende Person nicht erlaubt
  • AlreadyExists: Das Element existiert bereits - nur bei Neuanlage
  • CheckedOut: Die Seite, in der etwas bearbeitet werden soll, wird gerade von einer anderen Person barbeitet
  • InvalidValue: Es wurde ein Parameter angegeben, der für die Aktion nicht gültig ist
  • APIDisabled: Die Content-API ist durch die Einstellung im Backend ausgeschaltet
  • InvalidObject: Das Objekt welches geprüft wird ist nicht gültig
  • IsWorkflow: Die Änderung konnte nicht gespeichert werden, weil die Seite im Workflow liegt

API.Enum.ShapeSaveResult [V2]

Stellt den Status eines Speichervorgangs dar. Welche Werte dieses Enums im Detail von welcher Methode zurückgegeben wird, findet sich als Angabe bei der jeweiligen Funktion. Disabled, NotAllowed, Saved, NoChanges und Failed können immer geliefert werden.

Mögliche Werte:

  • Saved: Das Element wurde gespeichert
  • NoChanges: Es gibt keine Änderungen auf dem Element
  • Failed: Das Element konnte nicht gespeichert werden
  • NotAllowed: Die Aktion ist für die ausführende Person nicht erlaubt
  • AlreadyExists: Das Element existiert bereits - nur bei Neuanlage
  • MoveIntoItself: Derzeit noch nicht in Verwendung - Bedeutet, dass beim Verschieben ein Element in sich selbst verschoben würde
  • CheckedOut: Die Seite, in der etwas bearbeitet werden soll, wird gerade von einer anderen Person barbeitet
  • InvalidValue: Es wurde ein Parameter angegeben, der für die Aktion nicht gültig ist
  • Disabled: Die Content-API ist durch die Einstellung im Backend ausgeschaltet
  • InvalidObject: Das Objekt welches geprüft wird ist nicht gültig
  • IsWorkflow: Die Änderung konnte nicht gespeichert werden, weil die Seite im Workflow liegt

API.Enum.DeleteResult [V2]

Stellt den Status eines Löschvorgangs dar. Welche Werte dieses Enums im Detail von welcher Methode zurückgegeben wird, findet sich als Angabe bei der jeweiligen Funktion. Disabled, NotAllowed, Saved, NoChanges und Failed können immer geliefert werden.

Mögliche Werte:

  • Deleted: Das Element wurde erfolgreich gelöscht
  • InUse: Das Element wird noch verwendet und kann daher nicht gelöscht werden, z.B. Verwendungen eines Bilds
  • Failed: Das Element konnte nicht gelöscht werden
  • NotAllowed: Die Aktion ist für die ausführende Person nicht erlaubt
  • InvalidValue: Es wurde ein Parameter angegeben, der für die Aktion nicht gültig ist
  • Disabled: Die Content-API ist durch die Einstellung im Backend ausgeschaltet

API.Enum.ShapeDeleteResult [V2]

Stellt den Status eines Löschvorgangs dar. Welche Werte dieses Enums im Detail von welcher Methode zurückgegeben wird, findet sich als Angabe bei der jeweiligen Funktion. Disabled, NotAllowed, Saved, NoChanges und Failed können immer geliefert werden.

Mögliche Werte:

  • Deleted: Das Element wurde erfolgreich gelöscht
  • InUse: Das Element wird noch verwendet und kann daher nicht gelöscht werden, z.B. Verwendungen eines Bilds
  • Failed: Das Element konnte nicht gelöscht werden
  • NotAllowed: Die Aktion ist für die ausführende Person nicht erlaubt
  • MinPage: Das Element kann nicht gelöscht werden, da es die Seite, in dem es liegt, seine Existenz verlangt
  • MinSubShape: Das Element kann nicht gelöscht werden, da es das Shape, in dem es liegt, seine Existenz verlangt
  • InvalidValue: Es wurde ein Parameter angegeben, der für die Aktion nicht gültig ist
  • Disabled: Die Content-API ist durch die Einstellung im Backend ausgeschaltet

API.Enum.LinkCheckResult

Stellt den Status der Speicherung eines externen Links dar.

Mögliche Werte:

  • Valid: Die Ziel-URL ist direkt erreichbar
  • Invalid: Die Ziel-URL ist nicht erreichbar, liefert als HTTP-Status z.B. 4** oder 5**
  • IsTemporaryRedirect: Die URL ist erreichbar, leitet aber temporär weiter, z.B. HTTP-Status 302
  • IsPermanentRedirect: Die URL ist erreichbar, leitet aber permanent weiter, z.B. HTTP-Status 301

API.Enum.CheckPasswordResult

Stellt den Status der Änderung eines Passworts dar.

Mögliche Werte:

  • Valid: Das Passwort ist gültig
  • TooShort: Das Passwort ist zu kurz
  • TooLong: Das Passwort ist zu lang
  • MissingUpperCaseChar: Ein Großbuchstabe fehlt
  • MissingLowerCaseChar: Ein Kleinbuchstabe fehlt
  • MissingNumber: Eine Zahl fehlt
  • MissingSpecialChar: Ein Sonderzeichen fehlt

API.Enum.PersonGroupType

Stellt den Typ von Personengruppen dar.

Mögliche Werte:

  • UserAndAdministrator: Benutzer und Administrator zusammen
  • User: Benutzer

API.Enum.NewsletterResult

Stellt den Status der Eintragung/Änderung einer Newsletteranmeldung dar.

Mögliche Werte:

  • Failed: Die Eintragung war nicht erfolgreich
  • Duplicate: Es gibt bereits einen entsprechenden Eintrag
  • DoubleOptIn: Es muss die Bestätigungsmail beachtet werden
  • Success: Die Eintragung war erfolgreich
War dieser Beitrag hilfreich?
1 von 2 fanden dies hilfreich.
Es ist ein technisches Problem aufgetreten. Bitte wenden Sie sich telefonisch oder per E-Mail an uns.