Documentation

ChatMessage extends Message
in package

Generated from protobuf message <code>livekit.ChatMessage</code>

Table of Contents

Properties

$deleted  : mixed
true to remove message
$edit_timestamp  : mixed
populated only if the intent is to edit/update an existing message
$generated  : mixed
true if the chat message has been generated by an agent from a participant's audio transcription
$id  : mixed
uuid
$message  : mixed
Generated from protobuf field <code>string message = 4;</code>
$timestamp  : mixed
Generated from protobuf field <code>int64 timestamp = 2;</code>

Methods

__construct()  : mixed
Constructor.
clearEditTimestamp()  : mixed
getDeleted()  : bool
true to remove message
getEditTimestamp()  : int|string
populated only if the intent is to edit/update an existing message
getGenerated()  : bool
true if the chat message has been generated by an agent from a participant's audio transcription
getId()  : string
uuid
getMessage()  : string
Generated from protobuf field <code>string message = 4;</code>
getTimestamp()  : int|string
Generated from protobuf field <code>int64 timestamp = 2;</code>
hasEditTimestamp()  : mixed
setDeleted()  : $this
true to remove message
setEditTimestamp()  : $this
populated only if the intent is to edit/update an existing message
setGenerated()  : $this
true if the chat message has been generated by an agent from a participant's audio transcription
setId()  : $this
uuid
setMessage()  : $this
Generated from protobuf field <code>string message = 4;</code>
setTimestamp()  : $this
Generated from protobuf field <code>int64 timestamp = 2;</code>

Properties

$deleted

true to remove message

protected mixed $deleted = false

Generated from protobuf field bool deleted = 5;

$edit_timestamp

populated only if the intent is to edit/update an existing message

protected mixed $edit_timestamp = null

Generated from protobuf field optional int64 edit_timestamp = 3;

$generated

true if the chat message has been generated by an agent from a participant's audio transcription

protected mixed $generated = false

Generated from protobuf field bool generated = 6;

$id

uuid

protected mixed $id = ''

Generated from protobuf field string id = 1;

$message

Generated from protobuf field <code>string message = 4;</code>

protected mixed $message = ''

$timestamp

Generated from protobuf field <code>int64 timestamp = 2;</code>

protected mixed $timestamp = 0

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : array<string|int, mixed> = null

{ Optional. Data for populating the Message object.

@type string $id
      uuid
@type int|string $timestamp
@type int|string $edit_timestamp
      populated only if the intent is to edit/update an existing message
@type string $message
@type bool $deleted
      true to remove message
@type bool $generated
      true if the chat message has been generated by an agent from a participant's audio transcription

}

clearEditTimestamp()

public clearEditTimestamp() : mixed

getDeleted()

true to remove message

public getDeleted() : bool

Generated from protobuf field bool deleted = 5;

Return values
bool

getEditTimestamp()

populated only if the intent is to edit/update an existing message

public getEditTimestamp() : int|string

Generated from protobuf field optional int64 edit_timestamp = 3;

Return values
int|string

getGenerated()

true if the chat message has been generated by an agent from a participant's audio transcription

public getGenerated() : bool

Generated from protobuf field bool generated = 6;

Return values
bool

getId()

uuid

public getId() : string

Generated from protobuf field string id = 1;

Return values
string

getMessage()

Generated from protobuf field <code>string message = 4;</code>

public getMessage() : string
Return values
string

getTimestamp()

Generated from protobuf field <code>int64 timestamp = 2;</code>

public getTimestamp() : int|string
Return values
int|string

hasEditTimestamp()

public hasEditTimestamp() : mixed

setDeleted()

true to remove message

public setDeleted(bool $var) : $this

Generated from protobuf field bool deleted = 5;

Parameters
$var : bool
Return values
$this

setEditTimestamp()

populated only if the intent is to edit/update an existing message

public setEditTimestamp(int|string $var) : $this

Generated from protobuf field optional int64 edit_timestamp = 3;

Parameters
$var : int|string
Return values
$this

setGenerated()

true if the chat message has been generated by an agent from a participant's audio transcription

public setGenerated(bool $var) : $this

Generated from protobuf field bool generated = 6;

Parameters
$var : bool
Return values
$this

setId()

uuid

public setId(string $var) : $this

Generated from protobuf field string id = 1;

Parameters
$var : string
Return values
$this

setMessage()

Generated from protobuf field <code>string message = 4;</code>

public setMessage(string $var) : $this
Parameters
$var : string
Return values
$this

setTimestamp()

Generated from protobuf field <code>int64 timestamp = 2;</code>

public setTimestamp(int|string $var) : $this
Parameters
$var : int|string
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results