Interface für die Klasse ContextApi. Mehr ...

Klassendiagramm für ContextSDK.IContextApi:

Öffentliche Methoden
Task< Guid >	LoginAsync (string userName, string password)
	Loggt sich bei der API ein und holt den notwendigen JWT, welcher für alle API-Zugriffe verwendet wird Mehr ...

Task< Guid >	CreateFileAndUploadToCommunicationAsync (Guid communicationGuid, CreateMessageWithFileModel createMessageWithFileModel)
	Erstellt die Datei Meta-Daten und ladet die Datei hoch. Mehr ...

Task	UploadFileChunkedAsync (Guid communicationGuid, Guid fileGuid, string filePath)
	Ladet eine Datei hoch. Dafür muss die Datei (die Meta-Daten) bereits erstellt sein. Mehr ...

Task	DownloadFileChunkedAsync (Guid communicationGuid, Guid fileGuid, string targetFilePath)
	Ladet eine Datei herunter. Mehr ...

Task< string >	GetOrRequestCryptoKeyAsync (Guid? communicationGuid)
	Holt den Schlüssel für die kryptografischen Vorgänge zu dieser Kommunikation. Mehr ...

Task< Guid?>	CreateNewCryptoKeysForNewCommunication ()
	Erstellt einen neuen Kryptografischen Schlüssel. Dies wird benötigt, um eine Kommunikation zu erstellen, da manche Daten der Kommunikation bereits verschlüsselt sind. Deswegen wird auch die Guid der Kommunikation zurückgegeben, welche auch benötigt wird um eine neue Kommunikation zu erstellen. Der kryptografische Schlüssel kann mit GetOrRequestCryptoKeyAsync angefragt werden. Mehr ...

Task< ApiStatus >	GetApiStatusAsync ()
	Gibt den aktuellen Status der API zurück Mehr ...

Task< string >	GetGeneratedPasswordAsync (int? length=null)
	Kann verwendet werden, um ein Passwort zu generieren, welches alle Passwortrichtlinien bei der Erstellung von Benutzer erfüllt. Mehr ...

Task< List< object > >	GetStatisticsAsync (DateTime from, DateTime to, bool extended)
	Liefert Statistiken zum aktuell angemeldeten Benutzer. Mehr ...

Task< string >	GetFormattedPhoneNumberAsync (string phoneNumber)
	Formatiert eine Telefonnummer und prüft diese auch auf Korrektheit. Mehr ...

Task< List< ActivityBase > >	GetActivitiesAsync (long? lastRequestTimestamp)
	Liefert eine Liste mit allen Aktivitäten, welche seit diesem Zeitpunkt erstellt wurden. Es wird empfohlen den lastRequestTimestamp von der API nehmen und nicht die lokale zeit in Unix-Millisekunden umzuwandeln Mehr ...

Task< List< ActivityBase > >	GetActivitiesAsync (Guid? lastGuid)
	Liefert eine Liste mit allen Aktivitäten, welche seit der angegebenen Aktivität erstellt wurden. Mehr ...

Task< List< ActivityBase > >	GetActivityAsync (Guid activityGuid)
	Holt eine einzelne Aktivität mit der angegebenen Guid. Mehr ...

Task< int >	GetActivityCountAsync (long? lastTsp)
	Holt die Anzahl von Aktivitäten, welche seit dem angegebenen Zeitpunkt erstellt wurden. Mehr ...

Task	NotifyByEmailAsync (Guid communicationGuid, Guid participantGuid, string email, string mailText, EmailNotificationTemplateType mailTemplateType, NotificationLinkType notificationLinkType)
	Sendet eine Benachrichtigung per Email and die angegebene Email-Adresse. Mehr ...

Task	NotifyBySmsAsync (Guid communicationGuid, Guid participantGuid, string smsText, NotificationLinkType notificationLinkType)
	Sendet eine Benachrichtigung per SMS and die angegebene Telefonnummer. Mehr ...

Task	SendSmsAsync (string phoneNumber, string text)
	Sendet eine SMS an die gewünschte Telefonnummer. Mehr ...

Task< FileMetaData >	GetFileMetaDataAsync (Guid fileResourceGuid)
	Holt die Meta-Daten für eine Datei. Mehr ...

Task< FileChunksMetaData >	GetFileChunksAsync (Guid fileResourceGuid)
	Holt die Meta-Daten der Datei-Chunks für die angegebene Datei. Diese Meta-Daten werden benötigt, um eine Datei herunterzuladen, da darin die Chunk-Guids enthalten sind mit denen die einzelnen Chunks anschließend heruntergeladen werden können. Mehr ...

Task	DownloadChunkAsync (Stream downloadedData, Guid communicationGuid, Guid fileResourceGuid, Guid chunkGuid, string chunkCheckSum=null)
	Ladet einen bestimmten Chunk einer Datei herunter. Wenn chunkCheckSum angegeben wird, wird diese überprüft. Mehr ...

Task	UploadChunkAsync (Guid communicationGuid, Guid fileResourceGuid, MemoryStream chunkData, int currentChunkNumber, int numberOfChunks, string encryptedFileName)
	Lädt einen Datei-Chunk zu einer existierenden Datei hoch. Mehr ...

Task	ConfirmDownloadSuccessfulAsync (Guid fileResourceGuid)
	Bestätigt den erfolgreichen Download einer Datei. Dies erzeugt anschließend eine FileDownloadedActivity, welche verwendet werden kann, um festzustellen, welche Personen bereits diese Datei heruntergeladen haben. Mehr ...

Task< List< ContextCommunication > >	GetCommunicationsAsync ()
	Liefert eine Liste von allen Kommunikationen auf die der angemeldete Benutzer Zugriff hat. Mehr ...

Task< Guid >	CreateCommunicationAsync (CreateCommunicationModel createCommunicationModel)
	Erstellt eine neue Kommunikation. Mehr ...

Task	DeleteCommunicationAsync (Guid communicationGuid)
	Löscht eine Kommunikation. Mehr ...

Task	UpdateCommunicationAsync (Guid communicationGuid, ContextCommunicationUpdateModel model)
	Bearbeitet eine Kommunikation. Mehr ...

Task< EndOfLifeTimeModel >	GetCommunicationDeletionDateTimeAsync (Guid communicationGuid)
	Holt den Zeitpunkt zu dem diese Kommunikation automatisch gelöscht wird. Mehr ...

Task< List< Guid > >	GetKnownCommunicationsAsync ()
	Liefert eine Guids von Kommunikationen zu denen der angemeldete Benutzer Zugriff hat. Mehr ...

Task< List< ActivityBase > >	GetActivitiesForCommunicationAsync (Guid communicationGuid, Guid? lastActivityGuid)
	Liefert alle Aktivitäten der angegebenen Kommunikation. Optional kann eine Aktivitäts-Guid angegeben werden, sodass nur Aktivitäten geholt werden die älter als die angegebene Aktivität sind. Mehr ...

Task< int >	GetCountActivitiesForCommunicationAsync (Guid communicationGuid, Guid? lastGuidToCountFrom)
	Liefert die Anzahl der Aktivitäten der angegebenen Kommunikation. Optional kann eine Aktivitäts-Guid angegeben werden, sodass nur Aktivitäten gezählt werden die älter als die angegebene Aktivität sind. Mehr ...

Task< List< Guid > >	GetFilesInCommunicationAsync (Guid communicationGuid)
	Holt alle Dateien der angegebenen Kommunikation.. Mehr ...

Task< Guid >	CreateFileMetaDataForCommunicationAsync (Guid communicationGuid, string localFilePath, string fileDisplayName, string message)
	Erstellt die Meta-Daten einer Datei. Dies ist notwendig bevor eine Datei hochgeladen werden kann. Mehr ...

Task	RemoveFileFromCommunicationAsync (Guid communicationGuid, Guid fileResourceGuid)
	Löscht die angegebene Datei aus der Kommunikation. Mehr ...

Task< List< Guid > >	GetMessagesInCommunicationAsync (Guid communicationGuid)
	Liefert eine Liste von Nachrichten-Guids, welche in dieser Kommunikation sind. Mehr ...

Task< Guid >	AddMessageToCommunicationAsync (Guid communicationGuid, CreateMessageModel createMessageModel, Guid? parentMessageGuid=null)
	Erstellt eine neue Nachricht in der angegebenen Kommunikation. Mehr ...

Task	RemoveMessageFromCommunicationAsync (Guid communicationGuid, Guid messageResourceGuid)
	Löscht eine Nachricht aus einer Kommunikation. Mehr ...

Task< List< Guid > >	GetParticipantsInCommunicationAsync (Guid communicationGuid)
	Liefert eine Liste der Teilnehmer in der angegebenen Kommunikation. Mehr ...

Task	AddParticipantToCommunicationAsync (Guid communicationGuid, Guid participantGuid, bool sendEmailNotification)
	Fügt einen Benutzer zu einer Kommunikation hinzu. Mehr ...

Task	RemoveParticipantFromCommunicationAsync (Guid communicationGuid, Guid participantGuid)
	Entfernt einen Teilnehmer aus einer Kommunikation. Mehr ...

Task< MessageModel >	GetMessageAsync (Guid messageResourceGuid)
	Holt eine einzelne Nachricht. Mehr ...

Task< List< ParticipantModel > >	GetKnownParticipantsAsync ()
	Holt einer Liste von Teilnehmern mit denen der angemeldete Benutzer in Kontakt steht. Mehr ...

Task< CreateParticipantResultModel >	CreateParticipantAsync (CreateParticipantModel createParticipantModel)
	Erstellt einen neuen Benutzer. Mehr ...

Task< ParticipantModel >	GetParticipantAsync (Guid participantGuid)
	Holt einen einzelnen Benutzer. Mehr ...

Task	UpdateParticipantAsync (Guid participantGuid, ParticipantUpdateModel model)
	Bearbeitet einen existierenden Benutzer. Die Benutzerdaten werden erst nach einer Personenverifizierung tatsächlich geändert, siehe: VerifyCodeToUpdateParticipantAsync. Mehr ...

Task	VerifyCodeToUpdateParticipantAsync (Guid participantGuid, string code)
	Bestätigt die Änderung der Benutzerdaten. Mehr ...

Task< FindParticipantResultModel >	FindParticipantAsync (string username=null, string email=null, string phoneNumber=null)
	Sucht nach einen existierenden Benutzer. Es muss mindestens ein Suchparameter angegeben werden und alle gleichzeitig. Die Angabe mehrere Suchparameter kann die Suche möglicherweise einschränken und somit ein eindeutiges Ergebnis liefern. Mehr ...

Ausführliche Beschreibung

Interface für die Klasse ContextApi.

Dokumentation der Elementfunktionen

◆ AddMessageToCommunicationAsync()

Task< Guid > ContextSDK.IContextApi.AddMessageToCommunicationAsync	(	Guid	communicationGuid,
		CreateMessageModel	createMessageModel,
		Guid?	parentMessageGuid = `null`
	)

Erstellt eine neue Nachricht in der angegebenen Kommunikation.

Parameter

communicationGuid	Guid der Kommunikation in der der Vorgang durchgeführt werden soll.
createMessageModel	Die Daten der neuen Nachricht.
parentMessageGuid	Optional: Die Guid einer Eltern-Nachricht. Wird verwende, um auch Nachrichten zu antworten.

Rückgabe: Die Guid der erstellten Nachricht.

Implementiert in ContextSDK.ContextApi.

◆ AddParticipantToCommunicationAsync()

Task ContextSDK.IContextApi.AddParticipantToCommunicationAsync	(	Guid	communicationGuid,
		Guid	participantGuid,
		bool	sendEmailNotification
	)

Fügt einen Benutzer zu einer Kommunikation hinzu.

Parameter

communicationGuid	Guid der Kommunikation in der der Vorgang durchgeführt werden soll.
participantGuid	Der Teilnehmer, welcher hinzugefügt werden soll.
sendEmailNotification	Ob eine Email-Benachrichtigung an diesen Benutzer gesendet werden soll, dass er zur Kommunikation hinzugefügt wurde.

Implementiert in ContextSDK.ContextApi.

◆ ConfirmDownloadSuccessfulAsync()

Task ContextSDK.IContextApi.ConfirmDownloadSuccessfulAsync ( Guid fileResourceGuid )

Bestätigt den erfolgreichen Download einer Datei. Dies erzeugt anschließend eine FileDownloadedActivity, welche verwendet werden kann, um festzustellen, welche Personen bereits diese Datei heruntergeladen haben.

Parameter

fileResourceGuid Die betroffene Datei.

Implementiert in ContextSDK.ContextApi.

◆ CreateCommunicationAsync()

Task< Guid > ContextSDK.IContextApi.CreateCommunicationAsync ( CreateCommunicationModel createCommunicationModel )

Erstellt eine neue Kommunikation.

Parameter

createCommunicationModel Die Daten die für die Erstellung benötigt werden.

Rückgabe: Die Guid der neuen Kommunikation.

Implementiert in ContextSDK.ContextApi.

◆ CreateFileAndUploadToCommunicationAsync()

Task< Guid > ContextSDK.IContextApi.CreateFileAndUploadToCommunicationAsync	(	Guid	communicationGuid,
		CreateMessageWithFileModel	createMessageWithFileModel
	)

Erstellt die Datei Meta-Daten und ladet die Datei hoch.

Parameter

communicationGuid	Guid der Kommunikation in der der Vorgang durchgeführt werden soll.
createMessageWithFileModel	Das Modell mit den notwendigen Daten.

Implementiert in ContextSDK.ContextApi.

◆ CreateFileMetaDataForCommunicationAsync()

Task< Guid > ContextSDK.IContextApi.CreateFileMetaDataForCommunicationAsync	(	Guid	communicationGuid,
		string	localFilePath,
		string	fileDisplayName,
		string	message
	)

Erstellt die Meta-Daten einer Datei. Dies ist notwendig bevor eine Datei hochgeladen werden kann.

Parameter

communicationGuid	Guid der Kommunikation in der der Vorgang durchgeführt werden soll.
localFilePath	Der vollständige Pfad der gewünschten Datei. Wird eingelesen, um den tatsächlichen Dateinamen anzugeben und die Checksum zu berechnen.
fileDisplayName	Der angezeigte Name der Datei.
message	Die beiliegende Nachricht.

Rückgabe: Die Datei-Guid der erstellten Datei.

Implementiert in ContextSDK.ContextApi.

◆ CreateNewCryptoKeysForNewCommunication()

Task< Guid?> ContextSDK.IContextApi.CreateNewCryptoKeysForNewCommunication ( )

Erstellt einen neuen Kryptografischen Schlüssel. Dies wird benötigt, um eine Kommunikation zu erstellen, da manche Daten der Kommunikation bereits verschlüsselt sind. Deswegen wird auch die Guid der Kommunikation zurückgegeben, welche auch benötigt wird um eine neue Kommunikation zu erstellen. Der kryptografische Schlüssel kann mit GetOrRequestCryptoKeyAsync angefragt werden.

Rückgabe: Die Guid der neuen Kommunikation

Implementiert in ContextSDK.ContextApi.

◆ CreateParticipantAsync()

Task< CreateParticipantResultModel > ContextSDK.IContextApi.CreateParticipantAsync ( CreateParticipantModel createParticipantModel )

Erstellt einen neuen Benutzer.

Parameter

createParticipantModel Die Daten zur Erstellung.

Rückgabe: Die Guid des neuen Benutzers.

Implementiert in ContextSDK.ContextApi.

◆ DeleteCommunicationAsync()

Task ContextSDK.IContextApi.DeleteCommunicationAsync ( Guid communicationGuid )

Löscht eine Kommunikation.

Parameter

communicationGuid Die Guid der zu löschenden Kommunikation.

Implementiert in ContextSDK.ContextApi.

◆ DownloadChunkAsync()

Task ContextSDK.IContextApi.DownloadChunkAsync	(	Stream	downloadedData,
		Guid	communicationGuid,
		Guid	fileResourceGuid,
		Guid	chunkGuid,
		string	chunkCheckSum = `null`
	)

Ladet einen bestimmten Chunk einer Datei herunter. Wenn chunkCheckSum angegeben wird, wird diese überprüft.

Parameter

downloadedData	Ein Stream mit den heruntergeladenen Bytes.
communicationGuid	Guid der Kommunikation in der der Vorgang durchgeführt werden soll.
fileResourceGuid	Die betroffene Datei.
chunkGuid	Der gewünschte Datei-Chunk.
chunkCheckSum	Optional: Die erwartete Checksum des Chunks.

Rückgabe: Ein MemoryStream mit den empfangenen Bytes.

Ausnahmebehandlung

ContextServiceException

Implementiert in ContextSDK.ContextApi.

◆ DownloadFileChunkedAsync()

Task ContextSDK.IContextApi.DownloadFileChunkedAsync	(	Guid	communicationGuid,
		Guid	fileGuid,
		string	targetFilePath
	)

Ladet eine Datei herunter.

Parameter

communicationGuid	Guid der Kommunikation in der der Vorgang durchgeführt werden soll.
fileGuid	Die Ressource-Guid der Zieldatei.
targetFilePath	Der volle Pfad inklusive dem Dateinamen.

Implementiert in ContextSDK.ContextApi.

◆ FindParticipantAsync()

Task< FindParticipantResultModel > ContextSDK.IContextApi.FindParticipantAsync	(	string	username = `null`,
		string	email = `null`,
		string	phoneNumber = `null`
	)

Sucht nach einen existierenden Benutzer. Es muss mindestens ein Suchparameter angegeben werden und alle gleichzeitig. Die Angabe mehrere Suchparameter kann die Suche möglicherweise einschränken und somit ein eindeutiges Ergebnis liefern.

Parameter

username	Suchparameter: Benutzername
email	Suchparameter: Email
phoneNumber	Suchparameter: Telefonnummer

Rückgabe: Informationen über den Erfolg des Zugriffes, inklusive der gefundenen Participant-Guid, wenn es einen eindeutigen Treffer gab.

Implementiert in ContextSDK.ContextApi.

◆ GetActivitiesAsync() [1/2]

Task< List< ActivityBase > > ContextSDK.IContextApi.GetActivitiesAsync ( Guid? lastGuid )

Liefert eine Liste mit allen Aktivitäten, welche seit der angegebenen Aktivität erstellt wurden.

Parameter

lastGuid Die angegebene Aktivität, oder null für alle.

Rückgabe: Alle neu erstellten Aktivitäten

Implementiert in ContextSDK.ContextApi.

◆ GetActivitiesAsync() [2/2]

Task< List< ActivityBase > > ContextSDK.IContextApi.GetActivitiesAsync ( long? lastRequestTimestamp )

