Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NV-1618 - Add Missing APNS Docs #3018

Merged
merged 4 commits into from
Mar 15, 2023
Merged

NV-1618 - Add Missing APNS Docs #3018

merged 4 commits into from
Mar 15, 2023

Conversation

unicodeveloper
Copy link
Contributor

What change does this PR introduce?

This adds the docs to help activate and integrate apns. It also improves the firebase set up documentation.

Why was this change needed?

Docs is non-existent.

Other information (Screenshots)

Screenshot 2023-03-15 at 08 19 38
Screenshot 2023-03-15 at 08 19 55

@linear
Copy link

linear bot commented Mar 15, 2023

NV-1618 Missing APNS docs

We have APNs provider in Push Channel but its documentation page is missing
https://docs.novu.co/channels/push/apns

@unicodeveloper unicodeveloper requested review from jainpawan21 and p-fernandez and removed request for jainpawan21 March 15, 2023 08:21
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 15, 2023
Copy link
Contributor

@p-fernandez p-fernandez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🌟
Just 2 typos to rollback. Great adding this missing doc!

```ts
import { Novu } from '@novu/node';
import { Novu } from '@node';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
import { Novu } from '@node';
import { Novu } from '@novu/node';

Please rollback the change.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, will do

Before triggering the notification to a subscriber(user) with push as a step in the workflow, make sure you have added the subscriber's device token as follows:

```ts
import { Novu, PushProviderIdEnum } from '@novu/node';
import { Novu, PushProviderIdEnum } from '@node';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And here too. 🙂

Suggested change
import { Novu, PushProviderIdEnum } from '@node';
import { Novu, PushProviderIdEnum } from '@novu/node';

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for catching

'loc-key' : 'GAME_PLAY_REQUEST_FORMAT',
'loc-args' : [ 'Shelly', 'Rick']
},
sound: 'demo.wav'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is demo.wav an attachment or some static name?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a static name, it can be any thing


const novu = new Novu(process.env.NOVU_API_KEY);

const body = req.body; // From your HTTPS listener
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this line can be removed as body is not used in setCredentials

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh makes sense.

@unicodeveloper unicodeveloper added this pull request to the merge queue Mar 15, 2023
Merged via the queue into next with commit c86bc77 Mar 15, 2023
@unicodeveloper unicodeveloper deleted the improve-firebase-docs branch March 15, 2023 21:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants