Appointment

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:4647

Termin

Extends

• ExtendedCRMObjectBase<Appointment>

Eigenschaften

_instance

protected _instance: Appointment;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:11

Abgeleitet von

ExtendedCRMObjectBase._instance

---

className

protected readonly className: string;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:15

Abgeleitet von

ExtendedCRMObjectBase.className

---

actionDataAsync

Abfragesignatur

get actionDataAsync(): Promise<string>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:4668

Gibt die Daten der Aktion zurück oder setzt diese

Rückgabewert

Promise<string>

---

actionIDAsync

Abfragesignatur

get actionIDAsync(): Promise<TMActionID>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:4690

Gibt die ID der Aktion zurück oder setzt diese

Rückgabewert

Promise<TMActionID>

---

actionTypeAsync

Abfragesignatur

get actionTypeAsync(): Promise<TMActionType>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:4712

Gibt die Art der Ausführung der Aktion zurück oder setzt diese

Rückgabewert

Promise<TMActionType>

---

allDayEventAsync

Abfragesignatur

get allDayEventAsync(): Promise<boolean>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:4734

Gibt an, ob es sich um einen ganztägigen Termin handelt oder legt es fest

Rückgabewert

Promise<boolean>

---

attendeesAsync

Abfragesignatur

get attendeesAsync(): Promise<Attendees>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:4756

Liefert alle Teilnehmer des Termins als Objekt vom Typ Attendees zurück

Rückgabewert

Promise<Attendees>

---

bodyAsync

Abfragesignatur

get bodyAsync(): Promise<string>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:4773

Inhalt/Text des Termins (mit RTF-Formatierung).

Rückgabewert

Promise<string>

---

bodyPlainAsync

Abfragesignatur

get bodyPlainAsync(): Promise<string>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:4795

Inhalt/Text des Termins (ohne RTF-Formatierung).

Rückgabewert

Promise<string>

---

categoriesAsync

Abfragesignatur

get categoriesAsync(): Promise<Categories>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:4817

Liefert alle Kategorien des Termins als Objekt vom Typ Categories zurück

Rückgabewert

Promise<Categories>

---

changeDateAsync

Abfragesignatur

get changeDateAsync(): Promise<Date>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:4834

Letztes Änderungsdatum des Termins

Rückgabewert

Promise<Date>

---

changeUserAsync

Abfragesignatur

get changeUserAsync(): Promise<string>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:4856

Letzter Änderungsbenutzer des Termins.

Rückgabewert

Promise<string>

---

contactAsync

Abfragesignatur

get contactAsync(): Promise<string>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:4878

Kontakt, mit dem der Termin stattfindet ("Mit")

Rückgabewert

Promise<string>

---

creationDate

Abfragesignatur

get creationDate(): Promise<Date>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:4900

Erfassungsdatum des Termins.

Rückgabewert

Promise<Date>

---

creationUserAsync

Abfragesignatur

get creationUserAsync(): Promise<string>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:4922

Erfassungsbenutzer des Termins.

Rückgabewert

Promise<string>

---

endAsync

Abfragesignatur

get endAsync(): Promise<Date>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:4944

Enddatum und –zeit des Termins.

Rückgabewert

Promise<Date>

---

extUserData1Async

Abfragesignatur

get extUserData1Async(): Promise<string>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:4967

Ermöglicht das Hinterlegen von Zusatzinformationen in Form von Zeichenketten (Strings).
Die Zeichenketten können maximal jeweils 250 Zeichen lang werden.

Rückgabewert

Promise<string>

---

extUserData2Async

Abfragesignatur

get extUserData2Async(): Promise<string>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:4991

Ermöglicht das Hinterlegen von Zusatzinformationen in Form von Zeichenketten (Strings).
Die Zeichenketten können maximal jeweils 250 Zeichen lang werden.

Rückgabewert

Promise<string>

---

hostDatabaseAsync

Abfragesignatur

get hostDatabaseAsync(): Promise<string>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5015

Eindeutige Projekt-ID. Der Aufbau ist folgender:
ProjektID|Ansichtenname|Ansichtenfamilienname(optional)|Primärschlüsselfeldname|Primärschlüsselwert|Bezeichnung Datensatzverknüpfung

Rückgabewert

Promise<string>

---

hostIDAsync

Abfragesignatur

get hostIDAsync(): Promise<string>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5038

Setzt die eindeutige ID des (optional) zugeordneten Mutterprogrammes (HOST) des Termins, wie z.B. der Adressverwaltung, oder liest diese aus.

Rückgabewert

Promise<string>

---

hostRecordIDAsync

Abfragesignatur

get hostRecordIDAsync(): Promise<string>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5060

Setzt korrespondierend zu Appointment.hostDatabase die eindeutige Datensatznummerierung des (optional) zugeordneten Datensatzes oder liest diese aus.

Rückgabewert

Promise<string>

---

importanceAsync

Abfragesignatur

get importanceAsync(): Promise<number>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5082

Diese Eigenschaft ermöglicht es die Priorität eines Termins zu setzen und abzufragen.

Rückgabewert

Promise<number>

---

isRecurringAsync

Abfragesignatur

get isRecurringAsync(): Promise<boolean>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5104

Gibt an, ob es sich um einen Serientermin handelt

Rückgabewert

Promise<boolean>

---

linksAsync

Abfragesignatur

get linksAsync(): Promise<Links>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5114

Liefert alle Verknüpfungen des Termins als Objekt vom Typ Links zurück.

Rückgabewert

Promise<Links>

---

locationAsync

Abfragesignatur

get locationAsync(): Promise<string>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5131

Name des Ortes, an dem der Termin stattfindet.

Rückgabewert

Promise<string>

---

private

Abfragesignatur

get private(): Promise<boolean>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5153

Legt fest, ob der Termin als "Privat" markiert werden soll.

Rückgabewert

Promise<boolean>

---

recurrencePatternAsync

Abfragesignatur

get recurrencePatternAsync(): Promise<RecurrencePattern>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5175

Eigenschaften und Einstellungen eines Serientermins. Gibt ein Objekt vom Typ RecurrencePattern zurück.

Rückgabewert

Promise<RecurrencePattern>

---

reminderAsync

Abfragesignatur

get reminderAsync(): Promise<boolean>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5192

Legt fest, ob an diesen Termin erinnert werden soll.

Rückgabewert

Promise<boolean>

---

reminderMinutesBeforeStartAsync

Abfragesignatur

get reminderMinutesBeforeStartAsync(): Promise<number>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5214

Gibt die Anzahl der Minuten zurück, die vor der Fälligkeit an einen Termin erinnert werden soll.

Rückgabewert

Promise<number>

---

startAsync

Abfragesignatur

get startAsync(): Promise<Date>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5237

Startdatum und –zeit des Termins.

Rückgabewert

Promise<Date>

---

subjectAsync

Abfragesignatur

get subjectAsync(): Promise<string>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5259

Beschreibung des Termins.

Rückgabewert

Promise<string>

---

timeStampAsync

Abfragesignatur

get timeStampAsync(): Promise<string>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5283

Zeichenkette die aus dem Änderungsdatum und einem fortlaufender Zahlenwert (als String) besteht. Der Zahlenwert wird bei jeder Datensatzänderung verändert.
Durch diesen Wert kann man auch feststellen, wenn ein Datensatz sich an einem Tag mehrfach geändert hat.
Format: YYYYMMDD:XXXX, z.B. 20010219:0020

Rückgabewert

Promise<string>

---

uniqueIDAsync

Abfragesignatur

get uniqueIDAsync(): Promise<string>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5306

Eindeutige RecordID des Termins.

Rückgabewert

Promise<string>

---

userAsync

Abfragesignatur

get userAsync(): Promise<string>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5328

Eigentümer des Termins.

Rückgabewert

Promise<string>

Konstruktoren

Konstruktor

new Appointment(
   appointment, 
   combitCRMVersion, 
   disposeInstance): Appointment;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:4651

Parameter

Parameter	Type	Default value
appointment	Appointment	undefined
combitCRMVersion	number | CRMVersion	undefined
disposeInstance	boolean	true

Rückgabewert

Appointment

Überschreibt

ExtendedCRMObjectBase<CoreCRM.Appointment>.constructor

Methoden

[asyncDispose]()

asyncDispose: Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:92

Rückgabewert

Promise<void>

Abgeleitet von