Liefert eine Liste mit allen Aktivitäten, welche seit diesem Zeitpunkt erstellt wurden. Es wird empfohlen den lastRequestTimestamp von der API nehmen und nicht die lokale zeit in Unix-Millisekunden umzuwandeln

Parameter

lastRequestTimestamp Der gewünschte Zeitpunkt, oder null für alle.

Rückgabe: Alle neu erstellten Aktivitäten

Implementiert in ContextSDK.ContextApi.

◆ GetActivitiesForCommunicationAsync()

Task< List< ActivityBase > > ContextSDK.IContextApi.GetActivitiesForCommunicationAsync	(	Guid	communicationGuid,
		Guid?	lastActivityGuid
	)

Liefert alle Aktivitäten der angegebenen Kommunikation. Optional kann eine Aktivitäts-Guid angegeben werden, sodass nur Aktivitäten geholt werden die älter als die angegebene Aktivität sind.

Parameter

communicationGuid	Guid der Kommunikation in der der Vorgang durchgeführt werden soll.
lastActivityGuid	Guid der Aktivität ab der die Aktivitäten geholt werden sollen, oder alle wenn null.

Rückgabe: Liste von Aktivitäten in dieser Kommunikation

Implementiert in ContextSDK.ContextApi.

◆ GetActivityAsync()

Task< List< ActivityBase > > ContextSDK.IContextApi.GetActivityAsync ( Guid activityGuid )

Holt eine einzelne Aktivität mit der angegebenen Guid.

Parameter

activityGuid Guid der gewünschten Aktivität.

Rückgabe: Die gewünschte Aktivität.

Implementiert in ContextSDK.ContextApi.

◆ GetActivityCountAsync()

Task< int > ContextSDK.IContextApi.GetActivityCountAsync ( long? lastTsp )

Holt die Anzahl von Aktivitäten, welche seit dem angegebenen Zeitpunkt erstellt wurden.

Parameter

lastTsp Der gewünschte Zeitpunkt, oder null für alle.

Rückgabe: Die Anzahl erstellter Aktivitäten

Implementiert in ContextSDK.ContextApi.

◆ GetApiStatusAsync()

Task< ApiStatus > ContextSDK.IContextApi.GetApiStatusAsync ( )

Gibt den aktuellen Status der API zurück

Rückgabe: Den Status der API

Implementiert in ContextSDK.ContextApi.

◆ GetCommunicationDeletionDateTimeAsync()

Task< EndOfLifeTimeModel > ContextSDK.IContextApi.GetCommunicationDeletionDateTimeAsync ( Guid communicationGuid )

Holt den Zeitpunkt zu dem diese Kommunikation automatisch gelöscht wird.

Parameter

communicationGuid Guid der Kommunikation in der der Vorgang durchgeführt werden soll.

Rückgabe: Informationen zum Löschzeitpunkt

Implementiert in ContextSDK.ContextApi.

◆ GetCommunicationsAsync()

Task< List< ContextCommunication > > ContextSDK.IContextApi.GetCommunicationsAsync ( )

Liefert eine Liste von allen Kommunikationen auf die der angemeldete Benutzer Zugriff hat.

Rückgabe: Liste von Kommunikationen

Implementiert in ContextSDK.ContextApi.

◆ GetCountActivitiesForCommunicationAsync()

Task< int > ContextSDK.IContextApi.GetCountActivitiesForCommunicationAsync	(	Guid	communicationGuid,
		Guid?	lastGuidToCountFrom
	)

Liefert die Anzahl der Aktivitäten der angegebenen Kommunikation. Optional kann eine Aktivitäts-Guid angegeben werden, sodass nur Aktivitäten gezählt werden die älter als die angegebene Aktivität sind.

Parameter

communicationGuid	Guid der Kommunikation in der der Vorgang durchgeführt werden soll.
lastGuidToCountFrom	Guid der Aktivität ab der die Aktivitäten geholt werden sollen, oder alle wenn null.

Rückgabe: Anzahl der Aktivitäten

Implementiert in ContextSDK.ContextApi.

◆ GetFileChunksAsync()

Task< FileChunksMetaData > ContextSDK.IContextApi.GetFileChunksAsync ( Guid fileResourceGuid )

Holt die Meta-Daten der Datei-Chunks für die angegebene Datei. Diese Meta-Daten werden benötigt, um eine Datei herunterzuladen, da darin die Chunk-Guids enthalten sind mit denen die einzelnen Chunks anschließend heruntergeladen werden können.

Parameter

fileResourceGuid Die betroffene Datei.

Rückgabe: Die Meta-Daten der Datei-Chunks

Implementiert in ContextSDK.ContextApi.

◆ GetFileMetaDataAsync()

Task< FileMetaData > ContextSDK.IContextApi.GetFileMetaDataAsync ( Guid fileResourceGuid )

