Table of Contents

Ti.App.ex

addBarButton(bottomBar, activator)

Fügt ein activator-Objekt als Button zur oberen oder unteren Leiste des aktuellen Schritts hinzu.

Parameter Typ Beschreibung
bottomBar Bool Wenn true, wird der Button in die untere Leiste eingefügt, ansonsten in die obere.
activator Object Definition eines activator-Objects, das als Button verwendet werden soll.

cleanupDatabase()

Löscht alle gespeicherten Datenbanktabellen, die Nutzerdaten zum aktuellen Prozess beinhalten, und erstellt diese neu.

copyAttributeValues(sourceModel, destinationModel, attributeMapping, save)

Kopiert Attribute eines Models in ein anderes.

Parameter Typ Beschreibung
sourceModel Object Model einer Entity, von dem die Attributwerte kopiert werden sollen.
destinationModel Object Model einer Entity, dem die kopierten Attribute zugewiesen werden.
attributeMapping Array Array zum Mappen der Attribute von Quell- zu Ziel-Model. Syntax: [['sourceAttribute1', 'destinationAttribute1'], ['sourceAttribute2', 'destinationAttribute2'], ...]
save Boolean Speichert das Ziel-Model direkt nach Aufruf dieser Methode in die Datenbank. Dieser Wert ist standardmäßig true.

Returns Boolean : true im Erfolgsfall, sonst false.

copyFile(source, destination, placeholder)

Kopiert eine Datei von einem Quellpfad zu einem Zielpfad.

Parameter Typ Beschreibung
source String Pfad zur Quelldatei.
destination String Pfad zur Zieldatei.
placeholder String Optional. Pfad zu einer alternativen Quelldatei, die verwendet wird, wenn die eigentliche Quelldatei nicht vorhanden ist.

Returns String : Pfad zur Zieldatei.

copyModel(model)

Gibt eine Kopie eines Models zurück.

Parameter Typ Beschreibung
model Object Das zu kopierende Model.

Returns Object : Das kopierte Model.

copyModelByViewID(viewName)

Gibt das Model einer Ansicht zurück.

Parameter Typ Beschreibung
viewName String Name der Ansicht aus welcher das Model kopiert werden soll.

Returns Object : Das kopierte Model.

decodeBase64(encodedString)

Dekodiert einen base64-kodierten String.

Parameter Typ Beschreibung
encodedString String String im base64-Format.

Returns String : im Erfolgsfall der dekodierte String, ansonsten der kodierte String.

encodeBase64(str)

Kodiert einen String in das base64-Format.

Parameter Typ Beschreibung
str String Der zu kodierende String.

Returns String : Der kodierte String.

forceModelChanged(changeDefinition)

Forciert die Aktualisierung des Models bei einer oder mehrerer Ansichten.

Parameter Typ Beschreibung
changeDefinition Array Object Informationen zum Neuladen einer Ansicht. Mögliche Strukturen sind ein einzelnes Model, ein Array von Models oder ein Objekt mit weiteren Optionen: {model:model, changedAttributes[], apply:true bzw. false}.

formatString(format, args)

Formatiert einen String mit Hilfe von Formatparametern (z.B. %s, %f,...).

Parameter Typ Beschreibung
format String Der String, in dem die Formatparameter durch die gegebenen Texte ersetzt werden.
args Array String Array der zu ersetzenden Texte.

Returns String : Den formatierten String.

getAllUsers()

Gibt alle Nutzer in der Datenbank oder den zuletzt angemeldeten Nutzer zurück.

Returns Array : Ein Array aller Datenbankbenutzer.

getAttributeValue(model, attribute, forDisplay)

Gibt den Wert eines Attributs zurück.

Parameter Typ Beschreibung
model Object Model, von dem der Attributwert abgefragt wird.
attribute String Name des abzufragenden Attributs.
forDisplay Bool Falls das Attribut ein Model ist, kann mit diesem Flag der Anzeigename des Models statt seiner PitID als Attributwert verwendet werden.

Returns String Number Date : Den Wert des Attributs.

getCurrentContracts()

Gibt alle für den aktuellen Benutzer registrierten Prozesse zurück.

Returns Array : Ein Array aller Prozesse des aktuellen Benutzers.

getDBDateConstraint(attributeName, date)

Gibt ein SQL-Constraint für genau einen Tag zurück.

Parameter Typ Beschreibung
attributeName String Attributname auf den sich der Vergleich bezieht.
date Date Datum des zu vergleichenden Tages.

Returns String : Das SQL-Constraints.

getDBTodayConstraint(attributeName)

Gibt ein SQL-Constraint für den heutigen Tag zurück.

Parameter Typ Beschreibung
attributeName String Attributname auf den sich der Vergleich bezieht.

Returns String : Das SQL-Constraints.

getLastLoggedInUser()

Gibt das Model des zuletzt angemeldeten Benutzers zurück.

Returns Object : Das Model des zuletzt angemeldeten Benutzers.

getModelByName(classNameOrModel, constraint, attributes)

