Interface ServiceReference

Readonlyocs

compareTo

• compareTo(that: ServiceReference): number

  Compares this reference to another.

  Parameters

  • that: ServiceReference

    other service reference

  Returns number

  A number whose sign indicates the relative order of the two services: negative if this service is less than that service, positive if this service is greater than that service, and zero if they are equal.

equals

• equals(that: ServiceReference): boolean

  Tests wether this reference is equal to another.

  Parameters

  • that: ServiceReference

    other reference.

  Returns boolean

getBundle

• getBundle(): Bundle

  Gets the bundle which registered this service reference.

  Returns Bundle

getId

• getId(): number

  The id of the service.

  Returns number

getOCs

• getOCs(): readonly string[]

  The interfaces provided by this service.

  Returns readonly string[]

getProperties

• getProperties(): ServiceProperties

  Provides the service metadata.

  Returns ServiceProperties

getProperty

• getProperty<T = unknown>(key: string, ignoreCase?: boolean): undefined | T

  Provides a single service metadata entry.

  Type Parameters

  • T = unknown

    The type of the entry.

  Parameters

  • key: string

    The key of the entry.
  • OptionalignoreCase: boolean

    If true, the key is compared case insensitive.

  Returns undefined | T

getPropertyKeys

• getPropertyKeys(): readonly string[]

  Gets all service metadata keys.

  Returns readonly string[]

getRanking

• getRanking(): number

  The ranking of this service. If services provide the same interfaces, the ranking specifies which will be preferred. A higher ranking is preferred over a lower ranking. The default ranking value is 0. In case that that services have the same interface and the same ranking value, the service registered first is preferred.

  Returns number

getUsingBundles

• getUsingBundles(): readonly Bundle[]

  Provides access to all bundles currently using the service.

  Returns readonly Bundle[]

isUnregistered

• isUnregistered(): boolean

  Returns true if the service is no longer available, false otherwise.

  Returns boolean