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

    Class PasswordAuthenticationInfo

    Used for password-based authentication.

    const authentication = new PasswordAuthenticationInfo('admin', 'password');
    const serviceInfo = {
        ipAddress: 'localhost',
        port: 9000
    };
    const client = new StandardDoipClient({ authentication, serviceInfo });

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    username password asUserId? clientId?

    Methods

    getAuthentication getClientId

    Constructors

    • Constructs a PasswordAuthenticationInfo.

      Parameters

      • username: string

        Username to use for authentication

      • password: string

        Password to use for authentication

      • OptionalasUserId: string

        If present, instructs the DOIP service to perform operations as this user

      • OptionalclientId: string

        Optional clientId to send in requests using this token

      Returns PasswordAuthenticationInfo

    Properties

    username: string
    password: string
    asUserId?: string
    clientId?: string

    Methods

    • Returns (async) the authentication property to be used in DOIP requests made with this AuthenticationInfo.

      Returns Promise<Json>

    • Returns the clientId property to be used in DOIP requests made with this AuthenticationInfo.

      Returns undefined | string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods