HitService

new HitService()

Service for managing hits in a choreography.

Methods

create(name, count, choreoId, MemberIds) → {Promise.<Object>}

Create a new hit.

Parameters:
NameTypeDescription
namestring

Name of the hit

countnumber

Count for the hit

choreoIdstring

Choreography ID

MemberIdsArray

Array of member IDs

Returns:

Created hit

Type: 
Promise.<Object>

remove(hitId) → {Promise.<Object>}

Remove a hit by its ID.

Parameters:
NameTypeDescription
hitIdstring

Hit ID

Returns:

Response data

Type: 
Promise.<Object>

setCount(hitId, count) → {Promise.<Object>}

Set the count for a hit.

Parameters:
NameTypeDescription
hitIdstring

Hit ID

countnumber

New count

Returns:

Updated hit

Type: 
Promise.<Object>

update(hitId, name, count, MemberIds) → {Promise.<Object>}

Update a hit's details.

Parameters:
NameTypeDescription
hitIdstring

Hit ID

namestring

Name of the hit

countnumber

Count for the hit

MemberIdsArray

Array of member IDs

Returns:

Updated hit

Type: 
Promise.<Object>