Documentation

EncodeOutput extends Message
in package

EncodeOutput is the output message for the Encode method.

Generated from protobuf message exprml.v1.EncodeOutput

Table of Contents

Methods

__construct()  : mixed
Constructor.
getErrorMessage()  : string
Error message if is_error is true.
getIsError()  : bool
Whether an error occurred during encoding.
getText()  : string
Encoded string in JSON (or JSON-compatible YAML).
setErrorMessage()  : $this
Error message if is_error is true.
setIsError()  : $this
Whether an error occurred during encoding.
setText()  : $this
Encoded string in JSON (or JSON-compatible YAML).

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 bool $is_error
      Whether an error occurred during encoding.
@type string $error_message
      Error message if is_error is true.
@type string $text
      Encoded string in JSON (or JSON-compatible YAML).

}

getErrorMessage()

Error message if is_error is true.

public getErrorMessage() : string

Generated from protobuf field string error_message = 2 [json_name = "errorMessage"];

Return values
string

getIsError()

Whether an error occurred during encoding.

public getIsError() : bool

Generated from protobuf field bool is_error = 1 [json_name = "isError"];

Return values
bool

getText()

Encoded string in JSON (or JSON-compatible YAML).

public getText() : string

Generated from protobuf field string text = 3 [json_name = "text"];

Return values
string

setErrorMessage()

Error message if is_error is true.

public setErrorMessage(string $var) : $this

Generated from protobuf field string error_message = 2 [json_name = "errorMessage"];

Parameters
$var : string
Return values
$this

setIsError()

Whether an error occurred during encoding.

public setIsError(bool $var) : $this

Generated from protobuf field bool is_error = 1 [json_name = "isError"];

Parameters
$var : bool
Return values
$this

setText()

Encoded string in JSON (or JSON-compatible YAML).

public setText(string $var) : $this

Generated from protobuf field string text = 3 [json_name = "text"];

Parameters
$var : string
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results