English | 中文
Node.js sample code encapsulates APIs of the HUAWEI Push Kit server. It provides many sample programs for your reference or usage.
The following table describes packages of Node.js sample code.
|examples||Sample code packages. Each package can run independently to call an API.|
|utils||Tool package, which contains common network requests and common verification methods.|
|push||Package where APIs of the HUAWEI Push Kit server are encapsulated.|
Before using Node.js sample code, ensure that the node environment has been installed.
In the nodejs-sdk project directory:
$ npm install
Run the sample project:
$ npm run build
We support Node.js 8.13.0 and higher.
Please also note that the Sample Code should only be used in server-side/back-end environments controlled by the app developer. This includes most server and serverless platforms (both on-premise and in the cloud). It is not recommended to use the Sample Code in client-side environments.
Node.js sample code uses the index.ts file as the entry, creates a HcmNamespace object, calls a method in the object for initialization, enters a method module such as the message or topic method module, and then calls an API of the HUAWEI Push Kit server using a method in the module.
Before using functions provided by packages in examples, you need to set parameters for initialization in config.js.
|AppId||App ID, which is obtained from app information.|
|AppSecret||Secret access key of an app, which is obtained from app information.|
|AuthUrl||URL for the Huawei OAuth 2.0 service to obtain a token, please refer to Generating an App-Level Access Token.|
|PushUrl||URL for accessing HUAWEI Push Kit, please refer to Sending Messages.|
|TargetTopic||Name of a topic to be subscribed to, unsubscribed from, or queried.|
|TargetCondition||Combination of condition expressions for a message.|
|TargetToken||Token of a destination device.|
|TargetTokenArray||Tokens of destination devices.|
Download node.js sample code in Downloading Server Sample Code. node.js sample code uses index.ts as the entry. Call methods on object HcmNamespace: messaging and topic.
The following table lists methods in HcmNamespace.
|messaging||The entry of the Messaging object, and verify the initialization input parameters.|
|topic||The entry of the Topic object, and verify the initialization input parameters.|
The following table lists methods in Messaging.
|send||Verify if the token needs to be updated and call the method sendRequest.|
|sendRequest||Sends a message to a device.|
The following table lists methods in Topic.
|subScribeTopic||Subscribe to topic.|
|queryTopicList||Query subject list.|
Code location: examples/send_data_message.js
Code location: examples/send_notify_message.js
Code location: examples/send_topic_message.js
Code location: examples/send_condition_message.js
Code location: examples/send_instance_app_message.js
Code location: examples/send_webpush_message.js
Code location: examples/send_apns_message.js
Code location: examples/send_test_message.js
If you want to evaluate more about HMS Core, r/HMSCore on Reddit is for you to keep up with latest news about HMS Core, and to exchange insights with other developers.
If you have questions about how to use HMS samples, try the following options:
Pushkit Node.js sample is licensed under the Apache License, version 2.0.
：Code submit frequency
：React/respond to issue & PR etc.
：Well-balanced team members and collaboration
：Recent popularity of project
：Star counts, download counts etc.