Home Reference Source Repository 
import BoxcarNotification from 'boxcar-notification/src/boxcar-notification.js'
public class | source

BoxcarNotification

Static Member Summary

Static Public Members
public static get
public static get

Constructor Summary

Public Constructor
public

constructor(userCredentials: string)

Member Summary

Public Members
public

Method Summary

Public Methods
public

send notification request.

Static Public Members

public static get API_URL: string source

Properties:

NameTypeAttributeDescription
API_URL string

API endpoint url

public static get VALID_SOUNDS: * source

Properties:

NameTypeAttributeDescription
VALID_SOUNDS string[]

selectable sounds list

Public Constructors

public constructor(userCredentials: string) source

Params:

NameTypeAttributeDescription
userCredentials string

your boxcar's API token

Public Members

public userCredentials: * source

Public Methods

public send(options: object): Promise<string, string> source

send notification request.

Params:

NameTypeAttributeDescription
options object

notification options
options.title string

[required] notification title
options.longMessage string

[required] notification message body
options.sound string

notification sound
options.sourceName string

notification source
options.iconUrl string

notification icon url

Return:

Promise<string, string>

response body or error message