i2 Connect SDK
Search results for

    Show/hide table of contents

    Home > @i2analyze/i2connect

    i2connect package

    The i2 Connect Server package, which contains all the functionality you need to create connectors for the i2 Connect server.

    Classes

    Class Description
    AuthenticationRequiredError An error indicating that authentication is required.
    DetailedError An error indicating that a problem occurred during a service call.
    Result A result from a service method on a connector for the i2 Connect server.
    Server The i2 Connect server.

    Functions

    Function Description
    asyncState() The @asyncState decorator, which configures a service method parameter to receive an IAsyncState object.
    authenticationField(config) The @authenticationField decorator, which configures an authenticator method parameter to receive the value from a field on an authentication dialog.
    authenticationToken(authConfigId) The @authenticationToken decorator, which configures a service method parameter to receive the value of the token associated with an authenticator.
    authenticator(config) The @authenticator decorator, which configures a method on the connector class to perform user authentication.
    condition(condition) The @condition decorator, which configures a service method parameter to receive a value that a user provides, subject to a condition that you specify.
    connector(config) The @connector decorator, which configures a class to be a connector for the i2 Connect server.
    createLogger(id) Creates or retrieves a logger object with the specified identifier.
    jwt() The @jwt decorator, which configures a service method parameter to receive a JSON Web Token (JWT).
    seeds(constraints) The @seeds decorator, which configures a service method parameter to receive records to use as seeds.
    service(config) The @service decorator, which configures a method on the connector class to be an i2 Connect service.

    Interfaces

    Interface Description
    IAsyncState A collection of methods through which an i2 Connect service method can communicate with a user who initiated a long-running operation.
    IDetailedErrorData A set of detailed error information for a DetailedError object.
    ILogger A diagnostic logger that i2 Connect services can use.
    IRequestInformation A set of information from an incoming HTTP request.
    ISecurityPermission A set of access levels associated with the values of a particular security dimension.
    ISeeds A set of seed records that the i2 Connect server passes to a service method.
    ISubstatus A piece of information about the progress of a long-running service method call.

    Namespaces

    Namespace Description
    connectors The members of the connectors namespace allow you to configure the connectors that you create for the i2 Connect server.
    data The members of the data namespace provide access to the property values of records that an i2 Connect service operates on.
    records The members of the records namespace provide access to the contents of seed and result records in an i2 Connect service.
    schema The members of the schema namespace provide access to the specifications that govern the structure of records in an i2 Connect service.
    services The members of the services namespace define the conditions and constraints that you can place on the parameters of i2 Connect service methods.

    Type Aliases

    Type Alias Description
    AccessLevel The level of access that a user has to some data.
    LogLevel The logging level, or severity, of log messages.
    SubstatusType A type for a piece of substatus information.
    In this article
    Back to top © N. Harris Computer Corporation (2022)