Menü der Dokumentation

Verwenden der Klasse “OpenAPI”

Die Klasse dvelop_docs_dev.OpenAPI bietet verschiedene Funktionen, die die Arbeit mit DMS-Dokumenten in Apex vereinfachen.

Signatur
global class OpenAPI
Inhalt

Methoden

Methoden

Die Klasse OpenAPI stellt folgende Methoden zur Verfügung:

salesforceDatetimeToDMSDatetimeString(salesforceDatetime)

Wandelt ein Apex-Datetime-Objekt in eine Zeichenkette um. Die Zeichenkette wird vom angebundenen DMS unterstützt. Eigenschaftsfelder in d.velop documents benötigen unter Umständen ein konkretes Format für Datumsangaben. In diesem Fall kann die Methode ein bestehendes salesforceDatetime-Objekt in den notwendigen String umwandeln.

Signatur
global static String salesforceDatetimeToDMSDatetimeString(Datetime salesforceDatetime)
Parameter

  • salesforceDatetime: Ein salesforceDatetime-Objekt in Salesforce, das in eine Zeichenkette umgewandelt werden soll. Die Zeichenkette wird im angebundenen DMS unterstützt.

    Datentyp: Datetime

Rückgabe

Eine Zeichenkette, die von Eigenschaften des Typs Datum im DMS akzeptiert wird.

getValidCookieForCurrentUser()

Liefert einen gültigen Cookie für den angemeldeten Benutzer.

Signatur
global static String getValidCookieForCurrentUser()
Rückgabe

Der Cookie des angemeldeten Benutzers.

getValidCookieForConfigUser()

Liefert einen gültigen Cookie für den Servicebenutzer, der in der d.velop documents-Konfiguration gespeichert ist.

Signatur
global static String getValidCookieForConfigUser()
Rückgabe

Der Cookie des Servicebenutzers aus der d.velop documents-Konfiguration.

generateCredentials()

Meldet den angemeldeten Benutzer beim zugrundeliegenden DMS an. Die Methode speichert Cookies für die weitere Verwendung.

Wir empfehlen, diese Methode am Anfang einer Operationskette zu verwenden und alle folgenden Operationen beispielsweise asynchron in einer Queue abzuarbeiten. So stellst du sicher, dass immer gültige Cookies zur Authentifizierung vorhanden sind.

Signatur
global static void generateCredentials()
generateConfigUserCredentials()

Meldet den in der d.velop documents-Konfiguration angegebenen Servicebenutzer beim zugrundeliegenden DMS an. Die Methode speichert Cookies für die weitere Verwendung.

Wir empfehlen, diese Methode am Anfang einer Operationskette zu verwenden und alle folgenden Operationen beispielsweise asynchron in einer Queue abzuarbeiten. So stellst du sicher, dass immer gültige Cookies zur Authentifizierung vorhanden sind.

Signatur
global static void generateConfigUserCredentials()
initializeTestEnvironment()

Erstellt die minimal notwendigen Daten und HTTP-Mocks für Unit-Tests.

Signatur
global static void initializeTestEnvironment()
createStub(parentType, stubProvider)

Erstellt einen Stub des gegebenen parentType-Typs mithilfe der Stub API im dvelop_docs_dev-Namespace.

Signatur
global static Object createStub(System.Type parentType, System.StubProvider stubProvider)
Parameter

  • parentType: Der Typ des Stubs, der erstellt werden soll.

    Datentyp: System.Type

  • stubProvider: Die Provider-Klasse, die die Methodenaufrufe an der erstellten Stub-Instanz bearbeiten soll.

    Datentyp: System.StubProvider

Rückgabe

Die erstellte Stub-Instanz zur Verwendung in Tests.