APISession

Das Objekt "APISession" kann von jedem Template aus abgerufen werden. Es stellt ein Objekt dar, das sitzungsbezogene Informationen bereithält. Daneben ist es auch möglich, über APISession eigene Werte in der Sitzung von CONTAILOR zu speichern.

Function SetValue(Key As String, Value As String) As Boolean

Speichert einen Wert mit zugehörigem Schlüssel (Identifikator) in der Sitzung. Dieser Wert steht dann während der gesamten Sitzung eines Nutzers zur Verfügung, solange er nicht vorher entfernt wird.
Der Rückgabewert liefert True, wenn das Hinterlegen des Werts erfolgreich war.
Grund für ein erfolgloses Speichern ist meist die Vergabe eines bereits verwendeten Keys.

Key: Schlüssel zur Identifikation des Werts, er muss eindeutig sein
Value: Der zu speichernde Wert. Es können nur String-Werte hinterlegt werden, bei komplexeren Datentypen, wie etwa einem Json-Objekt, ist auf entsprechende (De)Codierung zu achten.

Copy

APISession.SetValue("myKey", "myValue")

Function GetValue(Key As String) As String

Liefert den Wert aus dem Sitzungsobjekt, der mit dem gegebenen Schlüssel hinterlegt wurde.
Existiert kein Wert zum gegebenen Schlüssel, wird Nothing geliefert.

Key: Schlüssel zur Identifikation des Werts

Copy

APISession.GetValue("myKey")

Function RemoveValue(Key As String) As Boolean

Entfernt den Wert aus dem Sitzungsobjekt, der mit dem gegebenen Schlüssel hinterlegt wurde.
Existiert kein Wert zum gegebenen Schlüssel, wird keine Aktion ausgeführt und die Funktion liefert False.
Der Rückgabewert gibt damit an, ob das Entfernen erfolgreich war.

Key: Schlüssel zur Identifikation des Werts

Copy

APISession.RemoveValue("myKey")

ReadOnly Property EntryDomain As String

Liefert die Domain, mit der die Seite ursprünglich aufgerufen wurde.

Copy

APISession.EntryDomain

ReadOnly Property EntryURL As String

Liefert die URL, mit der die Seite ursprünglich aufgerufen wurde.

Copy

APISession.EntryURL

ReadOnly Property EntryReferrer As String

Liefert den Referrer der Ursprungsseite.

Copy

APISession.EntryReferrer

Public Property OptInAccepted As Boolean

Gibt an, ob per Opt-In zugestimmt wurde (True) oder nicht (False).

Copy

APISession.OptInAccepted

Public Property OptInValueSet As Boolean

Gibt an, ob bereits ein Opt-In-Wert gesetzt wurde, unabhängig davon, ob zugestimmt oder abgelehnt wurde.
Hintergrund: Man kann bei OptInAccepted nicht unterscheiden, ob gar nichts geklickt oder nicht zugestimmt wurde

Copy

APISession.OptInValueSet

Public Function GetLoggedInUser() As Core.API.iPerson

Liefert den aktuell angemeldeten Benutzer. Ist keiner angemeldet, kommt Nothing zurück.

Copy

APISession.GetLoggedInUser()

Public Function IsUserLoggedIn(UserToCheck As Core.API.iPerson) As Boolean

Gibt an, ob derzeit der gegebene Benutzer am System angemeldet ist.

Copy

APISession.IsUserLoggedIn(MyUser)

War dieser Beitrag hilfreich?

10 von 10 fanden dies hilfreich.

Schade! Bitte teilen Sie uns doch mit was Ihnen nicht weitergeholfen hat.

Es ist ein technisches Problem aufgetreten. Bitte wenden Sie sich telefonisch oder per E-Mail an uns.