RICADO Gen 4 API JS Client

RICADO Gen 4 API JS Client

Class

FirebaseTokenController

Controller Class for Firebase Tokens

Constructor

new FirebaseTokenController()

Source

Methods

static

create(createData) → {Promise.<FirebaseTokenModel>}

Create a Firebase Token [POST /firebase-tokens]

Parameters

  • createData FirebaseTokenController.CreateData

    The Firebase Token Create Data

Returns

  • Promise.<FirebaseTokenModel>

Source

static

getAll(queryParametersopt) → {Promise.<Array.<FirebaseTokenModel>>}

List all Firebase Tokens [GET /firebase-tokens]

Parameters

  • queryParameters FirebaseTokenController.GetAllQueryParameters <optional>

    The Optional Query Parameters

Returns

  • Promise.<Array.<FirebaseTokenModel>>

Source

static

getOne(id) → {Promise.<FirebaseTokenModel>}

Retrieve a Firebase Token [GET /firebase-tokens/{id}]

Parameters

  • id string

    The Firebase Token ID

Returns

  • Promise.<FirebaseTokenModel>

Source

static

update(id, updateData) → {Promise.<FirebaseTokenModel>}

Update a Firebase Token [PATCH /firebase-tokens/{id}]

Parameters

  • id string

    The Firebase Token ID

  • updateData FirebaseTokenController.UpdateData

    The Firebase Token Update Data

Returns

  • Promise.<FirebaseTokenModel>

Source

Type Definitions

CreateData

The Create Data for a Firebase Token

Type

  • Object

Properties

  • accountId string <optional>

    The Account this Firebase Token belongs to

  • token string

    The Firebase Token

  • enabled boolean <optional>

    Whether the Firebase Token should receive Notifications

  • deviceName string <optional>

    The Device Name

  • devicePlatform string <optional>

    The Device Platform

Source

GetAllQueryParameters

The Optional Query Parameters for the getAll Function

Type

  • Object

Properties

  • accountId string <optional>

    The Account this Firebase Token belongs to

  • token string <optional>

    The Firebase Token

  • enabled boolean <optional>

    Whether the Firebase Token should receive Notifications

  • deviceName string <optional>

    The Device Name

  • devicePlatform string <optional>

    The Device Platform

Source

UpdateData

The Update Data for a Firebase Token

Type

  • Object

Properties

  • accountId string <optional>

    The Account this Firebase Token belongs to

  • enabled boolean <optional>

    Whether the Firebase Token should receive Notifications

  • deviceName string <optional>

    The Device Name

  • devicePlatform string <optional>

    The Device Platform

Source