ContextSDK.IContext Schnittstellenreferenz
Interface für die Klasse Context<TUser,TCommunication,TMessage>. Mehr ...
Klassendiagramm für ContextSDK.IContext:
Öffentliche Methoden | |
| Task< Guid > | LoginAsync (string userName, string password, bool autoRefresh) |
| Loggt sich bei der API ein und holt den notwendigen JWT, welcher für alle API-Zugriffe verwendet wird. Mehr ... | |
| Task | RefreshAsync () |
| Holt eine Liste von allen Aktivitäten seit dem letzten Zugriff. Beim Einlangen der Aktivitäten wird die im Konstruktor übergebene IActivityPersistence<TUser,TCommunication,TMessage> verwendet, um den DataStore am aktuellen Stand zu halten. Mehr ... | |
 Öffentliche Methoden geerbt von ContextSDK.IContextApi | |
| 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 Context<TUser,TCommunication,TMessage>.
Dokumentation der Elementfunktionen
◆ LoginAsync()
| Task< Guid > ContextSDK.IContext.LoginAsync | ( | string | userName, |
| string | password, | ||
| bool | autoRefresh | ||
| ) |
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. autoRefresh Wenn true wird automatisch ein RefreshAsync aufgerufen.
Implementiert in ContextSDK.Context< TUser, TCommunication, TMessage >.
◆ RefreshAsync()
| Task ContextSDK.IContext.RefreshAsync | ( | ) |
Holt eine Liste von allen Aktivitäten seit dem letzten Zugriff. Beim Einlangen der Aktivitäten wird die im Konstruktor übergebene IActivityPersistence<TUser,TCommunication,TMessage> verwendet, um den DataStore am aktuellen Stand zu halten.
Implementiert in ContextSDK.Context< TUser, TCommunication, TMessage >.
Die Dokumentation für diese Schnittstelle wurde erzeugt aufgrund der Datei:
- ContextSDK/IContext.cs
