Class SupportedAttributeClient<T>

Readonlyattribute

ReadonlyclusterId

ReadonlyendpointId

Readonlyid

Readonlyname

addListener

• addListener(listener): void

• Add a listener to the attribute.

  Parameters

  • listener: ((newValue: T) => void)
    • • (newValue): void

      • Parameters

        • newValue: T

        Returns void

  Returns void

get

• get(alwaysRequestFromRemote?, isFabricFiltered?): Promise<undefined | T>

• Get the value of the attribute. Fabric scoped reads are always done with the remote.

  Parameters

  • OptionalalwaysRequestFromRemote: boolean
  • isFabricFiltered: boolean = true

  Returns Promise<undefined | T>

getWithVersion

• getWithVersion(alwaysRequestFromRemote?, isFabricFiltered?): Promise<undefined | {
      value: T;
      version: number;
  }>

• Get the value with version of the attribute. Fabric scoped reads are always done with the remote.

  Parameters

  • OptionalalwaysRequestFromRemote: boolean
  • isFabricFiltered: boolean = true

  Returns Promise<undefined | {
      value: T;
      version: number;
  }>

removeListener

• removeListener(listener): void

• Remove a listener from the attribute.

  Parameters

  • listener: ((newValue: T) => void)
    • • (newValue): void

      • Parameters

        • newValue: T

        Returns void

  Returns void

set

• set(value, dataVersion?): Promise<void>

• Set the value of the attribute. When dataVersion parameter is provided the value is only set when the cluster dataVersion of the server matches. If it does not match it is rejected with an Error.

  Parameters

  • value: T
  • OptionaldataVersion: number

  Returns Promise<void>

subscribe

• subscribe(minIntervalFloorSeconds, maxIntervalCeilingSeconds, knownDataVersion?, isFabricFiltered?): Promise<void>

• Subscribe to the attribute.

  Parameters

  • minIntervalFloorSeconds: number
  • maxIntervalCeilingSeconds: number
  • OptionalknownDataVersion: number
  • isFabricFiltered: boolean = true

  Returns Promise<void>