Holt die Meta-Daten für eine Datei.

Parameter

fileResourceGuid Die betroffene Datei.

Rückgabe: Die Meta-Daten

Implementiert in ContextSDK.ContextApi.

◆ GetFilesInCommunicationAsync()

Task< List< Guid > > ContextSDK.IContextApi.GetFilesInCommunicationAsync ( Guid communicationGuid )

Holt alle Dateien der angegebenen Kommunikation..

Parameter

communicationGuid Guid der Kommunikation in der der Vorgang durchgeführt werden soll.

Rückgabe: Liste von Datei-Guids

Implementiert in ContextSDK.ContextApi.

◆ GetFormattedPhoneNumberAsync()

Task< string > ContextSDK.IContextApi.GetFormattedPhoneNumberAsync ( string phoneNumber )

Formatiert eine Telefonnummer und prüft diese auch auf Korrektheit.

Telefonnummern sollten in folgendem Format sein: "00{Ländervorwahl}{Carrier}{Nummer}"

Beispiel: 00436531234567

Parameter

phoneNumber Die Telefonnummer, welche Überprüft werden soll.

Rückgabe: Die formatierte Telefonnummer.

Implementiert in ContextSDK.ContextApi.

◆ GetGeneratedPasswordAsync()

Task< string > ContextSDK.IContextApi.GetGeneratedPasswordAsync ( int? length = null )

Kann verwendet werden, um ein Passwort zu generieren, welches alle Passwortrichtlinien bei der Erstellung von Benutzer erfüllt.

Parameter

length Die gewünschte Länge, ansonsten wird eine von der API bestimmte Standardlänge verwendet.

Rückgabe: Das generierte Passwort

Implementiert in ContextSDK.ContextApi.

◆ GetKnownCommunicationsAsync()

Task< List< Guid > > ContextSDK.IContextApi.GetKnownCommunicationsAsync ( )

Liefert eine Guids von Kommunikationen zu denen der angemeldete Benutzer Zugriff hat.

Rückgabe: Die Liste der Kommunikations-Guids

Implementiert in ContextSDK.ContextApi.

◆ GetKnownParticipantsAsync()

Task< List< ParticipantModel > > ContextSDK.IContextApi.GetKnownParticipantsAsync ( )

Holt einer Liste von Teilnehmern mit denen der angemeldete Benutzer in Kontakt steht.

Rückgabe: Die Liste von bekannten Benutzern

Implementiert in ContextSDK.ContextApi.

◆ GetMessageAsync()

Task< MessageModel > ContextSDK.IContextApi.GetMessageAsync ( Guid messageResourceGuid )

Holt eine einzelne Nachricht.

Parameter

messageResourceGuid Die Guid der gewünschten Nachricht.

Rückgabe: Die gewünschte Nachricht.

Implementiert in ContextSDK.ContextApi.

◆ GetMessagesInCommunicationAsync()

Task< List< Guid > > ContextSDK.IContextApi.GetMessagesInCommunicationAsync ( Guid communicationGuid )

Liefert eine Liste von Nachrichten-Guids, welche in dieser Kommunikation sind.

Parameter

communicationGuid Guid der Kommunikation in der der Vorgang durchgeführt werden soll.

Rückgabe: Die Liste von Nachrichten-Guids

Implementiert in ContextSDK.ContextApi.

◆ GetOrRequestCryptoKeyAsync()

Task< string > ContextSDK.IContextApi.GetOrRequestCryptoKeyAsync ( Guid? communicationGuid )

Holt den Schlüssel für die kryptografischen Vorgänge zu dieser Kommunikation.

Parameter

communicationGuid Guid der Kommunikation in der der Vorgang durchgeführt werden soll.

Rückgabe: Den Schlüssel für die kryptografischen Vorgänge

Implementiert in ContextSDK.ContextApi.

◆ GetParticipantAsync()

Task< ParticipantModel > ContextSDK.IContextApi.GetParticipantAsync ( Guid participantGuid )

Holt einen einzelnen Benutzer.

Parameter

participantGuid Die Guid des gewünschten Benutzers.

Rückgabe: Der gewünschte Benutzer

Implementiert in ContextSDK.ContextApi.

◆ GetParticipantsInCommunicationAsync()

Task< List< Guid > > ContextSDK.IContextApi.GetParticipantsInCommunicationAsync ( Guid communicationGuid )

Liefert eine Liste der Teilnehmer in der angegebenen Kommunikation.

Parameter

communicationGuid Guid der Kommunikation in der der Vorgang durchgeführt werden soll.

Rückgabe: Die Liste von Teilnehmer-Guids, welche sich in der Kommunikation befinden.

Implementiert in ContextSDK.ContextApi.

◆ GetStatisticsAsync()

