Conversations Schnittstelle

public abstract CompletableFuture createConversation(ConversationParameters parameters)

CreateConversation. Erstellen Sie eine neue Unterhaltung. 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 is false) Members array contining the members you want to have in the conversation. Der Rückgabewert ist ein ResourceResponse,der eine Unterhaltungs-ID enthält, die für die Verwendung in der Nachrichtennutzlast und REST-API-URIs geeignet ist. Die meisten Kanäle unterstützen nur die Semantik von Bots, die eine direkte Nachrichtenunterhaltung initiieren. Ein Beispiel dafür wäre: ''' var resource = await connector.conversations.CreateConversation(new ConversationParameters(){ Bot = bot, members = new ChannelAccount[] { new ChannelAccount("user1") } ); await connect. Conversations.SendToConversation(resource. ID, neue Aktivität() ... ) ; ```

Parameter:

Gibt zurück:

public abstract CompletableFuture deleteActivity(String conversationId, String activityId)

DeleteActivity. Löschen einer vorhandenen Aktivität. 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:

public abstract CompletableFuture deleteConversationMember(String conversationId, String memberId)

DeleteConversationMember. Löscht ein Mitglied aus einer Unterhaltung. Diese REST-API akzeptiert eine ConversationId und eine MemberId (vom Typ Zeichenfolge) 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:

public abstract CompletableFuture> getActivityMembers(String conversationId, String activityId)

GetActivityMembers. Aufzählen der Mitglieder einer Aktivität. Diese REST-API akzeptiert eine ConversationId und eine ActivityId und gibt ein Array von ChannelAccount-Objekten zurück, die die Mitglieder der bestimmten Aktivität in der Unterhaltung darstellen.

Parameter:

Gibt zurück:

public abstract CompletableFuture getConversationMember(String userId, String conversationId)

Ruft ein einzelnes Mitglied einer Unterhaltung anhand der ID ab.

Parameter:

Gibt zurück:

public abstract CompletableFuture> getConversationMembers(String conversationId)

GetConversationMembers. Aufzählen der Mitglieder einer Konverstion. Diese REST-API akzeptiert eine ConversationId und gibt ein Array von ChannelAccount-Objekten zurück, die die Mitglieder der Unterhaltung darstellen.

Parameter:

Gibt zurück:

public abstract CompletableFuture getConversationPagedMembers(String conversationId)

Auflisten der Mitglieder einer Unterhaltung um jeweils eine Seite. 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. 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:

public abstract CompletableFuture getConversationPagedMembers(String conversationId, String continuationToken)

Auflisten der Mitglieder einer Unterhaltung um jeweils eine Seite. 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. 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:

public abstract CompletableFuture getConversations()

GetConversations. Auflisten der Unterhaltungen, 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 ID der Unterhaltung und ein Array von ChannelAccounts, die die Mitglieder der Unterhaltung beschreiben.

Gibt zurück:

public abstract CompletableFuture getConversations(String continuationToken)

GetConversations. Auflisten der Unterhaltungen, 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 ID der Unterhaltung und ein Array von ChannelAccounts, die die Mitglieder der Unterhaltung beschreiben.

Parameter:

Gibt zurück:

public default CompletableFuture replyToActivity(Activity activity)

ReplyToActivity. Mit dieser Methode können Sie auf eine Aktivität 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:

public abstract CompletableFuture replyToActivity(String conversationId, String activityId, Activity activity)

ReplyToActivity. Mit dieser Methode können Sie auf eine Aktivität 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:

public abstract CompletableFuture sendConversationHistory(String conversationId, Transcript history)

Mit dieser Methode können Sie die historischen Aktivitäten in die Unterhaltung hochladen. 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:

public default CompletableFuture sendToConversation(Activity activity)

SendToConversation. Mit dieser Methode können Sie eine Aktivität an das Ende einer Unterhaltung senden. Dies unterscheidet sich geringfügig von ReplyToActivity(). sendToConverstion(activity) – fügt die Aktivität an das Ende der Unterhaltung entsprechend dem Zeitstempel oder der Semantik des Kanals an, wobei "Activity.getConversation.getId" für die Unterhaltungs-ID verwendet wird. 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:

public abstract CompletableFuture sendToConversation(String conversationId, Activity activity)

SendToConversation. Mit dieser Methode können Sie eine Aktivität an das Ende einer Unterhaltung senden. Dies unterscheidet sich geringfügig von ReplyToActivity(). SendToConverstion(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:

public default CompletableFuture updateActivity(Activity activity)

UpdateActivity. Bearbeiten einer vorhandenen Aktivität. 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:

public abstract CompletableFuture updateActivity(String conversationId, String activityId, Activity activity)

UpdateActivity. Bearbeiten einer vorhandenen Aktivität. 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:

public abstract CompletableFuture uploadAttachment(String conversationId, AttachmentData attachmentUpload)

UploadAttachment. Laden Sie eine Anlage direkt in den BLOB-Speicher eines Kanals hoch. Dies ist nützlich, da Sie Daten in einem kompatiblen Speicher speichern können, 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: