@topoos/push

@topoos/Push - JavaScript client for push Servicio para el envío de notificaciones, utilizando Firebase Cloud Messaging. Firebase Cloud Messaging (FCM) es una solución multiplataforma que permite el envío de forma seguro de mensajes, sin coste. Puede enviar mensajes a aplicaciones cliente Android, iOS y Web This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install @topoos/push --save

Finally, 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 push from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --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 Push = require('@topoos/push');

var defaultClient = Push.ApiClient.instance;
// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN";

var api = new Push.NotificacionApi();
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
const registrationTokens = ["<reg_token>"];
const sendNotificationDevice = new Push.SendNotificationDeviceId(new Push.DeviceId(registrationTokens));
sendNotificationDevice.notification = {
    title: "notification title",
    body: "notification body",
};
sendNotificationDevice.data = {
    atr1: "value1"
};

api.sendNotification(sendNotificationDevice, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost:8077/ps/v1/providers/testing

Class	Method	HTTP request	Description
Push.NotificacionApi	sendNotification	POST /notification	Enviar notificación
Push.TopicApi	subscribeToTopic	POST /topic	Suscribir dispositivos a un topic
Push.TopicApi	unsubscribeFromTopic	DELETE /topic	Desuscribir dispositivos a un topic
Push.UsuarioApi	addDevicesToUser	POST /users/{userId}/devices	Añadir dispositivos asignados al usuario
Push.UsuarioApi	removeDevicesFromUser	DELETE /users/{userId}/devices	Quitar dispositivos asignados al usuario

Documentation for Models

• Push.AddDeviceToGroup
• Push.ConditionId
• Push.DeviceId
• Push.Error
• Push.ErrorError
• Push.ErrorErrorErrors
• Push.Notification
• Push.PostNotificationResult
• Push.PostNotificationResultData
• Push.PostNotificationResultDataItems
• Push.SendNotificationConditionId
• Push.SendNotificationDeviceId
• Push.SendNotificationOptions
• Push.SendNotificationTopicId
• Push.SendNotificationUserId
• Push.SubscribeToTopic
• Push.SubscribeToTopicResponse
• Push.SubscribeToTopicResponseData
• Push.SubscribeToTopicResponseDataFailures
• Push.SubscribeToTopicResponseDataItems
• Push.TopicId
• Push.UserId