alfresco-ng2-components/lib/core/services/notification.service.ts
Andy Stark dd1b8893cc [ADF-2905] Added JSDocs for core (#3281)
* [ADF-2905] Updated JSDocs for core

* [ADF-2905] Added missing JSDoc for user pref service
2018-05-08 15:30:23 +01:00

54 lines
2.0 KiB
TypeScript

/*!
* @license
* Copyright 2016 Alfresco Software, Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { Injectable } from '@angular/core';
import { MatSnackBar, MatSnackBarRef } from '@angular/material';
@Injectable()
export class NotificationService {
static DEFAULT_DURATION_MESSAGE: number = 5000;
constructor(public snackbar: MatSnackBar) {
}
/**
* Opens a snackbar notification to show a message.
* @param message The message to show
* @param millisecondsDuration Time before notification disappears after being shown
* @returns Information/control object for the snackbar
*/
public openSnackMessage(message: string, millisecondsDuration?: number): MatSnackBarRef<any> {
return this.snackbar.open(message, null, {
duration: millisecondsDuration || NotificationService.DEFAULT_DURATION_MESSAGE
});
}
/**
* Opens a snackbar notification with a message and a response button.
* @param message The message to show
* @param action Caption for the response button
* @param millisecondsDuration Time before the notification disappears (unless the button is clicked)
* @returns Information/control object for the snackbar
*/
public openSnackMessageAction(message: string, action: string, millisecondsDuration?: number): MatSnackBarRef<any> {
return this.snackbar.open(message, action, {
duration: millisecondsDuration || NotificationService.DEFAULT_DURATION_MESSAGE
});
}
}