Task< List< object > > ContextSDK.IContextApi.GetStatisticsAsync	(	DateTime	from,
		DateTime	to,
		bool	extended
	)

Liefert Statistiken zum aktuell angemeldeten Benutzer.

Parameter

from	Startzeitpunkt.
to	Endzeitpunkt.
extended	Wenn ausgewählt werden auch Nachrichten und Dateien von Teilnehmern in der Statistik aufgenommen.

Rückgabe: Json-Objekte mit den Daten der Statistik.

Implementiert in ContextSDK.ContextApi.

◆ LoginAsync()

Task< Guid > ContextSDK.IContextApi.LoginAsync	(	string	userName,
		string	password
	)

Loggt sich bei der API ein und holt den notwendigen JWT, welcher für alle API-Zugriffe verwendet wird

Parameter

userName	Benutzername eines Context-Benutzers.
password	Passwort dieses Context-Benutzers.

Implementiert in ContextSDK.ContextApi.

◆ NotifyByEmailAsync()

Task ContextSDK.IContextApi.NotifyByEmailAsync	(	Guid	communicationGuid,
		Guid	participantGuid,
		string	email,
		string	mailText,
		EmailNotificationTemplateType	mailTemplateType,
		NotificationLinkType	notificationLinkType
	)

Sendet eine Benachrichtigung per Email and die angegebene Email-Adresse.

Parameter

communicationGuid	Guid der Kommunikation in der der Vorgang durchgeführt werden soll.
participantGuid	Die ParticipantGuid des Empfängers.
email	Die Adresse des Empfängers, oder wenn null die hinterlegte Adresse dieses Teilnehmers.
mailText	Ein Text, welcher in der Email eingebaut wird.
mailTemplateType	Die zu verwendende Vorlage.
notificationLinkType	Der Typ des Links.

Implementiert in ContextSDK.ContextApi.

◆ NotifyBySmsAsync()

Task ContextSDK.IContextApi.NotifyBySmsAsync	(	Guid	communicationGuid,
		Guid	participantGuid,
		string	smsText,
		NotificationLinkType	notificationLinkType
	)

Sendet eine Benachrichtigung per SMS and die angegebene Telefonnummer.

Parameter

communicationGuid	Guid der Kommunikation in der der Vorgang durchgeführt werden soll.
participantGuid	Die ParticipantGuid des Empfängers.
smsText	Der Text der SMS.
notificationLinkType	Der Typ des Links.

Implementiert in ContextSDK.ContextApi.

◆ RemoveFileFromCommunicationAsync()

Task ContextSDK.IContextApi.RemoveFileFromCommunicationAsync	(	Guid	communicationGuid,
		Guid	fileResourceGuid
	)

Löscht die angegebene Datei aus der Kommunikation.

Parameter

communicationGuid	Guid der Kommunikation in der der Vorgang durchgeführt werden soll.
fileResourceGuid	Die Datei, welche gelöscht werden soll.

Implementiert in ContextSDK.ContextApi.

◆ RemoveMessageFromCommunicationAsync()

Task ContextSDK.IContextApi.RemoveMessageFromCommunicationAsync	(	Guid	communicationGuid,
		Guid	messageResourceGuid
	)

Löscht eine Nachricht aus einer Kommunikation.

Parameter

communicationGuid	Guid der Kommunikation in der der Vorgang durchgeführt werden soll.
messageResourceGuid	Die Guid der zu löschenden Datei.

Implementiert in ContextSDK.ContextApi.

◆ RemoveParticipantFromCommunicationAsync()

Task ContextSDK.IContextApi.RemoveParticipantFromCommunicationAsync	(	Guid	communicationGuid,
		Guid	participantGuid
	)

Entfernt einen Teilnehmer aus einer Kommunikation.

Parameter

communicationGuid	Guid der Kommunikation in der der Vorgang durchgeführt werden soll.
participantGuid	Der Teilnehmer, welcher entfernt werden soll.

Implementiert in ContextSDK.ContextApi.

◆ SendSmsAsync()

Task ContextSDK.IContextApi.SendSmsAsync	(	string	phoneNumber,
		string	text
	)

Sendet eine SMS an die gewünschte Telefonnummer.

Parameter

phoneNumber	Die Telefonnummer des Empfängers.
text	Der Inhalt der SMS.

Implementiert in ContextSDK.ContextApi.

◆ UpdateCommunicationAsync()

Task ContextSDK.IContextApi.UpdateCommunicationAsync	(	Guid	communicationGuid,
		ContextCommunicationUpdateModel	model
	)

Bearbeitet eine Kommunikation.

Parameter

communicationGuid	Die Guid der zu bearbeitenden Kommunikation.
model	Die neuen gewünschten Daten/Einstellungen dieser Kommunikation.

Implementiert in ContextSDK.ContextApi.

