onesignal-node-api icon indicating copy to clipboard operation
onesignal-node-api copied to clipboard

[Bug]: methods `api.beginLiveActivity` and `api.endLiveActivity` are missing, but documented

Open pepakriz opened this issue 1 year ago • 2 comments

What happened?

Based on readme.md these methods should be ready to use, but they are missing in the implementation.

Steps to reproduce?

yarn add @onesignal/node-onesignal

then

try to write the same code as in the readme:


...

// missing method
await api.beginLiveActivity('<app_id>', activityId, beginLiveActivityRequest);
// missing method
await api.endLiveActivity('<app_id>', '<activity_id>', subscriptionId);

What did you expect to happen?

I expect these methods to be available.

Relevant log output

No response

Code of Conduct

  • [X] I agree to follow this project's Code of Conduct

pepakriz avatar Dec 06 '24 08:12 pepakriz

Hi @pepakriz,

Thank you for bringing this to our attention. I need to investigate a bit further but so far this is what I've gathered:

  • The beginLiveActivity and endLiveActivity endpoints were meant to be used in SDKs that ran on the users device, e.g. https://github.com/OneSignal/OneSignal-iOS-SDK, and as such did not make sense to support in this project
  • We are still missing an analog to start live activity, which will need to be added to this project. I've made a note to add that in with the next batch of updates that we release.

In the meantime, please let me know if you have any questions.

sherwinski avatar Dec 11 '24 21:12 sherwinski

Hi @sherwinski .

This endpoint https://documentation.onesignal.com/reference/start-live-activity is exactly what I'm missing in the SDK. It'd be great to have it in the next SDK release.

Thank you.

pepakriz avatar Dec 12 '24 07:12 pepakriz

Hey @pepakriz,

We've just added support for the Start Live Activity endpoint in https://github.com/OneSignal/onesignal-node-api/releases/tag/5.3.0-beta1. Please give it a try and let us know if you run into any issues -- thanks!

sherwinski avatar Oct 02 '25 21:10 sherwinski