Class UnbluNotificationApi

constructor

• new UnbluNotificationApi(
      notificationModule: NotificationModule,
      apiStateProvider: ApiStateProvider,
  ): UnbluNotificationApi

  Parameters

  • notificationModule: NotificationModule
  • apiStateProvider: ApiStateProvider

  Returns UnbluNotificationApi

getNotificationCount

• getNotificationCount(): Promise<number>

  Returns the number of unread messages.

  Returns Promise<number>

  The number of unread messages

  Throws

  UnbluApiError with type UnbluErrorType.ILLEGAL_STATE when the API instance is deinitialized.

off

• off(
      event: NotificationEventType,
      listener: (data?: any) => void,
  ): Promise<boolean>

  Removes a previously registered listener

  Parameters

  • event: NotificationEventType

    The event to unregister from.

  • listener: (data?: any) => void

    The listener to remove.

  Returns Promise<boolean>

  Throws

  UnbluApiError with type UnbluErrorType.ILLEGAL_STATE when the API instance is deinitialized.

on

• on(
      event: "notificationCountChange",
      listener: NotificationCountChangeListener,
  ): void

  Registers an event listener for the given event.

  Parameters

  • event: "notificationCountChange"

    The notificationCountChanged event.

  • listener: NotificationCountChangeListener

    The listener to be called.

  Returns void

  See

  UnbluAgentEmbeddedApi.NOTIFICATION_COUNT_CHANGE

  Throws

  UnbluApiError with type UnbluErrorType.ILLEGAL_STATE when the API instance is deinitialized.

• on(event: "newNotification", listener: NewNotificationListener): void

  Registers an event listener for the given event.

  Parameters

  • event: "newNotification"

    The newNotification event.

  • listener: NewNotificationListener

    The listener to be called.

  Returns void

  See

  UnbluAgentEmbeddedApi.NEW_NOTIFICATION

  Throws

  UnbluApiError with type UnbluErrorType.ILLEGAL_STATE when the API instance is deinitialized.

Static ReadonlyNEW_NOTIFICATION

Static ReadonlyNOTIFICATION_COUNT_CHANGE