Context SDK 1.0.0
A software development kit for the context system.
ContextSDK.IActivityPersistence< TUser, TCommunication, TMessage > Template-Schnittstellenreferenz

Beschreibt den Aufbau von Persistence-Klassen. Diese vereinfachen die Verwendung der ContextSDK mit Datenspeichern (DataStore), wie Datenbanken oder Caches. Die Klasse, welche diese Interface implementiert, ist die Zwischenschicht zwischen Context<TUser,TCommunication,TMessage> und dem DataStore Mehr ...

Öffentliche Methoden

TUser GetUser (Guid participantGuId)
 Holt einen Benutzer aus dem DataStore. Mehr ...
 
TUser CreateUser (ParticipantModel responseParticipantModel)
 Erstellt einen Benutzer im DataStore. Mehr ...
 
void UpdateUser (ParticipantUpdatedActivity participantUpdatedActivity)
 Aktualisiert einen Benutzer im DataStore. Mehr ...
 
TCommunication GetCommunication (Guid communicationGuId)
 Holt eine Kommunikation aus dem DataStore. Mehr ...
 
Task< TCommunication > CreateCommunicationAsync (CommunicationCreatedActivity communicationCreatedActivity, string cryptoKey)
 Erstellt eine neue Kommunikation im DataStore. Mehr ...
 
Task UpdateCommunicationChangedAsync (CommunicationChangedActivity communicationChangedActivity, string cryptoKey)
 Aktualisiert eine Kommunikation im DataStore. Mehr ...
 
void DeleteCommunication (Guid communicationGuId)
 Löscht eine Kommunikation aus dem DataStore. Mehr ...
 
void AddUserToCommunication (TUser user, TCommunication communication)
 Fügt einen Benutzer als Teilnehmer zu einer Kommunikation im DatStore hinzu. Mehr ...
 
void AddMessageToCommunication (Guid communicationGuId, TMessage message)
 Fügt eine Nachricht einer Kommunikation im DataStore hinzu. Mehr ...
 
Task AddFileToCommunicationAsync (Guid communicationGuId, FileUploadedActivity file, string cryptoKey)
 Fügt eine Datei einer Kommunikation im DataStore hinzu. Mehr ...
 
void RemoveParticipantFromCommunication (Guid communicationGuId, Guid participantGuId)
 Entfernt einen Benutzer aus einer Kommunikation im DataStore. Mehr ...
 
TMessage GetMessage (Guid resourceGuid)
 Holt eine Nachricht aus dem DataStore. Mehr ...
 
Task< TMessage > CreateNewMessageAsync (MessageCreatedActivity messageCreatedActivity, string cryptoKey)
 Erstellt eine neue Nachricht im DataStore. Mehr ...
 
void DeleteMessage (Guid communicationGuId, Guid messageResourceGuid)
 Löscht eine Nachricht aus dem DataStore. Mehr ...
 
Task CreateFileMetaData (FileCreatedActivity fileCreatedActivity, string cryptoKey)
 Erstellt eine neue Datei im DataStore. Mehr ...
 
void DeleteFile (Guid communicationGuId, Guid fileGuid)
 Löscht eine Datei aus dem DataStore. Mehr ...
 
void HandleFileDownloaded (FileDownloadedActivity fileDownloadedActivity)
 Informiert darüber, dass eine Datei heruntergeladen wurde. Mehr ...
 
void CreateActivityLog (LogActivity logActivity)
 Informiert darüber, dass eine Log-Aktivität auf der API erstellt wurde. Mehr ...
 
long? GetLastRefreshTimestamp ()
 Holt den timestamp (im Format von Unix-Millisekunden) des letzten Zugriffes aus dem DataStore. Dieser wird beim Aktualisieren der Aktivitäten verwendet.
 
void SetLastRefreshTimestamp (long? timestamp)
 Setzt den timestamp (im Format von Unix-Millisekunden) des letzten Zugriffes im DataStore. Es sollten nur Werte von Aktivitäten verwendet werden und nicht selbsterstellte timestamp (wie zum Beispiel durch DateTimeOffset.Now.ToUnixTimeSeconds()) Mehr ...
 

