@citrineos/configuration/dist/module/2.0.1/MessageApi.d.ts

The configuration module for OCPP v2.0.1. This module is not intended to be used directly, but rather as a dependency for other modules.

import type { FastifyInstance } from 'fastify';
import type { ILogObj } from 'tslog';
import { Logger } from 'tslog';
import type { IConfigurationModuleApi } from '../interface.js';
import { ConfigurationModule } from '../module.js';
import type { CallAction, IMessageConfirmation } from '@citrineos/base';
import { AbstractModuleApi, OCPP2_0_1 } from '@citrineos/base';
/**
 * Server API for the Configuration component.
 */
export declare class ConfigurationOcpp201Api extends AbstractModuleApi<ConfigurationModule> implements IConfigurationModuleApi {
    /**
     * Constructor for the class.
     *
     * @param {ConfigurationModule} ConfigurationComponent - The Configuration component.
     * @param {FastifyInstance} server - The server instance.
     * @param {Logger<ILogObj>} [logger] - Optional logger instance.
     */
    constructor(ConfigurationComponent: ConfigurationModule, server: FastifyInstance, logger?: Logger<ILogObj>);
    setNetworkProfile(identifier: string[], request: OCPP2_0_1.SetNetworkProfileRequest, callbackUrl?: string, extraQueries?: Record<string, any>, tenantId?: number): Promise<IMessageConfirmation[]>;
    clearDisplayMessage(identifier: string[], request: OCPP2_0_1.ClearDisplayMessageRequest, callbackUrl?: string, tenantId?: number): Promise<IMessageConfirmation[]>;
    getDisplayMessages(identifier: string[], request: OCPP2_0_1.GetDisplayMessagesRequest, callbackUrl?: string, tenantId?: number): Promise<IMessageConfirmation[]>;
    publishFirmware(identifier: string[], request: OCPP2_0_1.PublishFirmwareRequest, callbackUrl?: string, tenantId?: number): Promise<IMessageConfirmation[]>;
    setDisplayMessage(identifier: string[], request: OCPP2_0_1.SetDisplayMessageRequest, callbackUrl?: string, tenantId?: number): Promise<IMessageConfirmation[]>;
    unpublishFirmware(identifier: string[], request: OCPP2_0_1.UnpublishFirmwareRequest, callbackUrl?: string, tenantId?: number): Promise<IMessageConfirmation[]>;
    updateFirmware(identifier: string[], request: OCPP2_0_1.UpdateFirmwareRequest, callbackUrl?: string, tenantId?: number): Promise<IMessageConfirmation[]>;
    reset(identifier: string[], request: OCPP2_0_1.ResetRequest, callbackUrl?: string, tenantId?: number): Promise<IMessageConfirmation[]>;
    changeAvailability(identifier: string[], request: OCPP2_0_1.ChangeAvailabilityRequest, callbackUrl?: string, tenantId?: number): Promise<IMessageConfirmation[]>;
    triggerMessage(identifier: string[], request: OCPP2_0_1.TriggerMessageRequest, callbackUrl?: string, tenantId?: number): Promise<IMessageConfirmation[]>;
    dataTransfer(identifier: string[], request: OCPP2_0_1.DataTransferRequest, callbackUrl?: string, tenantId?: number): Promise<IMessageConfirmation[]>;
    /**
     * Overrides superclass method to generate the URL path based on the input {@link CallAction} and the module's endpoint prefix configuration.
     *
     * @param {CallAction} input - The input {@link CallAction}.
     * @return {string} - The generated URL path.
     */
    protected _toMessagePath(input: CallAction): string;
}