Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Functions

addUserReaction

  • description

    Add a user reaction

    async
    since

    2.29.0

    example
    addUserReaction({
    targetId: "target-1",
    reactionSpaceId: "aa7e03fc-01f0-4a98-a2e0-3fed689632d7",
    reactionId: "0fddc166-b8c3-4ce9-990e-848bde12188b"
    }).then(reaction => console.log(reaction))

    Parameters

    Returns Promise<IUserReaction>

getUserReactions

  • description

    Get list of user reaction based on argument object filters

    async
    since

    2.29.0

    example
    getUserReactions({
    reactionSpaceId: "aa7e03fc-01f0-4a98-a2e0-3fed689632d7",
    targetId: "0fddc166-b8c3-4ce9-990e-848bde12188b"
    }).then(paginatedReactions => console.log(paginatedReactions))

    Parameters

    Returns Promise<IPaginatedResponse<IUserReaction>>

getUserReactionsCount

  • description

    get count of user reactions for a given collection of target in a reaction space

    async
    since

    2.29.0

    example
    getUserReactionsCount({
    reactionSpaceId: "aa7e03fc-01f0-4a98-a2e0-3fed689632d7",
    targetIds: ["0fddc166-b8c3-4ce9-990e-848bde12188b"],
    }).then(reaction => console.log(reaction))

    Parameters

    Returns Promise<IPaginatedResponse<IReactionsCount>>

removeUserReaction

  • description

    Remove a user reaction

    async
    since

    2.29.0

    example
    removeUserReaction({
    reactionSpaceId: "aa7e03fc-01f0-4a98-a2e0-3fed689632d7",
    userReactionId: "0fddc166-b8c3-4ce9-990e-848bde12188b"
    })

    Parameters

    Returns Promise<null>

Legend

  • Namespace
  • Variable
  • Function
  • Function with type parameter
  • Type alias
  • Interface
  • Interface with type parameter
  • Enumeration

Generated using TypeDoc