Class ChatMessage
Inherited Members
Namespace: LiveKit.Proto
Assembly: Uniform.LiveKit.Protocol.dll
Syntax
public sealed class ChatMessage : IMessage<ChatMessage>, IEquatable<ChatMessage>, IDeepCloneable<ChatMessage>, IBufferMessage, IMessage
Constructors
ChatMessage()
Declaration
public ChatMessage()
ChatMessage(ChatMessage)
Declaration
public ChatMessage(ChatMessage other)
Parameters
| Type | Name | Description |
|---|---|---|
| ChatMessage | other |
Fields
DeletedFieldNumber
Field number for the "deleted" field.
Declaration
public const int DeletedFieldNumber = 5
Field Value
| Type | Description |
|---|---|
| int |
EditTimestampFieldNumber
Field number for the "edit_timestamp" field.
Declaration
public const int EditTimestampFieldNumber = 3
Field Value
| Type | Description |
|---|---|
| int |
GeneratedFieldNumber
Field number for the "generated" field.
Declaration
public const int GeneratedFieldNumber = 6
Field Value
| Type | Description |
|---|---|
| int |
IdFieldNumber
Field number for the "id" field.
Declaration
public const int IdFieldNumber = 1
Field Value
| Type | Description |
|---|---|
| int |
MessageFieldNumber
Field number for the "message" field.
Declaration
public const int MessageFieldNumber = 4
Field Value
| Type | Description |
|---|---|
| int |
TimestampFieldNumber
Field number for the "timestamp" field.
Declaration
public const int TimestampFieldNumber = 2
Field Value
| Type | Description |
|---|---|
| int |
Properties
Deleted
true to remove message
Declaration
public bool Deleted { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
Descriptor
Declaration
public static MessageDescriptor Descriptor { get; }
Property Value
| Type | Description |
|---|---|
| MessageDescriptor |
EditTimestamp
populated only if the intent is to edit/update an existing message
Declaration
public long EditTimestamp { get; set; }
Property Value
| Type | Description |
|---|---|
| long |
Generated
true if the chat message has been generated by an agent from a participant's audio transcription
Declaration
public bool Generated { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
HasEditTimestamp
Gets whether the "edit_timestamp" field is set
Declaration
public bool HasEditTimestamp { get; }
Property Value
| Type | Description |
|---|---|
| bool |
Id
uuid
Declaration
public string Id { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Message
Declaration
public string Message { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Parser
Declaration
public static MessageParser<ChatMessage> Parser { get; }
Property Value
| Type | Description |
|---|---|
| MessageParser<ChatMessage> |
Timestamp
Declaration
public long Timestamp { get; set; }
Property Value
| Type | Description |
|---|---|
| long |
Methods
CalculateSize()
Calculates the size of this message in Protocol Buffer wire format, in bytes.
Declaration
public int CalculateSize()
Returns
| Type | Description |
|---|---|
| int | The number of bytes required to write this message to a coded output stream. |
ClearEditTimestamp()
Clears the value of the "edit_timestamp" field
Declaration
public void ClearEditTimestamp()
Clone()
Creates a deep clone of this object.
Declaration
public ChatMessage Clone()
Returns
| Type | Description |
|---|---|
| ChatMessage | A deep clone of this object. |
Equals(ChatMessage)
Indicates whether the current object is equal to another object of the same type.
Declaration
public bool Equals(ChatMessage other)
Parameters
| Type | Name | Description |
|---|---|---|
| ChatMessage | other | An object to compare with this object. |
Returns
| Type | Description |
|---|---|
| bool | true if the current object is equal to the |
Equals(object)
Determines whether the specified object is equal to the current object.
Declaration
public override bool Equals(object other)
Parameters
| Type | Name | Description |
|---|---|---|
| object | other |
Returns
| Type | Description |
|---|---|
| bool | true if the specified object is equal to the current object; otherwise, false. |
Overrides
GetHashCode()
Serves as the default hash function.
Declaration
public override int GetHashCode()
Returns
| Type | Description |
|---|---|
| int | A hash code for the current object. |
Overrides
MergeFrom(CodedInputStream)
Merges the data from the specified coded input stream with the current message.
Declaration
public void MergeFrom(CodedInputStream input)
Parameters
| Type | Name | Description |
|---|---|---|
| CodedInputStream | input |
Remarks
See the user guide for precise merge semantics.
MergeFrom(ChatMessage)
Merges the given message into this one.
Declaration
public void MergeFrom(ChatMessage other)
Parameters
| Type | Name | Description |
|---|---|---|
| ChatMessage | other |
Remarks
See the user guide for precise merge semantics.
ToString()
Returns a string that represents the current object.
Declaration
public override string ToString()
Returns
| Type | Description |
|---|---|
| string | A string that represents the current object. |
Overrides
WriteTo(CodedOutputStream)
Writes the data to the given coded output stream.
Declaration
public void WriteTo(CodedOutputStream output)
Parameters
| Type | Name | Description |
|---|---|---|
| CodedOutputStream | output | Coded output stream to write the data to. Must not be null. |