UnrealVoxta 0.1.1
 
Loading...
Searching...
No Matches
ServerResponseChatMessageBase Struct Reference

ServerResponseChatMessageBase Abstract read-only data struct containing the shared relevant data for all 'reply...' responses from the VoxtaServer (e.g., message start, chunk, end, cancelled). More...

#include <ServerResponseChatMessageBase.h>

Inheritance diagram for ServerResponseChatMessageBase:
ServerResponseBase ServerResponseChatMessageCancelled ServerResponseChatMessageChunk ServerResponseChatMessageEnd ServerResponseChatMessageStart

Public Types

enum class  ChatMessageType { MessageStart , MessageChunk , MessageEnd , MessageCancelled }
 Contains the possible states of the message that is currently being generated by Voxta. More...
 

Public Member Functions

 ServerResponseChatMessageBase (ChatMessageType messageType, FGuid messageId, FGuid sessionId)
 Construct a base chat message response.
 
- Public Member Functions inherited from ServerResponseBase
virtual ~ServerResponseBase ()=default
 
 ServerResponseBase (ServerResponseType responseType)
 

Public Attributes

const ChatMessageType MESSAGE_TYPE
 The type of this chat message (start, chunk, end, cancelled).
 
const FGuid MESSAGE_ID
 The unique ID of the message.
 
const FGuid SESSION_ID
 The session ID this message belongs to.
 
- Public Attributes inherited from ServerResponseBase
const ServerResponseType RESPONSE_TYPE
 The type of this server response.
 

Detailed Description

ServerResponseChatMessageBase Abstract read-only data struct containing the shared relevant data for all 'reply...' responses from the VoxtaServer (e.g., message start, chunk, end, cancelled).

Provides message type, message ID, and session ID.

Member Enumeration Documentation

◆ ChatMessageType

Contains the possible states of the message that is currently being generated by Voxta.

Enumerator
MessageStart 
MessageChunk 
MessageEnd 
MessageCancelled 

Constructor & Destructor Documentation

◆ ServerResponseChatMessageBase()

ServerResponseChatMessageBase::ServerResponseChatMessageBase ( ChatMessageType messageType,
FGuid messageId,
FGuid sessionId )
inlineexplicit

Construct a base chat message response.

Parameters
messageTypeThe type of the chat message (start, chunk, end, cancelled).
messageIdThe unique ID of the message.
sessionIdThe session ID this message belongs to.

Member Data Documentation

◆ MESSAGE_ID

const FGuid ServerResponseChatMessageBase::MESSAGE_ID

The unique ID of the message.

◆ MESSAGE_TYPE

const ChatMessageType ServerResponseChatMessageBase::MESSAGE_TYPE

The type of this chat message (start, chunk, end, cancelled).

◆ SESSION_ID

const FGuid ServerResponseChatMessageBase::SESSION_ID

The session ID this message belongs to.


The documentation for this struct was generated from the following file: