Class Events

constructor

• new Events(onvif: Onvif): Events

  Parameters

  • onvif: Onvif

  Returns Events

agent

globalSubscription

addEventBroker

• addEventBroker(__namedParameters: AddEventBroker): Promise<void>

  Parameters

  • __namedParameters: AddEventBroker

  Returns Promise<void>

createPullPointSubscription

• createPullPointSubscription(
      options?: CreatePullPointSubscriptionExtended,
  ): Promise<PullPointSubscription>

  This method returns a PullPointSubscription that can be polled using PullMessages. This message contains the same elements as the SubscriptionRequest of the WS-BaseNotification without the ConsumerReference. If no Filter is specified the pullpoint notifies all occurring events to the client. This method is mandatory.

  Parameters

  • Optionaloptions: CreatePullPointSubscriptionExtended

  Returns Promise<PullPointSubscription>

deleteEventBroker

• deleteEventBroker(__namedParameters: DeleteEventBroker): Promise<void>

  Parameters

  • __namedParameters: DeleteEventBroker

  Returns Promise<void>

getEventBrokers

• getEventBrokers(
      __namedParameters?: GetEventBrokers,
  ): Promise<EventBrokerConfig[]>

  Parameters

  • __namedParameters: GetEventBrokers = {}

  Returns Promise<EventBrokerConfig[]>

getEventProperties

• getEventProperties(): Promise<GetEventPropertiesResponse>

  The WS-BaseNotification specification defines a set of OPTIONAL WS-ResouceProperties. This specification does not require the implementation of the WS-ResourceProperty interface. Instead, the subsequent direct interface shall be implemented by an ONVIF compliant device in order to provide information about the FilterDialects, Schema files and topics supported by the device.

  Returns Promise<GetEventPropertiesResponse>

getServiceCapabilities

• getServiceCapabilities(): Promise<Capabilities>

  Returns Promise<Capabilities>

getStatus

• getStatus(subscription: PullPointSubscription): Promise<StatusResponse>

  Get status for WS-BaseNotification push events

  Parameters

  • subscription: PullPointSubscription

  Returns Promise<StatusResponse>

renew

• renew(
      subscription: PullPointSubscription,
      terminationTime: CommonDuration,
  ): Promise<StatusResponse>

  Renew for WS-BaseNotification push event

  Parameters

  • subscription: PullPointSubscription
  • terminationTime: CommonDuration

    time in milliseconds

  Returns Promise<StatusResponse>

resetAgent

• resetAgent(): void

  Drop in-flight PullMessages sockets (long-poll up to PULL_TIMEOUT) so unsubscribe does not leave Happytime / cameras stuck with an open request.

  Returns void

subscribe

• subscribe(options: SubscribeOptions): Promise<PullPointSubscription>

  Subscribe to events using WS-BaseNotification producer

  Parameters

  • options: SubscribeOptions

  Returns Promise<PullPointSubscription>

unsubscribe

• unsubscribe(subscription: PullPointSubscription): Promise<void>

  Unsubscribe from WS-BaseNotification push events

  Parameters

  • subscription: PullPointSubscription

  Returns Promise<void>

StaticfilterToBuild

• filterToBuild(
      filter?: PullPointSubscriptionFilter,
  ): Record<string, unknown> | undefined

  Parameters

  • Optionalfilter: PullPointSubscriptionFilter

  Returns Record<string, unknown> | undefined