ocpp-standard-schema

Version:
Contains OCPP JSON schemas for validation purposes
34 lines (33 loc) • 1.18 kB
TypeScript
/**
 * If provided the Charging Station shall return Display Messages with the given priority only.
 *
 */
export declare type MessagePriorityEnumType = 'AlwaysFront' | 'InFront' | 'NormalCycle';
/**
 * If provided the Charging Station shall return Display Messages with the given state only.
 *
 */
export declare type MessageStateEnumType = 'Charging' | 'Faulted' | 'Idle' | 'Unavailable';
export default interface GetDisplayMessagesRequest {
    customData?: CustomDataType;
    /**
     * If provided the Charging Station shall return Display Messages of the given ids. This field SHALL NOT contain more ids than set in &lt;&lt;configkey-number-of-display-messages,NumberOfDisplayMessages.maxLimit&gt;&gt;
     *
     *
     */
    id?: [number, ...number[]];
    /**
     * The Id of this request.
     *
     */
    requestId: number;
    priority?: MessagePriorityEnumType;
    state?: MessageStateEnumType;
}
/**
 * This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.
 */
export interface CustomDataType {
    vendorId: string;
    [k: string]: unknown;
}