EmailToolMailing

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:8483

Das EmailToolMailing-Objekt beinhaltet Eigenschaften und Methoden, um eine Kampagne zu erstellen, anzuzeigen und dessen Auswertungen abzufragen.

Extends

• ExtendedCRMObjectBase<EmailToolMailing>

Eigenschaften

_instance

protected _instance: EmailToolMailing;

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

Abgeleitet von

ExtendedCRMObjectBase._instance

---

className

protected readonly className: string;

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

Abgeleitet von

ExtendedCRMObjectBase.className

---

existsAsync

Abfragesignatur

get existsAsync(): Promise<boolean>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:8543

Rückgabewert

Promise<boolean>

---

idAsync

Abfragesignatur

get idAsync(): Promise<string>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:8526

Liefert die ID der aktuellen Kampagnen zurück.

Rückgabewert

Promise<string>

---

lastErrorAsync

Abfragesignatur

get lastErrorAsync(): Promise<OLEError>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:8509

Liefert ein OLEError-Objekt zurück.

Rückgabewert

Promise<OLEError>

---

statusAsync

Abfragesignatur

get statusAsync(): Promise<number>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:8536

Liefert den Status der aktuellen Kampagnen zurück.

Rückgabewert

Promise<number>

Konstruktoren

Konstruktor

new EmailToolMailing(
   emailToolMailing, 
   combitCRMVersion, 
   disposeInstance): EmailToolMailing;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:8493

Konstruktor für das EmailToolMailing-Objekt.

Parameter

Parameter	Type	Default value	Description
emailToolMailing	EmailToolMailing	undefined	Die CoreCRM.EmailToolMailing-Instanz.
combitCRMVersion	number | CRMVersion	undefined	Die Version des combit CRM, entweder als Zahl oder als CRMVersion-Instanz.
disposeInstance	boolean	true	Gibt an, ob die Instanz beim Freigeben des Objekts freigegeben werden soll. Standard ist true.

Rückgabewert

EmailToolMailing

Überschreibt

ExtendedCRMObjectBase<CoreCRM.EmailToolMailing>.constructor

Methoden

[asyncDispose]()

asyncDispose: Promise<void>;

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

Rückgabewert

Promise<void>

Abgeleitet von

ExtendedCRMObjectBase.[asyncDispose]

---

[dispose]()

dispose: void;

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

Rückgabewert

void

Abgeleitet von

ExtendedCRMObjectBase.[dispose]

---

addRecipientListAsync()

addRecipientListAsync(recipientListId): Promise<boolean>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:8581

Weist der aktuellen Kampagne eine Empfänger-Liste über dessen ID zu.

Parameter

Parameter	Type	Description
recipientListId	string	Eindeutige ID der Empfänger-Liste, die für die Kampagnen verwendet werden soll. Hinweis: Aktuell wird nur eine Empfänger-Liste pro Kampagne unterstützt!

Rückgabewert

Promise<boolean>

---

displayAsync()

displayAsync(): Promise<boolean>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:8603

Versucht die Kampagne direkt im Zielsystem zu öffnen, sofern das eingestelle System dies unterstützt.

Rückgabewert

Promise<boolean>

---

dispose()

dispose(): void;

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

Rückgabewert

void

Abgeleitet von

ExtendedCRMObjectBase.dispose

---

disposeAsync()

disposeAsync(): Promise<void>;

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

Rückgabewert

Promise<void>

Abgeleitet von

ExtendedCRMObjectBase.disposeAsync

---

getPropertyAsync()

getPropertyAsync(name): Promise<unknown>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:8568

Darüber können für eine Kampagne spezifische Eigenschaften abgerufen werden.

Parameter

Parameter	Type	Description
name	string	Name der Eigenschaft

Rückgabewert

Promise<unknown>

---

getResultsAsync()

getResultsAsync(): Promise<EmailToolMailingResults>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:8613

Liefert ein EmailToolMailingResults-Objekt zurück, um diverse Statistiken und Rückläufer der Kampagne abfragen zu können.

Rückgabewert

Promise<EmailToolMailingResults>

---

guardDisposed()

protected guardDisposed(): void;

Definiert in: lib/combitCRM.SDK.v12.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.v12.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

---

saveAsync()

saveAsync(): Promise<string>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:8592

Speichert die neu erstellte Kampagne mit den Werten aus SetProperty im Zielsystem ab und liefert die neue ID dafür zurück.

Rückgabewert

Promise<string>

---

setPropertyAsync()

setPropertyAsync(name, value): Promise<boolean>;

Definiert in: lib/combitCRM.SDK.v12.Extended.ts:8556

Darüber können für eine ausschließlich neue Kampagne spezifische Eigenschaften gesammelt werden, die dann später bei der Speicherung berücksichtigt werden.

Parameter

Parameter	Type	Description
name	string	Name der Eigenschaft
value	unknown	Wert für die Eigenschaft

Rückgabewert

Promise<boolean>