Gibt das Objekt einer Klasse zurück, welches dem angegebenen Constraint genügt. Wenn kein oder mehr als ein Objekt aus dem Constraint resultiert wird stattdessen null übergeben.

Parameter Typ Beschreibung
classNameOrModel String Object Name der Vertragsklasse des Models oder Objekt dieser Klasse.
constraint String SQL-Constraint, das zur Eingrenzung des gewünschten Objekts benutzt wird.
attributes Array Array von Attributnamen, die auf dem übergebenen Model stehen sollen.

Returns Object : Das Objekt einer Klasse, das dem Constraint entspricht.

getModelFromReference(model, attributeName)

Gibt das Model eines referenzierten Datensatzes zurück.

Parameter Typ Beschreibung
model Object Model, an dem das Referenzattribut definiert ist.
attributeName String Name des Referenzattributs.

Returns Object : Das Model des referenzierten Datensatzes.

getModelFromViewID(viewName, fromDatabase, searchViewStack)

Gibt das Entity Model einer Ansicht zurück.

Parameter Typ Beschreibung
viewName String Name der Ansicht, die das Model beinhaltet.
fromDatabase Boolean true, wenn das Model neu aus der Datenbank geholt werden soll, ansonsten false.
searchViewStack Boolean Ein Wert, der angibt, ob die Ansicht im kompletten Navigationsstapel der App oder nur innerhalb der sichtbaren Fenster gesucht werden soll.

Returns Object : Das Entity Model einer Ansicht.

getListElementsToModel(model, attributeName)

Gibt die Datensätze eines Listenattributs für das angegebene Model zurück.

Parameter Typ Beschreibung
model Object Das Model mit dem Listenattribut.
attributeName String Name des Listenattributs.

Returns Array : Ein Array der Datensätze des angegebenen Listenattributs.

invertListItemSelection(viewName)

Schaltet die Selektierung aller Listeneinträge um.

Parameter Typ Beschreibung
viewName String Name der Listenansicht.

loadFileIfNotExists(pathData, fireEventOnLoadSuccess, okCallback, cancelCallback)

Lädt die Datei eines Dokumentendatensatzes vom Webserver herunter.

Parameter Typ Beschreibung
pathData Object Ein Objekt mit Informationen zur Datei. Besteht aus den Eigenschaften 'className' (Tabellenname der Dokumentenklasse) und 'path' (Wert des Pfadattributs des Dokuments).
fireEventOnLoadSuccess Boolean Gibt an, ob bei erfolgreichem Herunterladen eine Callback-Funktion ausgeführt werden soll. Standardwert: false.
okCallback Function Eine Funktion, die ausgeführt wird, wenn das Herunterladen erfolgreich war.
cancelCallback Function Eine Funktion, die ausgeführt wird, wenn das Herunterladen fehlgeschlagen ist.

openURL(url)

Öffnet eine URL, indem die plattformspezifischen Standard-Apps für das jeweilige Protokoll verwendet werden. Häufige Anwendungsfälle sind:

  • Das Öffnen von Webseiten im Standardbrowser mit "https://www.pit.de/"
  • Das Anrufen einer Telefonnummer über die Telefon-App mit "tel:012345678".
    Bemerkung

    Die Telefonnummer darf keine Leerzeichen beinhalten.

  • Das Entwerfen von Emails für den Standard-Email-Client mit
    "mailto:foo@example.com?cc=bar@example.com&subject=Hier%20steht%20der%20Betreff&body=Hier%20steht%20die%20Nachricht"
Parameter Typ Beschreibung
url String Ziel-URL.

Returns Boolean : true im Erfolgsfall, sonst false.

selectAllListItems(viewName, select)

Selektiert bzw. deselektiert alle Listeneinträge.

Parameter Typ Beschreibung
viewName String Name der Listenansicht.
select Boolean Optional. Falls true, werden alle Listeneinträge selektiert, falls false werden alle Listeneinträge deselektiert. Wird der Parameter nicht übergeben, wird der Modus abhängig von den bereits selektierten Einträgen ermittelt.

setAttributeValues(model, attributes, save)

Setzt Attribute eines Models anhand eines Arrays von Attributen.

Parameter Typ Beschreibung
model Object Model einer Entity, der Attribute gesetzt werden sollen.
attributes Array Array von Objekten mit Attributnamen und neuem Wert.
save Boolean Speichert das Model direkt nach Aufruf dieser Methode in die Datenbank. Dieser Wert ist standardmäßig true.

Returns Boolean : true im Erfolgsfall, sonst false.

setContractToCurrentUser(contractName)

Aktiviert für den aktuellen Benutzer den angebenen Prozess.

Parameter Typ Beschreibung
contractName String Vertragsname des Prozesses.

Returns Boolean : true im Erfolgsfall, sonst false.

setTitle(title, fromDetail)

Setzt den Titel der aktuellen App-Seite.

Parameter Typ Beschreibung
title String Neuer Titel der App-Seite.
fromDetail Bool true, falls im Tablet-Modus der rechte (Detail-)Bereich der App-Seite betroffen ist.