Meteor-Community-Packages / Meteor-Community-Packages/raix-push
Query on Documentation - Internal server API
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 505
- Forks
- 191
- PR merge metrics
- No merged PRs in 30d
Description
I was referring the following link
https://github.com/raix/push/blob/master/docs/ADVANCED.md
There is a mention of the following internal sever api(s).
```
// Internal events
Push.addListener('token', function(currentToken, newToken) {
// Token is { apn: 'xxxx' } or { gcm: 'xxxx' } or null
// if newToken is null then the currentToken is invalid
// if newToken is set then this should replace the currentToken
});
// Direct access to the send functions
Push.sendAPN(userToken, options);
Push.sendGCM(userTokens, options)
```
Are the api internal to Raix: Push Do we require to invoke them ? If so can someone point me to a sample.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with docs/ADVANCED.md and review the documented Push.addListener, Push.sendAPN, and Push.sendGCM APIs. Determine whether these internal APIs are intended for package users and whether the documentation needs an example. Done means the documentation clearly answers that question and provides a sample if appropriate.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100