1.0.1 • Published 5 years ago

dadapush-client v1.0.1

Weekly downloads
1
License
Apache-2.0
Repository
-
Last release
5 years ago

dadapush-client

DadapushClient - JavaScript client for dadapush-client

DaDaPush: Real-time Notifications App

Send real-time notifications through our API without coding and maintaining your own app for iOS or Android devices.

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: v1
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://www.dadapush.com

Installation

For Node.js

npm

Install it via:

npm install dadapush-client --save

Finaly, you need to build the module:

npm run build
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your dadapush-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finaly, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/dadapush/dadapush-javascript-client then install it via:

    npm install dadapush/dadapush-javascript-client --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var DadapushClient = require('dadapush-client');


var api = new DadapushClient.DaDaPushMessageApi()
var body = new DadapushClient.MessagePushRequest(); // {MessagePushRequest} body
var channelToken = "channelToken_example" // {String} see: https://www.dadapush.com/channel/list
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createMessage(body, channelToken, callback);

Documentation for API Endpoints

All URIs are relative to https://www.dadapush.com

ClassMethodHTTP requestDescription
DadapushClient.DaDaPushMessageApicreateMessagePOST /api/v1/messagepush Message to a Channel
DadapushClient.DaDaPushMessageApideleteMessageDELETE /api/v1/message/{messageId}delete a Channel Message
DadapushClient.DaDaPushMessageApigetMessageGET /api/v1/message/{messageId}get a Channel Message
DadapushClient.DaDaPushMessageApigetMessagesGET /api/v1/messagesget Message List

Documentation for Models