reactionSpace | @livelike/engagementsdk

Index

Namespaces

<internal>

Functions

addReactionSpaceEventListener

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

description
Add listener for a given event type occuring in a reactionSpaceId

async
since
2.29.0

example
```
 function onUserReaction(eventDetail){
  console.log(eventDetail);
 }
addReactionSpaceEventListener({
   event: ReactionSpaceEvent.ADD_REACTION,
   reactionSpaceId: "aa7e03fc-01f0-4a98-a2e0-3fed689632d7"
 },
onUserReaction
)
```
Type parameters
- _Event: ReactionSpaceEvent
- _EventListener: ListenerFn<ADD_REACTION, IUserReaction> | ListenerFn<REMOVE_REACTION, IUserReaction> | ListenerFn<UPDATE_REACTION_SPACE, IReactionSpace>
Parameters
- eventArg: IReactionEventArg<_Event>
- listenerFn: _EventListener
Returns Promise<void>

createReactionSpace

createReactionSpace(arg: ICreateReactionSpaceArg): Promise<IReactionSpace>

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

arg: ICreateReactionSpaceArg

Returns Promise<IReactionSpace>

deleteReactionSpace

deleteReactionSpace(arg: IReactionSpaceIdArg): Promise<null>

description
Delete a reaction space

async
since
2.29.0

example
```
deleteReactionSpace({
 reactionSpaceId: "aa7e03fc-01f0-4a98-a2e0-3fed689632d7",
})
```
Parameters
- arg: IReactionSpaceIdArg
Returns Promise<null>

getReactionSpaceDetail

getReactionSpaceDetail(arg: IReactionSpaceDetailArg): Promise<IReactionSpace>

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

arg: IReactionSpaceDetailArg

Returns Promise<IReactionSpace>

getReactionSpaces

getReactionSpaces(): Promise<IPaginatedResponse<IReactionSpace>>

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>

description
Remove listener for a given event type occuring in a reactionSpaceId if no listener function passed, remove all the listeners function for a given event type

async
since
2.29.0

example
```
function onUserReaction(eventDetail){
  console.log(eventDetail);
}
removeReactionSpaceEventListener({
   event: ReactionSpaceEvent.ADD_REACTION,
   reactionSpaceId: "aa7e03fc-01f0-4a98-a2e0-3fed689632d7"
 },
onUserReaction
)
```
Type parameters
- _Event: ReactionSpaceEvent
- _EventListener: ListenerFn<ADD_REACTION, IUserReaction> | ListenerFn<REMOVE_REACTION, IUserReaction> | ListenerFn<UPDATE_REACTION_SPACE, IReactionSpace>
Parameters
- eventArg: IReactionEventArg<_Event>
- Optional listenerFn: _EventListener
Returns Promise<void>

updateReactionSpace

updateReactionSpace(arg: IUpdateReactionSpaceArg): Promise<IReactionSpace>

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

arg: IUpdateReactionSpaceArg

Returns Promise<IReactionSpace>

Generated using TypeDoc

Index

Namespaces

Functions

Functions

addReactionSpaceEventListener

Type parameters

_Event: ReactionSpaceEvent

_EventListener: ListenerFn<ADD_REACTION, IUserReaction> | ListenerFn<REMOVE_REACTION, IUserReaction> | ListenerFn<UPDATE_REACTION_SPACE, IReactionSpace>

Parameters

eventArg: IReactionEventArg<_Event>

listenerFn: _EventListener

Returns Promise<void>

createReactionSpace

Parameters

arg: ICreateReactionSpaceArg

Returns Promise<IReactionSpace>

deleteReactionSpace

Parameters

arg: IReactionSpaceIdArg

Returns Promise<null>

getReactionSpaceDetail

Parameters

arg: IReactionSpaceDetailArg

Returns Promise<IReactionSpace>

getReactionSpaces

Returns Promise<IPaginatedResponse<IReactionSpace>>

removeReactionSpaceEventListener

Type parameters

_Event: ReactionSpaceEvent

_EventListener: ListenerFn<ADD_REACTION, IUserReaction> | ListenerFn<REMOVE_REACTION, IUserReaction> | ListenerFn<UPDATE_REACTION_SPACE, IReactionSpace>

Parameters

eventArg: IReactionEventArg<_Event>

Optional listenerFn: _EventListener

Returns Promise<void>

updateReactionSpace

Parameters

arg: IUpdateReactionSpaceArg

Returns Promise<IReactionSpace>