◆ UpdateParticipantAsync()

Task ContextSDK.IContextApi.UpdateParticipantAsync	(	Guid	participantGuid,
		ParticipantUpdateModel	model
	)

Bearbeitet einen existierenden Benutzer. Die Benutzerdaten werden erst nach einer Personenverifizierung tatsächlich geändert, siehe: VerifyCodeToUpdateParticipantAsync.

Parameter

participantGuid	Die Guid des zu bearbeitenden Benutzers.
model	Die neuen Benutzerdaten.

◆ UploadChunkAsync()

Task ContextSDK.IContextApi.UploadChunkAsync	(	Guid	communicationGuid,
		Guid	fileResourceGuid,
		MemoryStream	chunkData,
		int	currentChunkNumber,
		int	numberOfChunks,
		string	encryptedFileName
	)

Lädt einen Datei-Chunk zu einer existierenden Datei hoch.

Parameter

communicationGuid	Guid der Kommunikation in der der Vorgang durchgeführt werden soll.
fileResourceGuid	Die betroffene Datei.
chunkData	Ein MemoryStream mit den Bytes, welche hochgeladen werden sollen.
currentChunkNumber	Die derzeitige Chunk-Number. Beginnt mit 0.
numberOfChunks	Anzahl der Chunks dieser Datei.
encryptedFileName	Der verschlüsselte Dateiname.

Implementiert in ContextSDK.ContextApi.

◆ UploadFileChunkedAsync()

Task ContextSDK.IContextApi.UploadFileChunkedAsync	(	Guid	communicationGuid,
		Guid	fileGuid,
		string	filePath
	)

Ladet eine Datei hoch. Dafür muss die Datei (die Meta-Daten) bereits erstellt sein.

Parameter

communicationGuid	Guid der Kommunikation in der der Vorgang durchgeführt werden soll.
fileGuid	Die Ressource-Guid der Zieldatei.
filePath	Der ganze Pfad in dem sich die Datei befindet.

Implementiert in ContextSDK.ContextApi.

◆ VerifyCodeToUpdateParticipantAsync()

Task ContextSDK.IContextApi.VerifyCodeToUpdateParticipantAsync	(	Guid	participantGuid,
		string	code
	)

Bestätigt die Änderung der Benutzerdaten.

Parameter

participantGuid	Der betroffene Benutzer.
code	Der Code, welcher der betroffenen Person zugesandt wurde.

Implementiert in ContextSDK.ContextApi.

Die Dokumentation für diese Schnittstelle wurde erzeugt aufgrund der Datei:

ContextSDK/IContextApi.cs

Öffentliche Methoden

Ausführliche Beschreibung

Dokumentation der Elementfunktionen

◆ AddMessageToCommunicationAsync()

◆ AddParticipantToCommunicationAsync()

◆ ConfirmDownloadSuccessfulAsync()

◆ CreateCommunicationAsync()

◆ CreateFileAndUploadToCommunicationAsync()

◆ CreateFileMetaDataForCommunicationAsync()

◆ CreateNewCryptoKeysForNewCommunication()

◆ CreateParticipantAsync()

◆ DeleteCommunicationAsync()

◆ DownloadChunkAsync()

◆ DownloadFileChunkedAsync()

◆ FindParticipantAsync()

◆ GetActivitiesAsync() [1/2]

◆ GetActivitiesAsync() [2/2]

◆ GetActivitiesForCommunicationAsync()

◆ GetActivityAsync()

◆ GetActivityCountAsync()

◆ GetApiStatusAsync()

◆ GetCommunicationDeletionDateTimeAsync()

◆ GetCommunicationsAsync()

◆ GetCountActivitiesForCommunicationAsync()

◆ GetFileChunksAsync()

◆ GetFileMetaDataAsync()

◆ GetFilesInCommunicationAsync()

◆ GetFormattedPhoneNumberAsync()

◆ GetGeneratedPasswordAsync()

◆ GetKnownCommunicationsAsync()

◆ GetKnownParticipantsAsync()

◆ GetMessageAsync()

◆ GetMessagesInCommunicationAsync()

◆ GetOrRequestCryptoKeyAsync()

◆ GetParticipantAsync()

◆ GetParticipantsInCommunicationAsync()

◆ GetStatisticsAsync()

◆ LoginAsync()

◆ NotifyByEmailAsync()

◆ NotifyBySmsAsync()

◆ RemoveFileFromCommunicationAsync()

◆ RemoveMessageFromCommunicationAsync()

◆ RemoveParticipantFromCommunicationAsync()

◆ SendSmsAsync()

◆ UpdateCommunicationAsync()

◆ UpdateParticipantAsync()

◆ UploadChunkAsync()

◆ UploadFileChunkedAsync()

◆ VerifyCodeToUpdateParticipantAsync()