Feeds

Feeds allow users to opt-in to receiving push notifications from applications or organizations. The APIs here allow applications to query or request changes to the state of the users current subscriptions.

This functionality is only available if the user is currently signed-in with an OpenFin ID.

Index

Functions

Functions

isSubscribed

  • isSubscribed(feedId: string): Promise<boolean>

  • Checks if the currently logged in user is subscribed to the given feed.

    throws

    If there is no user currently logged in

    throws

    If the given feedId does not map to a known feed

    throws

    If the version of the provider version is insufficient

    since

    0.12.3

    Parameters

    • feedId: string

      The ID of the feed to query

    Returns Promise<boolean>

requestSubscribe

  • requestSubscribe(feedId: string): Promise<void>

  • Creates a notification prompting the user to subscribe to the given feed.

    throws

    If there is no user currently logged in

    throws

    If the given feedId does not map to a known feed

    throws

    If the version of the provider version is insufficient

    since

    0.12.3

    Parameters

    • feedId: string

      The ID of the feed to query

    Returns Promise<void>