Ausführliche Beschreibung

Beschreibt den Aufbau von Persistence-Klassen. Diese vereinfachen die Verwendung der ContextSDK mit Datenspeichern (DataStore), wie Datenbanken oder Caches. Die Klasse, welche diese Interface implementiert, ist die Zwischenschicht zwischen Context<TUser,TCommunication,TMessage> und dem DataStore

Template-Parameter
TUserDer Typ von Benutzer-Objekten
TCommunicationDer Typ von Kommunikation-Objekten
TMessageDer Typ von Nachricht-Objekten
Type Constraints
TUser :IContextUser 
TCommunication :IContextCommunication 
TMessage :IContextMessage 

Dokumentation der Elementfunktionen

◆ AddFileToCommunicationAsync()

Task ContextSDK.IActivityPersistence< TUser, TCommunication, TMessage >.AddFileToCommunicationAsync ( Guid  communicationGuId,
FileUploadedActivity  file,
string  cryptoKey 
)

Fügt eine Datei einer Kommunikation im DataStore hinzu.

Parameter
communicationGuIdDie Guid der gewünschten Kommunikation.
fileDie gewünschte Datei.
cryptoKeyDer kryptografische Schlüssel.

◆ AddMessageToCommunication()

void ContextSDK.IActivityPersistence< TUser, TCommunication, TMessage >.AddMessageToCommunication ( Guid  communicationGuId,
TMessage  message 
)

Fügt eine Nachricht einer Kommunikation im DataStore hinzu.

Parameter
communicationGuIdDie Guid der gewünschten Kommunikation.
messageDie gewünschte Nachricht

◆ AddUserToCommunication()

void ContextSDK.IActivityPersistence< TUser, TCommunication, TMessage >.AddUserToCommunication ( TUser  user,
TCommunication  communication 
)

Fügt einen Benutzer als Teilnehmer zu einer Kommunikation im DatStore hinzu.

Parameter
userDer gewünschte Benutzer
communicationDie gewünschte Kommunikation

◆ CreateActivityLog()

void ContextSDK.IActivityPersistence< TUser, TCommunication, TMessage >.CreateActivityLog ( LogActivity  logActivity)

Informiert darüber, dass eine Log-Aktivität auf der API erstellt wurde.

Parameter
logActivityDie Daten der Log-Aktivität.

◆ CreateCommunicationAsync()

Task< TCommunication > ContextSDK.IActivityPersistence< TUser, TCommunication, TMessage >.CreateCommunicationAsync ( CommunicationCreatedActivity  communicationCreatedActivity,
string  cryptoKey 
)

Erstellt eine neue Kommunikation im DataStore.

Parameter
communicationCreatedActivityDas Modell mit den Daten der neuen Kommunikation.
cryptoKeyDer kryptografische Schlüssel.

◆ CreateFileMetaData()

Task ContextSDK.IActivityPersistence< TUser, TCommunication, TMessage >.CreateFileMetaData ( FileCreatedActivity  fileCreatedActivity,
string  cryptoKey 
)

Erstellt eine neue Datei im DataStore.

Parameter
fileCreatedActivityDas Modell mit den Daten der neuen Datei.
cryptoKeyDer kryptografische Schlüssel.

◆ CreateNewMessageAsync()

Task< TMessage > ContextSDK.IActivityPersistence< TUser, TCommunication, TMessage >.CreateNewMessageAsync ( MessageCreatedActivity  messageCreatedActivity,
string  cryptoKey 
)

Erstellt eine neue Nachricht im DataStore.

Parameter
messageCreatedActivityDas Modell mit den Daten der neuen Nachricht.
cryptoKeyDer kryptografische Schlüssel.

◆ CreateUser()

TUser ContextSDK.IActivityPersistence< TUser, TCommunication, TMessage >.CreateUser ( ParticipantModel  responseParticipantModel)

Erstellt einen Benutzer im DataStore.

Parameter
responseParticipantModelDas Modell mit den Daten des neuen Benutzers.