ExtendedCRMObjectBase.[asyncDispose]

---

[dispose]()

dispose: void;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:87

Rückgabewert

void

Abgeleitet von

ExtendedCRMObjectBase.[dispose]

---

clearReccurencePatternAsync()

clearReccurencePatternAsync(): Promise<boolean>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5350

Kennzeichnet einen Termin als Einzeltermin und setzt Appointment.isRecurring auf false.

Rückgabewert

Promise<boolean>

---

displayAsync()

displayAsync(wait): Promise<boolean>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5361

Zeigt einen Dialog zum Termin an.

Parameter

Parameter	Type	Description
wait	boolean	Gibt an, ob das Skript auf die Beendigung des Dialoges warten soll

Rückgabewert

Promise<boolean>

---

dispose()

dispose(): void;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:71

Rückgabewert

void

Abgeleitet von

ExtendedCRMObjectBase.dispose

---

disposeAsync()

disposeAsync(): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:55

Rückgabewert

Promise<void>

Abgeleitet von

ExtendedCRMObjectBase.disposeAsync

---

exportAsICalAsync()

exportAsICalAsync(filePath): Promise<boolean>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5373

Exportiert den Termin in das iCal-Format.

Parameter

Parameter	Type	Description
filePath	string	Pfad und Dateiname der zu exportierenden Datei.

Rückgabewert

Promise<boolean>

---

guardDisposed()

protected guardDisposed(): void;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:28

Wift einen Error, wenn die Instanz bereits freigegeben wurde.

Rückgabewert

void

Throws

Error wenn die Instanz bereits freigegeben wurde.

Abgeleitet von

ExtendedCRMObjectBase.guardDisposed

---

isDisposed()

isDisposed(): boolean;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:50

Gibt an, ob die Instanz bereits freigegeben wurde.

Rückgabewert

boolean

true wenn die Instanz bereits freigegeben wurde, andernfalls false.

Abgeleitet von

ExtendedCRMObjectBase.isDisposed

---

removeAsync()

removeAsync(): Promise<boolean>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5384

Löscht den Termin.

Rückgabewert

Promise<boolean>

---

saveAsync()

saveAsync(): Promise<boolean>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5395

Speichert den Termin.

Rückgabewert

Promise<boolean>

---

setActionDataAsync()

setActionDataAsync(value): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:4678

Gibt die Daten der Aktion zurück oder setzt diese

Parameter

Parameter	Type
value	string

Rückgabewert

Promise<void>

---

setActionIDAsync()

setActionIDAsync(value): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:4700

Gibt die ID der Aktion zurück oder setzt diese

Parameter

Parameter	Type
value	TMActionID

Rückgabewert

Promise<void>

---

setActionTypeAsync()

setActionTypeAsync(value): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:4722

Gibt die Art der Ausführung der Aktion zurück oder setzt diese

Parameter

Parameter	Type
value	TMActionType

Rückgabewert

Promise<void>

---

setAllDayEventAsync()

setAllDayEventAsync(value): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:4744

Gibt an, ob es sich um einen ganztägigen Termin handelt oder legt es fest

Parameter

Parameter	Type
value	boolean

Rückgabewert

Promise<void>

---

setBodyAsync()

setBodyAsync(value): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:4783

Inhalt/Text des Termins (mit RTF-Formatierung).

Parameter

Parameter	Type
value	string

Rückgabewert

Promise<void>

---

setBodyPlainAsync()

setBodyPlainAsync(value): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:4805

Inhalt/Text des Termins (ohne RTF-Formatierung).

Parameter

Parameter	Type
value	string

Rückgabewert

Promise<void>

---

setChangeDateAsync()

setChangeDateAsync(value): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:4844

Letztes Änderungsdatum des Termins

Parameter

Parameter	Type
value	Date

Rückgabewert

Promise<void>

---

setChangeUserAsync()

setChangeUserAsync(value): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:4866

Letzter Änderungsbenutzer des Termins.

Parameter

Parameter	Type
value	string

Rückgabewert

Promise<void>

---

setContactAsync()

setContactAsync(value): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:4888

Kontakt, mit dem der Termin stattfindet ("Mit")

Parameter

Parameter	Type
value	string

Rückgabewert

Promise<void>

---

setCreationDateAsync()

