Documentation

Notification extends Message
in package

A Notification is a Request object without an "id" member. A Request object that is a Notification signifies the Client's lack of interest in the corresponding Response object, and as such no Response object needs to be returned to the client. The Server MUST NOT reply to a Notification, including those that are within a batch request.

Notifications are not confirmable by definition, since they do not have a Response object to be returned. As such, the Client would not be aware of any errors (like e.g. "Invalid params","Internal error").

Table of Contents

Properties

$jsonrpc  : string
A String specifying the version of the JSON-RPC protocol. MUST be exactly "2.0".
$method  : string
A String containing the name of the method to be invoked. Method names that begin with the word rpc followed by a period character (U+002E or ASCII 46) are reserved for rpc-internal methods and extensions and MUST NOT be used for anything else.
$params  : object|array<string|int, mixed>|null
A Structured value that holds the parameter values to be used during the invocation of the method. This member MAY be omitted. If present, parameters for the rpc call MUST be provided as a Structured value. Either by-position through an Array or by-name through an Object. by-position: params MUST be an Array, containing the values in the Server expected order. by-name: params MUST be an Object, with member names that match the Server expected parameter names. The absence of expected names MAY result in an error being generated. The names MUST match exactly, including case, to the method's expected parameters.

Methods

__construct()  : mixed
__toString()  : string
isNotification()  : bool
A message is considered a Notification if it has a method but no ID.
parse()  : Message
Returns the appropriate Message subclass

Properties

$jsonrpc

A String specifying the version of the JSON-RPC protocol. MUST be exactly "2.0".

public string $jsonrpc = '2.0'

$method

A String containing the name of the method to be invoked. Method names that begin with the word rpc followed by a period character (U+002E or ASCII 46) are reserved for rpc-internal methods and extensions and MUST NOT be used for anything else.

public string $method

$params

A Structured value that holds the parameter values to be used during the invocation of the method. This member MAY be omitted. If present, parameters for the rpc call MUST be provided as a Structured value. Either by-position through an Array or by-name through an Object. by-position: params MUST be an Array, containing the values in the Server expected order. by-name: params MUST be an Object, with member names that match the Server expected parameter names. The absence of expected names MAY result in an error being generated. The names MUST match exactly, including case, to the method's expected parameters.

public object|array<string|int, mixed>|null $params

Methods

__construct()

public __construct(string $method[, mixed $params = null ]) : mixed
Parameters
$method : string
$params : mixed = null

__toString()

public __toString() : string
Return values
string

isNotification()

A message is considered a Notification if it has a method but no ID.

public static isNotification(object $msg) : bool
Parameters
$msg : object

A decoded message body

Return values
bool

parse()

Returns the appropriate Message subclass

public static parse(string $msg) : Message
Parameters
$msg : string
Return values
Message 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results