Show / Hide Table of Contents

    Class JsonRpcRequest

    JSON-RPC request message.
    Inheritance
    Object
    JsonRpcMessage
    JsonRpcRequest
    Implements
    IJsonRpcRequest
    IJsonRpcMessage
    IHasProtocolVersion
    Inherited Members
    JsonRpcMessage.IdJsonPropertyName
    JsonRpcMessage.ShouldSerializeId()
    JsonRpcMessage.Id
    Namespace: XploRe.Net.JsonRpc
    Assembly: XploRe.Net.JsonRpc.dll
    Syntax
    public class JsonRpcRequest : JsonRpcMessage, IJsonRpcRequest, IJsonRpcMessage, IHasProtocolVersion

    Constructors

    Name Description
    JsonRpcRequest(JsonRpcId, String) Initialises a new parameterless JSON-RPC request instance.

    Fields

    Name Description
    InternalMethodPrefix Reserved method prefix for internal or extension RPC methods.
    MethodJsonPropertyName JSON-RPC property name of the Method property.
    ParametersJsonPropertyName JSON-RPC property name of the Parameters or Parameters properties of specialised request instances.
    ProtocolVersionJsonPropertyName JSON-RPC property name of the ProtocolVersion property.

    Properties

    Name Description
    Method The name of the method invoked by the request. Method names that start with "rpc." are RPC-internal and extension methods and must not be used for any other purposes.
    ProtocolVersion The JSON-RPC version of the request.

    Methods

    Name Description
    NotificationWithMethod(String) Creates a new JsonRpcRequest instance with the given method name and no request ID.
    NotificationWithMethod(String, ICollection<Object>) Creates a new JsonRpcRequest instance with the given method name, the provided positional parameters and no request ID.
    NotificationWithMethod(String, IDictionary<String, Object>) Creates a new JsonRpcRequest instance with the given method name, the provided named parameters and no request ID.
    NotificationWithMethod(String, IEnumerable<Object>) Creates a new JsonRpcRequest instance with the given method name, the provided positional parameters and no request ID.
    NotificationWithMethod<T>(String, T[]) Creates a new JsonRpcRequest instance with the given method name, the provided positional parameters and no request ID.
    WithMethod(String) Creates a new JsonRpcRequest instance with the given method name and the next automatic per-process sequential request ID.
    WithMethod(String, ICollection<Object>) Creates a new JsonRpcRequest instance with the given method name, the provided positional parameters and the next automatic per-process sequential request ID.
    WithMethod(String, ICollection<Object>, JsonRpcId) Creates a new JsonRpcRequest instance with the given method name, the provided positional parameters and the specified request ID.
    WithMethod(String, IDictionary<String, Object>) Creates a new JsonRpcRequest instance with the given method name, the provided named parameters and the next automatic per-process sequential request ID.
    WithMethod(String, IDictionary<String, Object>, JsonRpcId) Creates a new JsonRpcRequest instance with the given method name, the provided named parameters and the specified request ID.
    WithMethod(String, IEnumerable<Object>) Creates a new JsonRpcRequest instance with the given method name, the provided positional parameters and the next automatic per-process sequential request ID.
    WithMethod(String, IEnumerable<Object>, JsonRpcId) Creates a new JsonRpcRequest instance with the given method name, the provided positional parameters and the specified request ID.
    WithMethod(String, JsonRpcId) Creates a new JsonRpcRequest instance with the given method name and a specified request ID.
    WithMethod<T>(String, T[]) Creates a new JsonRpcRequest instance with the given method name, the provided positional parameters and the next automatic per-process sequential request ID.
    WithMethod<T>(String, T[], JsonRpcId) Creates a new JsonRpcRequest instance with the given method name, the provided positional parameters and the specified request ID.

    See Also

    JSON-RPC 2.0 Specification: Request Object
    Back to top Copyright © 2017-2018, xplo.re IT Services, Michael Maier. All rights reserved.