◆ DeleteCommunication()

void ContextSDK.IActivityPersistence< TUser, TCommunication, TMessage >.DeleteCommunication ( Guid  communicationGuId)

Löscht eine Kommunikation aus dem DataStore.

Parameter
communicationGuIdDie zu löschende Kommunikation.

◆ DeleteFile()

void ContextSDK.IActivityPersistence< TUser, TCommunication, TMessage >.DeleteFile ( Guid  communicationGuId,
Guid  fileGuid 
)

Löscht eine Datei aus dem DataStore.

Parameter
communicationGuIdDie Guid der gewünschten Kommunikation.
fileGuidDie Guid der gewünschten Datei.

◆ DeleteMessage()

void ContextSDK.IActivityPersistence< TUser, TCommunication, TMessage >.DeleteMessage ( Guid  communicationGuId,
Guid  messageResourceGuid 
)

Löscht eine Nachricht aus dem DataStore.

Parameter
communicationGuIdDie Guid der gewünschten Kommunikation.
messageResourceGuidDie Guid der gewünschten Nachricht.

◆ GetCommunication()

TCommunication ContextSDK.IActivityPersistence< TUser, TCommunication, TMessage >.GetCommunication ( Guid  communicationGuId)

Holt eine Kommunikation aus dem DataStore.

Parameter
communicationGuIdDie Guid der gewünschten Kommunikation.

◆ GetMessage()

TMessage ContextSDK.IActivityPersistence< TUser, TCommunication, TMessage >.GetMessage ( Guid  resourceGuid)

Holt eine Nachricht aus dem DataStore.

Parameter
resourceGuidDie Guid der gewünschten Nachricht.

◆ GetUser()

TUser ContextSDK.IActivityPersistence< TUser, TCommunication, TMessage >.GetUser ( Guid  participantGuId)

Holt einen Benutzer aus dem DataStore.

Parameter
participantGuId

◆ HandleFileDownloaded()

void ContextSDK.IActivityPersistence< TUser, TCommunication, TMessage >.HandleFileDownloaded ( FileDownloadedActivity  fileDownloadedActivity)

Informiert darüber, dass eine Datei heruntergeladen wurde.

Parameter
fileDownloadedActivityDas Modell mit näheren Informationen zum Download.

◆ RemoveParticipantFromCommunication()

void ContextSDK.IActivityPersistence< TUser, TCommunication, TMessage >.RemoveParticipantFromCommunication ( Guid  communicationGuId,
Guid  participantGuId 
)

Entfernt einen Benutzer aus einer Kommunikation im DataStore.

Parameter
communicationGuIdDie Guid der gewünschten Kommunikation.
participantGuIdDie Guid des gewünschten Benutzers.

◆ SetLastRefreshTimestamp()

void ContextSDK.IActivityPersistence< TUser, TCommunication, TMessage >.SetLastRefreshTimestamp ( long?  timestamp)

Setzt den timestamp (im Format von Unix-Millisekunden) des letzten Zugriffes im DataStore. Es sollten nur Werte von Aktivitäten verwendet werden und nicht selbsterstellte timestamp (wie zum Beispiel durch DateTimeOffset.Now.ToUnixTimeSeconds())

Parameter
timestampDer zu setzende timestamp

◆ UpdateCommunicationChangedAsync()

Task ContextSDK.IActivityPersistence< TUser, TCommunication, TMessage >.UpdateCommunicationChangedAsync ( CommunicationChangedActivity  communicationChangedActivity,
string  cryptoKey 
)

Aktualisiert eine Kommunikation im DataStore.

Parameter
communicationChangedActivityDas Modell mit den Daten der aktualisierten Kommunikation.
cryptoKeyDer kryptografische Schlüssel.

◆ UpdateUser()

void ContextSDK.IActivityPersistence< TUser, TCommunication, TMessage >.UpdateUser ( ParticipantUpdatedActivity  participantUpdatedActivity)

Aktualisiert einen Benutzer im DataStore.

Parameter
participantUpdatedActivityDas Modell mit den Daten des aktualisierten Benutzers.

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