Variable NodeTimeZoneSetupServiceConst

Type declaration

• constructTimeZonePayload:function

  • constructTimeZonePayload(
        nodeId: string,
        timeServiceParams: TimeServiceParamsInterface,
        timeZoneString: string,
    ): Record<string, any>

  • Constructs the payload for setting the time zone on a node.

    Parameters

    • nodeId: string

      The ID of the node.
    • timeServiceParams: TimeServiceParamsInterface

      The time service parameters.
    • timeZoneString: string

      The time zone string to set.

    Returns Record<string, any>

    The constructed payload object.

• extractTimeServiceFromNodeConfig:function

  • extractTimeServiceFromNodeConfig(
        nodeConfig: ESPRMNodeConfigInterface,
    ): Promise<null | TimeServiceParamsInterface>

  • Extracts the time service and its time zone parameter from the node configuration.

    Parameters

    • nodeConfig: ESPRMNodeConfigInterface

      The node configuration object.

    Returns Promise<null | TimeServiceParamsInterface>

    A promise that resolves to the time service parameters or null if not found.

• getNodeConfig:function

  • getNodeConfig(nodeId: string): Promise<ESPRMNodeConfigInterface>

  • Retrieves the node configuration required to set the time zone.

    Parameters

    • nodeId: string

      The ID of the node.

    Returns Promise<ESPRMNodeConfigInterface>

    A promise that resolves to the node configuration object.

• getNodeConnectivityStatus:function

  • getNodeConnectivityStatus(
        nodeId: string,
    ): Promise<ESPRMConnectivityStatusInterface>

  • Retrieves the connectivity status of a node.

    Parameters

    • nodeId: string

      The ID of the node.

    Returns Promise<ESPRMConnectivityStatusInterface>

    A promise that resolves to the node's connectivity status object.

• getUserTimeZone:function

  • getUserTimeZone(): Promise<undefined | string>

  • Fetches the user's time zone from user's custom data.

    Returns Promise<undefined | string>

    A promise that resolves to the user's time zone string or undefined if not found.

• setNodeTimeZone:function

  • setNodeTimeZone(
        payload: Record<string, any>,
        progressCallback: () => void,
    ): Promise<ESPAPIResponse>

  • Sets the time zone for a node.

    Parameters

    • payload: Record<string, any>

      The payload containing the time zone data.
    • progressCallback: () => void

      A callback function to report progress.

    Returns Promise<ESPAPIResponse>

    A promise that resolves to the API response.

• waitForNodeConnectivity:function

  • waitForNodeConnectivity(
        nodeId: string,
        progressCallback: () => void,
        maxRetries?: number,
        interval?: number,
    ): Promise<boolean>

  • Waits for a node to become connected, retrying at intervals.

    Parameters

    • nodeId: string

      The ID of the node.
    • progressCallback: () => void

      A callback function to report progress.
    • maxRetries: number = 5

      The maximum number of retries (default is 5).
    • interval: number = 5000

      The interval between retries in milliseconds (default is 5000).

    Returns Promise<boolean>

    A promise that resolves to true if the node is connected, or false if retries are exhausted.