import Notification from 'clinical6/src/helpers/Notification.js'

public class | source

Notification

Mixin Extends:

NotificationModel, Helper

Helper class representing a user Notification.

Test:

Static Member Summary

Static Public Members
public static get	type: String

Constructor Summary

Public Constructor
public	constructor(json: Object) Constructor for helper class representing a Notification

Member Summary

Public Members
public	status: String

Private Members
private	_relationships: Object

Method Summary

Public Methods
public	async delete(): Promise<Notification> Deletes a notification
public	async read(): Promise<Notification> Sets the status of the current instance of Notification to read
public	async save(): Promise<Notification> Updates an existing notification (insert is not currently supported)

Inherited Summary

From class NotificationModel
public	action: String
public	actionObject: Object
public	archivedAt: String
public	channels: String
public	createdAt: String
public	id: Number
public	message: String
public	opts: Object
public	status: String
public	title: String
public	updatedAt: String

Static Public Members

public static get type: String source

Public Constructors

public constructor(json: Object) source

Constructor for helper class representing a Notification

Override:

NotificationModel#constructor

Params:

Name	Type	Attribute	Description
json	Object		json api response from server

Public Members

public status: String source

Override:

NotificationModel#status

Private Members

private _relationships: Object source

Public Methods

public async delete(): Promise<Notification> source

Deletes a notification

Return:

Promise<Notification>

Returns a promise via ajax call.

Example:

import { Notification, notificationService } from 'clinical6';

const notification = new Notification({...});

// Deletes notification
notification.delete();

public async read(): Promise<Notification> source

Sets the status of the current instance of Notification to read

Return:

Promise<Notification>

Returns a promise via ajax call.

Example:

import { Notification } from 'clinical6';

// Read notification from manually created notification
notification = new Notification({ id: '16' });
notification.read();

// Read notification from the list of notifications
notificationService.get().then(notifications => notifications[0].read());

public async save(): Promise<Notification> source

Updates an existing notification (insert is not currently supported)

Return:

Promise<Notification>

Returns a promise via ajax call.

Example:

import { Notification, notificationService } from 'clinical6';

const notification = new Notification({ id: 16, ...});

// Updates notification
notification.save();