DOIP Client Library - JavaScript Version
    Preparing search index...

    Interface DoipRequest

    A DOIP request is sent to a DOIP service to perform an operation on a digital object or service.

    interface DoipRequest {
        requestId?: string;
        clientId?: string;
        targetId: string;
        operationId: string;
        attributes?: Json;
        authentication?: Json | AuthenticationInfo;
        input?:
            | ArrayBuffer
            | ArrayBufferView<ArrayBufferLike>
            | Blob
            | Json
            | InDoipMessage
            | ReadableStream<Uint8Array<ArrayBufferLike>>;
    }
    Index

    Properties

    requestId? clientId? targetId operationId attributes? authentication? input?

    Properties

    requestId?: string

    Identifier for the request. If not provided, the client implementation will generate one if needed.

    clientId?: string

    Identifier for the client making the request. If authentication is provided as an AuthenticationInfo, that can provide the clientId instead of it being provided directly here.

    targetId: string

    Identifier of the target digital object or service. This is the entity on which the operation will be performed.

    operationId: string

    Identifier of the operation to perform.

    attributes?: Json

    Additional parameters for the request. The exact properties depend on the type of request.

    authentication?: Json | AuthenticationInfo

    Authentication information for the request. This can arbitrary JSON, though it is frequently an AuthenticationInfo.

    input?:
        | ArrayBuffer
        | ArrayBufferView<ArrayBufferLike>
        | Blob
        | Json
        | InDoipMessage
        | ReadableStream<Uint8Array<ArrayBufferLike>>

    Input data for the request.

    The type of the input is very flexible. InDoipMessage provides the general case of a multi-segment DOIP message, but it is generally preferable to provide arbitrary JSON directly, or bytes as a ReadableStream, Blob, ArrayBuffer, or ArrayBufferView.

    Settings

    Member Visibility

    On This Page

    Properties