Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Functions

addReactionSpaceEventListener

  • addReactionSpaceEventListener<_Event, _EventListener>(eventArg: IReactionEventArg<_Event>, listenerFn: _EventListener): Promise<void>

createReactionSpace

  • description

    Create a reaction space

    async
    since

    2.29.0

    example
    createReactionSpace({
    targetGroupId: "target-group-1",
    reactionPackIds: ["aa7e03fc-01f0-4a98-a2e0-3fed689632d7", "0fddc166-b8c3-4ce9-990e-848bde12188b"]
    }).then(reactionSpace => console.log(reactionSpace))

    Parameters

    Returns Promise<IReactionSpace>

deleteReactionSpace

  • description

    Delete a reaction space

    async
    since

    2.29.0

    example
    deleteReactionSpace({
    reactionSpaceId: "aa7e03fc-01f0-4a98-a2e0-3fed689632d7",
    })

    Parameters

    Returns Promise<null>

getReactionSpaceDetail

  • description

    Get reaction space detail from reactionSpaceId or targetGroupId

    async
    since

    2.29.0

    example
    getReactionSpaceDetail({
    reactionSpaceId: "aa7e03fc-01f0-4a98-a2e0-3fed689632d7",
    }).then(reactionSpace => console.log(reactionSpace))

    OR

    getReactionSpaceDetail({
    targetGroupId: "target-group-1",
    }).then(reactionSpace => console.log(reactionSpace))

    Parameters

    Returns Promise<IReactionSpace>

getReactionSpaces

  • description

    Get list of reaction spaces in an application

    async
    since

    2.29.0

    example
    getReactionSpaces().then(({results}) => console.log(results))
    

    Returns Promise<IPaginatedResponse<IReactionSpace>>

removeReactionSpaceEventListener

  • removeReactionSpaceEventListener<_Event, _EventListener>(eventArg: IReactionEventArg<_Event>, listenerFn?: _EventListener): Promise<void>

updateReactionSpace

  • description

    Update a reaction space with reaction pack ids or reaction space name

    async
    since

    2.29.0

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

    Parameters

    Returns Promise<IReactionSpace>

Legend

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

Generated using TypeDoc