Documentation

RoomArtifactMetadata extends Message
in package

RoomArtifactMetadata is the universal structure for the 'metadata' JSON field in the pnm_room_artifacts table. All fields are optional.

Generated from protobuf message plugnmeet.RoomArtifactMetadata

Table of Contents

Properties

$file_info  : mixed
Optional: Information about the final generated file artifact.
$provider_job_info  : mixed
Optional: Information about an asynchronous provider job.
$reference_artifact_id  : mixed
A field to link a file artifact back to its usage artifact.
$usage_details  : mixed
$user_info  : mixed
Optional: Information about the user who initiated or is associated with the artifact.

Methods

__construct()  : mixed
Constructor.
clearFileInfo()  : mixed
clearProviderJobInfo()  : mixed
clearReferenceArtifactId()  : mixed
clearUserInfo()  : mixed
getCharacterCountUsage()  : RoomArtifactCharacterCountUsage|null
Generated from protobuf field <code>.plugnmeet.RoomArtifactCharacterCountUsage character_count_usage = 6;</code>
getDurationUsage()  : RoomArtifactDurationUsage|null
Generated from protobuf field <code>.plugnmeet.RoomArtifactDurationUsage duration_usage = 5;</code>
getFileInfo()  : RoomArtifactFileInfo|null
Optional: Information about the final generated file artifact.
getProviderJobInfo()  : RoomArtifactProviderJobInfo|null
Optional: Information about an asynchronous provider job.
getReferenceArtifactId()  : string
A field to link a file artifact back to its usage artifact.
getTokenUsage()  : RoomArtifactTokenUsage|null
Generated from protobuf field <code>.plugnmeet.RoomArtifactTokenUsage token_usage = 4;</code>
getUsageDetails()  : string
getUserInfo()  : RoomArtifactUserInfo|null
Optional: Information about the user who initiated or is associated with the artifact.
hasCharacterCountUsage()  : mixed
hasDurationUsage()  : mixed
hasFileInfo()  : mixed
hasProviderJobInfo()  : mixed
hasReferenceArtifactId()  : mixed
hasTokenUsage()  : mixed
hasUserInfo()  : mixed
setCharacterCountUsage()  : $this
Generated from protobuf field <code>.plugnmeet.RoomArtifactCharacterCountUsage character_count_usage = 6;</code>
setDurationUsage()  : $this
Generated from protobuf field <code>.plugnmeet.RoomArtifactDurationUsage duration_usage = 5;</code>
setFileInfo()  : $this
Optional: Information about the final generated file artifact.
setProviderJobInfo()  : $this
Optional: Information about an asynchronous provider job.
setReferenceArtifactId()  : $this
A field to link a file artifact back to its usage artifact.
setTokenUsage()  : $this
Generated from protobuf field <code>.plugnmeet.RoomArtifactTokenUsage token_usage = 4;</code>
setUserInfo()  : $this
Optional: Information about the user who initiated or is associated with the artifact.

Properties

$file_info

Optional: Information about the final generated file artifact.

protected mixed $file_info = null

Generated from protobuf field .plugnmeet.RoomArtifactFileInfo file_info = 3;

$provider_job_info

Optional: Information about an asynchronous provider job.

protected mixed $provider_job_info = null

Generated from protobuf field .plugnmeet.RoomArtifactProviderJobInfo provider_job_info = 2;

$reference_artifact_id

A field to link a file artifact back to its usage artifact.

protected mixed $reference_artifact_id = null

Generated from protobuf field optional string reference_artifact_id = 10;

$user_info

Optional: Information about the user who initiated or is associated with the artifact.

protected mixed $user_info = null

Generated from protobuf field .plugnmeet.RoomArtifactUserInfo user_info = 1;

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 \Mynaparrot\PlugnmeetProto\RoomArtifactUserInfo $user_info
      Optional: Information about the user who initiated or is associated with the artifact.
@type \Mynaparrot\PlugnmeetProto\RoomArtifactProviderJobInfo $provider_job_info
      Optional: Information about an asynchronous provider job.
@type \Mynaparrot\PlugnmeetProto\RoomArtifactFileInfo $file_info
      Optional: Information about the final generated file artifact.
@type \Mynaparrot\PlugnmeetProto\RoomArtifactTokenUsage $token_usage
@type \Mynaparrot\PlugnmeetProto\RoomArtifactDurationUsage $duration_usage
@type \Mynaparrot\PlugnmeetProto\RoomArtifactCharacterCountUsage $character_count_usage
@type string $reference_artifact_id
      A field to link a file artifact back to its usage artifact.

}

getReferenceArtifactId()

A field to link a file artifact back to its usage artifact.

public getReferenceArtifactId() : string

Generated from protobuf field optional string reference_artifact_id = 10;

Return values
string

setReferenceArtifactId()

A field to link a file artifact back to its usage artifact.

public setReferenceArtifactId(string $var) : $this

Generated from protobuf field optional string reference_artifact_id = 10;

Parameters
$var : string
Return values
$this

setUserInfo()

Optional: Information about the user who initiated or is associated with the artifact.

public setUserInfo(RoomArtifactUserInfo $var) : $this

Generated from protobuf field .plugnmeet.RoomArtifactUserInfo user_info = 1;

Parameters
$var : RoomArtifactUserInfo
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results