node-red-contrib-line-notify-api v1.0.0

node-red-contrib-line-notify-api

This is a Node-RED node for using "LINE Notify API". the NODE-RED node supports sending "message", "stamp" and "image".

Pre-requisites

The node-red-contrib-line-notify-api requires Node-RED 1.00 to be installed.

Install

This node-red-contrib-line-notify-api is implemented according to the line notify specification.

npm install node-red-contrib-line-notify-api

Usage

• Properties

  

  • Name

    Set the node name displayed in the flow.

  • Token

    Please set the token issued by Line Developers.

    See the LINE Notify API Document for more details.

    LINE Notify API Document

  • sticker

    Set this setting to "If you want to add a stamp to the message".

    List of available stickers

• Inputs

  1) message *required

    The line notification message is passed by msg.payload or msg.message.
  
    ```javascript
    msg.payload = "line notification message.";
    ```
  
    or
  
    ```javascript
    msg.message = "line notification message."; /* This `msg.message` is given priority. */
    ```

  2) sticker *optional

    This `sticker` can send additional stamp messages.
  
    The feature is enabled by setting values for `msg.stickerPackageId` and `msg.stickerId`.
  
    [List of available stickers](https://developers.line.biz/en/docs/messaging-api/sticker-list/)
  
    ```javascript
    msg.stickerPackageId = 446; /* Package ID: set numerical value. */
    msg.stickerId = 1990;       /* Sticker ID: set numerical value. */
    ```

  3) image *optional

    This "image" can create a base64 image.
  
    This feature is enabled by setting values for "msg.imageBase64String" and "msg.imageFileName".
  
    ```javascript
    msg.imageBase64String = "/9j/4AAQSkZJRgAB..."; /* image of base64: it should start with "/9j/4AAQSkZJRgAB..." instead of "data:image/jpg;base64," */
    msg.imageFileName = "imageFileName.jpg"        /* image file name: it should include file name and extension, like "imageFileName.jpg" instead of "imageFileName" */
    ```

• Outputs

  The processing result is passed by msg.payload. It consists of an object that contains the following properties:

  export interface AxiosResponse<T = any>  {
      data: T;
      status: number;
      statusText: string;
      headers: any;
      config: AxiosRequestConfig;
      request?: any;
  }

  msg.payload : Object

  {"status":200,"message":"ok"}

npm-scripts

There are some npm-scripts to help developments.

• npm install - Install the testing environment in your project.
• npm run build - Make ./data/my-node directory from the src directory and Install the my-node in Node-RED.
• npm run start - Start Node-RED. "http://localhost:1880"

file list

[root]
│  package.json
│  README.md
│  tsconfig.json
│
├─data -> `Node-Red work files`
│  │  
│  ├─my-node -> `project files` The resource files and built files should be placed here.
│  │  │  package.json
│  │  │
│  │  └─nodes -> The resource files and built files should be placed here.
│  │     └─...
│  │
│  └─node_modules
│     └─...
│
├─dist -> `The project built files`
├─examples -> `node-RED flow files`
├─figs
├─nodes -> `The project built files`
└─src
    └─nodes -> project files
        ├─icons
        ├─lib
        ├─locales
        │  ├─en-US
        │  └─ja
        └─test