@hashgraph/solo
    Preparing search index...

    Interface LockRenewalService

    interface LockRenewalService {
        calculateRenewalDelay(lease: Lock): Duration;
        cancel(scheduleId: number): Promise<boolean>;
        cancelAll(): Promise<Map<number, boolean>>;
        isScheduled(scheduleId: number): Promise<boolean>;
        schedule(lease: Lock): Promise<number>;
    }

    Implemented by

    Index

    Methods

    calculateRenewalDelay cancel cancelAll isScheduled schedule

    Methods

    • Cancels a scheduled lease renewal.

      Parameters

      • scheduleId: number

        the unique identifier of the scheduled lease renewal.

      Returns Promise<boolean>

      true if the lease renewal was successfully cancelled; false otherwise.

    • Cancels all scheduled lease renewals.

      Returns Promise<Map<number, boolean>>

      a map of the unique identifiers of the scheduled lease renewals and their cancellation status.

    • Determines if a lease renewal is scheduled.

      Parameters

      • scheduleId: number

        the unique identifier of the scheduled lease renewal.

      Returns Promise<boolean>

      true if the lease renewal is scheduled; false otherwise.

    • Schedules a lease renewal.

      Parameters

      • lease: Lock

        the lease to be renewed.

      Returns Promise<number>

      the unique identifier of the scheduled lease renewal.

    Settings

    Member Visibility

    On This Page

    Methods