MELCloud & MELCloud Home API for Node.js - v48.2.0
    Preparing search index...

    Interface BaseAPIAdapter

    Session and infrastructure surface shared by both dialects' API adapters — the cross-dialect base a consumer can program against without knowing which wire it talks to.

    interface BaseAPIAdapter {
        authenticate: (credentials: LoginCredentials) => Promise<void>;
        clearSync: () => void;
        ensureAuthenticated: () => Promise<boolean>;
        isAuthenticated: () => boolean;
        isRateLimited: boolean;
        locale: string | undefined;
        logOut: () => void;
        resumeSession: () => Promise<boolean>;
        setSyncInterval: (minutes: number | false) => void;
        timezone: string | undefined;
    }

    Hierarchy (View Summary)

    Index
    authenticate clearSync ensureAuthenticated isAuthenticated isRateLimited locale logOut resumeSession setSyncInterval timezone
    authenticate: (credentials: LoginCredentials) => Promise<void>

    Sign in with explicit credentials; throws on rejection.

    clearSync: () => void

    Cancel any pending automatic sync.

    ensureAuthenticated: () => Promise<boolean>

    Sync check first; when it reads false, one best-effort resumeSession probe, then a re-check — the lazy self-heal consumers otherwise hand-roll (a valid persisted Home token reads unauthenticated until a context fetch has run).

    isAuthenticated: () => boolean

    Whether a session is currently usable, from local state alone.

    isRateLimited: boolean

    Whether the client is currently inside a server rate-limit backoff.

    locale: string | undefined

    BCP-47 locale tag the instance was configured with, or undefined.

    logOut: () => void

    Explicit sign-out: clears the persisted session material.

    resumeSession: () => Promise<boolean>

    Best-effort session restore from persisted credentials. Never throws — returns false when no credentials are persisted or sign-in fails (logged via the SDK logger).

    setSyncInterval: (minutes: number | false) => void

    Update the automatic sync interval and reschedule. Pass false to disable.

    timezone: string | undefined

    IANA timezone the instance was configured with, or undefined.

    Settings
    Member Visibility

    On This Page
    Properties