setCreationDateAsync(value): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:4910

Erfassungsdatum des Termins.

Parameter

Parameter	Type
value	Date

Rückgabewert

Promise<void>

---

setCreationUserAsync()

setCreationUserAsync(value): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:4932

Erfassungsbenutzer des Termins.

Parameter

Parameter	Type
value	string

Rückgabewert

Promise<void>

---

setEndAsync()

setEndAsync(value): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:4954

Enddatum und –zeit des Termins.

Parameter

Parameter	Type
value	Date

Rückgabewert

Promise<void>

---

setExtUserData1Async()

setExtUserData1Async(value): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:4978

Ermöglicht das Hinterlegen von Zusatzinformationen in Form von Zeichenketten (Strings).
Die Zeichenketten können maximal jeweils 250 Zeichen lang werden.

Parameter

Parameter	Type
value	string

Rückgabewert

Promise<void>

---

setExtUserData2Async()

setExtUserData2Async(value): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5002

Ermöglicht das Hinterlegen von Zusatzinformationen in Form von Zeichenketten (Strings).
Die Zeichenketten können maximal jeweils 250 Zeichen lang werden.

Parameter

Parameter	Type
value	string

Rückgabewert

Promise<void>

---

setHostDatabaseAsync()

setHostDatabaseAsync(value): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5026

Eindeutige Projekt-ID. Der Aufbau ist folgender:
ProjektID|Ansichtenname|Ansichtenfamilienname(optional)|Primärschlüsselfeldname|Primärschlüsselwert|Bezeichnung Datensatzverknüpfung

Parameter

Parameter	Type
value	string

Rückgabewert

Promise<void>

---

setHostIDAsync()

setHostIDAsync(value): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5048

Setzt die eindeutige ID des (optional) zugeordneten Mutterprogrammes (HOST) des Termins, wie z.B. der Adressverwaltung, oder liest diese aus.

Parameter

Parameter	Type
value	string

Rückgabewert

Promise<void>

---

setHostRecordIDAsync()

setHostRecordIDAsync(value): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5070

Setzt korrespondierend zu Appointment.hostDatabase die eindeutige Datensatznummerierung des (optional) zugeordneten Datensatzes oder liest diese aus.

Parameter

Parameter	Type
value	string

Rückgabewert

Promise<void>

---

setImportanceAsync()

setImportanceAsync(value): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5092

Diese Eigenschaft ermöglicht es die Priorität eines Termins zu setzen und abzufragen.

Parameter

Parameter	Type
value	number

Rückgabewert

Promise<void>

---

setLocationAsync()

setLocationAsync(value): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5141

Name des Ortes, an dem der Termin stattfindet.

Parameter

Parameter	Type
value	string

Rückgabewert

Promise<void>

---

setPrivateAsync()

setPrivateAsync(value): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5163

Legt fest, ob der Termin als "Privat" markiert werden soll.

Parameter

Parameter	Type
value	boolean

Rückgabewert

Promise<void>

---

setReminderAsync()

setReminderAsync(value): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5202

Legt fest, ob an diesen Termin erinnert werden soll.

Parameter

Parameter	Type
value	boolean

Rückgabewert

Promise<void>

---

setReminderMinutesBeforeStartAsync()

setReminderMinutesBeforeStartAsync(value): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5225

Gibt die Anzahl der Minuten zurück, die vor der Fälligkeit an einen Termin erinnert werden soll.

Parameter

Parameter	Type	Description
value	number	Anzahl der Minuten

Rückgabewert

Promise<void>

---

setStartAsync()

setStartAsync(value): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5247

Startdatum und –zeit des Termins.

Parameter

Parameter	Type
value	Date

Rückgabewert

Promise<void>

---

setSubjectAsync()

setSubjectAsync(value): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5269

Beschreibung des Termins.

Parameter

Parameter	Type
value	string

Rückgabewert

Promise<void>

---

setUniqueIDAsync()

setUniqueIDAsync(value): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5316

Eindeutige RecordID des Termins.

Parameter

Parameter	Type
value	string

Rückgabewert

Promise<void>

---

setUserAsync()

setUserAsync(value): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:5338

Eigentümer des Termins.

Parameter

Parameter	Type
value	string

Rückgabewert

Promise<void>