ChannelServiceHandler Klasse
- java.
lang. Object - com.
microsoft. bot. builder. ChannelServiceHandler
- com.
public class ChannelServiceHandler
Eine Klasse zur Unterstützung bei der Implementierung des Bot Framework-Protokolls.
Zusammenfassung zum Konstruktor
| Konstruktor | Beschreibung |
|---|---|
| ChannelServiceHandler(CredentialProvider credentialProvider, AuthenticationConfiguration authConfiguration, ChannelProvider channelProvider) |
Initialisiert eine neue Instanz der ChannelServiceHandler Klasse mithilfe eines Anmeldeinformationsanbieters. |
Methodenzusammenfassung
Geerbte Methoden von java.lang.Object
Details zum Konstruktor
ChannelServiceHandler
public ChannelServiceHandler(CredentialProvider credentialProvider, AuthenticationConfiguration authConfiguration, ChannelProvider channelProvider)
Initialisiert eine neue Instanz der ChannelServiceHandler Klasse mithilfe eines Anmeldeinformationsanbieters.
Parameter:
Details zur Methode
getChannelProvider
protected ChannelProvider getChannelProvider()
Ruft den Kanalanbieter ab, der ChannelProvider implementiert.
Gibt zurück:
handleCreateConversation
public CompletableFuture
Erstellen Sie eine neue Unterhaltung.
Parameter:
Gibt zurück:
handleDeleteActivity
public CompletableFuture
Löscht eine vorhandene Aktivität.
Parameter:
Gibt zurück:
handleDeleteConversationMember
public CompletableFuture
Löscht ein Mitglied aus einer Unterhaltung.
Parameter:
Gibt zurück:
handleGetActivityMembers
public CompletableFuture> handleGetActivityMembers(String authHeader, String conversationId, String activityId)
Listet die Mitglieder einer Aktivität auf.
Parameter:
Gibt zurück:
handleGetConversationMembers
public CompletableFuture> handleGetConversationMembers(String authHeader, String conversationId)
Listet die Mitglieder einer Unterhaltung auf.
Parameter:
Gibt zurück:
handleGetConversationPagedMembers
public CompletableFuture
Listet die Mitglieder einer Unterhaltung einzeln auf.
Parameter:
Gibt zurück:
handleGetConversations
public CompletableFuture
Listet die Unterhaltungen auf, an denen der Bot teilgenommen hat.
Parameter:
Gibt zurück:
handleReplyToActivity
public CompletableFuture
Sendet eine Antwort auf eine Aktivität.
Parameter:
Gibt zurück:
handleSendConversationHistory
public CompletableFuture
Lädt die historischen Aktivitäten der Unterhaltung hoch.
Parameter:
Gibt zurück:
handleSendToConversation
public CompletableFuture
Sendet eine Aktivität an das Ende einer Unterhaltung.
Parameter:
Gibt zurück:
handleUpdateActivity
public CompletableFuture
Bearbeitet eine zuvor gesendete vorhandene Aktivität.
Parameter:
Gibt zurück:
handleUploadAttachment
public CompletableFuture
Speichert Daten in einem kompatiblen Speicher, wenn es um Unternehmen geht.
Parameter:
Gibt zurück:
onCreateConversation
protected CompletableFuture
CreateConversation() API. Überschreiben Sie diese Methode, um eine neue Unterhaltung zu erstellen. POST to this method with a * Bot being the bot creating the conversation * IsGroup set to true if this is not a direct message (default instanceof false) * Array containing the members to include in the conversation The return value is a ResourceResponse which contains a conversation D which is suitable for use in the message payload and REST API URIs. Die meisten Kanäle unterstützen nur die Semantik von Bots, die eine direkte Nachrichtenunterhaltung initiieren. Ein Beispiel dafür wäre: var resource = connector.getconversations(). CreateConversation(new ConversationParameters(){ Bot = bot, members = new ChannelAccount[] { new ChannelAccount("user1") } ); connect.getConversations(). OnSendToConversation(resource.getId(), new Activity() ... ) ; Ende.
Parameter:
Gibt zurück:
onDeleteActivity
protected CompletableFuture
OnDeleteActivity() API. Überschreiben Sie diese Methode, um eine vorhandene Aktivität zu löschen. In einigen Kanälen können Sie eine vorhandene Aktivität löschen, und wenn die Methode erfolgreich verläuft, wird die angegebene Aktivität entfernt.
Parameter:
Gibt zurück:
onDeleteConversationMember
protected CompletableFuture
DeleteConversationMember() API for Skill. Überschreiben Sie diese Methode, um ein Mitglied aus einer Unterhaltung zu löschen. Diese REST-API akzeptiert eine ConversationId und eine MemberId (vom Typ String) und entfernt dieses Mitglied aus der Unterhaltung. Wenn dieses Mitglied das letzte Mitglied der Unterhaltung war, wird die Unterhaltung ebenfalls gelöscht.
Parameter:
Gibt zurück:
onGetActivityMembers
protected CompletableFuture> onGetActivityMembers(ClaimsIdentity claimsIdentity, String conversationId, String activityId)
OnGetActivityMembers() API. Überschreiben Sie diese Methode, um die Elemente einer Aktivität aufzählen zu können. Diese REST-API akzeptiert eine ConversationId und eine ActivityId und gibt ein Array von ChannelAccount Objects zurück, das die Mitglieder der bestimmten Aktivität in der Unterhaltung darstellt.
Parameter:
Gibt zurück:
onGetConversationMembers
protected CompletableFuture> onGetConversationMembers(ClaimsIdentity claimsIdentity, String conversationId)
GetConversationMembers() API for Skill. Überschreiben Sie diese Methode, um die Mitglieder einer Unterhaltung aufzählen zu können. Diese REST-API akzeptiert eine ConversationId und gibt ein Array von ChannelAccount Objects zurück, das die Mitglieder der Unterhaltung darstellt.
Parameter:
Gibt zurück:
onGetConversationPagedMembers
protected CompletableFuture
GetConversationPagedMembers() API for Skill. Überschreiben Sie diese Methode, um die Mitglieder einer Unterhaltung einzeln auflisten zu können. Diese REST-API verwendet eine ConversationId. Optional kann ein pageSize- und/oder fortsetzungstoken bereitgestellt werden. Es gibt ein PagedMembersResult zurück, das ein Array von ChannelAccounts enthält, das die Mitglieder der Unterhaltung darstellt, und ein Fortsetzungstoken, das zum Abrufen weiterer Werte verwendet werden kann. Eine Seite mit ChannelAccounts-Datensätzen wird mit jedem Anruf zurückgegeben. Die Anzahl der Datensätze auf einer Seite kann zwischen Kanälen und Anrufen variieren. Der pageSize-Parameter kann als Vorschlag verwendet werden. Wenn keine weiteren Ergebnisse vorhanden sind, enthält die Antwort kein Fortsetzungstoken. Wenn keine Mitglieder in der Unterhaltung vorhanden sind, sind die Mitglieder leer oder nicht in der Antwort vorhanden. Eine Antwort auf eine Anforderung mit einem Fortsetzungstoken aus einer vorherigen Anforderung kann selten Mitglieder aus einer vorherigen Anforderung zurückgeben.
Parameter:
Gibt zurück:
onGetConversations
protected CompletableFuture
OnGetConversations() API for Skill. Überschreiben Sie diese Methode, um die Unterhaltungen auflisten, an denen dieser Bot teilgenommen hat. Get from this method with a skip token The return value is a ConversationsResult, which contains an array of ConversationMembers and a skip token. Wenn das Skip-Token nicht leer ist, gibt es weitere Werte, die zurückgegeben werden sollen. Rufen Sie diese Methode erneut mit dem zurückgegebenen Token auf, um weitere Werte abzurufen. Jedes ConversationMembers -Objekt enthält die D der Unterhaltung und ein Array von ChannelAccounts, die die Mitglieder der Unterhaltung beschreiben.
Parameter:
Gibt zurück:
onReplyToActivity
protected CompletableFuture
OnReplyToActivity() API. Überschreiben Sie diese Methode, um auf eine Aktivität zu antworten. Dies unterscheidet sich geringfügig von SendToConversation(). * SendToConversation(conversationId) – fügt die Aktivität entsprechend dem Zeitstempel oder der Semantik des Kanals an das Ende der Unterhaltung an. * ReplyToActivity(conversationId,ActivityId) – fügt die Aktivität als Antwort auf eine andere Aktivität hinzu, wenn der Kanal sie unterstützt. Wenn der Kanal keine geschachtelten Antworten unterstützt, greift ReplyToActivity auf SendToConversation zurück. Verwenden Sie ReplyToActivity, wenn Sie auf eine bestimmte Aktivität in der Unterhaltung antworten. Verwenden Sie SendToConversation in allen anderen Fällen.
Parameter:
Gibt zurück:
onSendConversationHistory
protected CompletableFuture
SendConversationHistory() API for Skill. Überschreiben Sie diese Methode mit dieser Methode, damit Sie die historischen Aktivitäten in die Unterhaltung hochladen können. Der Absender muss sicherstellen, dass die historischen Aktivitäten eindeutige IDs und entsprechende Zeitstempel aufweisen. Die IDs werden vom Client verwendet, um doppelte Aktivitäten zu behandeln, und die Zeitstempel werden vom Client verwendet, um die Aktivitäten in der richtigen Reihenfolge zu rendern.
Parameter:
Gibt zurück:
onSendToConversation
protected CompletableFuture
SendToConversation() API for Skill. Mit dieser Methode können Sie eine Aktivität an das Ende einer Unterhaltung senden. Dies unterscheidet sich geringfügig von ReplyToActivity(). * SendToConversation(conversationId) – fügt die Aktivität entsprechend dem Zeitstempel oder der Semantik des Kanals an das Ende der Unterhaltung an. * ReplyToActivity(conversationId,ActivityId) – fügt die Aktivität als Antwort auf eine andere Aktivität hinzu, wenn der Kanal sie unterstützt. Wenn der Kanal keine geschachtelten Antworten unterstützt, greift ReplyToActivity auf SendToConversation zurück. Verwenden Sie ReplyToActivity, wenn Sie auf eine bestimmte Aktivität in der Unterhaltung antworten. Verwenden Sie SendToConversation in allen anderen Fällen.
Parameter:
Gibt zurück:
onUpdateActivity
protected CompletableFuture
OnUpdateActivity() API. Überschreiben Sie diese Methode, um eine zuvor gesendete vorhandene Aktivität zu bearbeiten. In einigen Kanälen können Sie eine vorhandene Aktivität bearbeiten, um den neuen Status einer Bot-Unterhaltung widerzuspiegeln. Beispielsweise können Sie Schaltflächen entfernen, nachdem jemand auf die Schaltfläche "Genehmigen" geklickt hat.
Parameter:
Gibt zurück:
onUploadAttachment
protected CompletableFuture
UploadAttachment() API. Überschreiben Sie diese Methode, um Daten in einem kompatiblen Speicher zu speichern, wenn es um Unternehmen geht. Die Antwort ist eine ResourceResponse, die eine AttachmentId enthält, die für die Verwendung mit der Anlagen-API geeignet ist.
Parameter:
Gibt zurück: