mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-31 17:38:48 +00:00
Review doc 3.3.0 (#4851)
* fix documentation missing params * fix index * fix aftere release * fix aftere review
This commit is contained in:
@@ -48,7 +48,7 @@ export abstract class FormBaseComponent {
|
||||
@Input()
|
||||
disableCompleteButton: boolean = false;
|
||||
|
||||
/** If true then the `Save` outcome button is shown but it will be disabled. */
|
||||
/** If true then the `Save` outcome button is shown but will be disabled. */
|
||||
@Input()
|
||||
disableSaveButton: boolean = false;
|
||||
|
||||
|
@@ -108,7 +108,7 @@ export class NotificationService {
|
||||
/**
|
||||
* Rase error message
|
||||
* @param message Text message or translation key for the message.
|
||||
* @param action (optional) Action name
|
||||
* @param action Action name
|
||||
*/
|
||||
showError(message: string, action?: string): MatSnackBarRef<any> {
|
||||
return this.showMessage(message, 'adf-error-snackbar', action);
|
||||
@@ -117,7 +117,7 @@ export class NotificationService {
|
||||
/**
|
||||
* Rase info message
|
||||
* @param message Text message or translation key for the message.
|
||||
* @param action (optional) Action name
|
||||
* @param action Action name
|
||||
*/
|
||||
showInfo(message: string, action?: string): MatSnackBarRef<any> {
|
||||
return this.showMessage(message, 'adf-info-snackbar', action);
|
||||
@@ -126,7 +126,7 @@ export class NotificationService {
|
||||
/**
|
||||
* Rase warning message
|
||||
* @param message Text message or translation key for the message.
|
||||
* @param action (optional) Action name
|
||||
* @param action Action name
|
||||
*/
|
||||
showWarning(message: string, action?: string): MatSnackBarRef<any> {
|
||||
return this.showMessage(message, 'adf-warning-snackbar', action);
|
||||
|
@@ -167,7 +167,7 @@ export class ExtensionService {
|
||||
/**
|
||||
* Evaluates a rule.
|
||||
* @param ruleId ID of the rule to evaluate
|
||||
* @param context (optional) Custom rule execution context.
|
||||
* @param context Custom rule execution context.
|
||||
* @returns True if the rule passed, false otherwise
|
||||
*/
|
||||
evaluateRule(ruleId: string, context?: RuleContext): boolean {
|
||||
|
@@ -71,7 +71,7 @@ export class RuleService {
|
||||
/**
|
||||
* Evaluates a rule.
|
||||
* @param ruleId ID of the rule to evaluate
|
||||
* @param context (optional) Custom rule execution context.
|
||||
* @param context Custom rule execution context.
|
||||
* @returns True if the rule passed, false otherwise
|
||||
*/
|
||||
evaluateRule(ruleId: string, context?: RuleContext): boolean {
|
||||
|
@@ -120,7 +120,7 @@ export class FormCloudService extends BaseCloudService {
|
||||
* @param taskId ID of the target task
|
||||
* @param formId ID of the form to complete
|
||||
* @param formValues Form values object
|
||||
* @param outcome (Optional) Form outcome
|
||||
* @param outcome Form outcome
|
||||
* @returns Updated task details
|
||||
*/
|
||||
completeTaskForm(appName: string, taskId: string, processInstanceId: string, formId: string, formValues: FormValues, outcome: string): Observable<TaskDetailsCloudModel> {
|
||||
@@ -254,7 +254,7 @@ export class FormCloudService extends BaseCloudService {
|
||||
/**
|
||||
* Parses JSON data to create a corresponding form.
|
||||
* @param json JSON data to create the form
|
||||
* @param data (Optional) Values for the form's fields
|
||||
* @param data Values for the form's fields
|
||||
* @param readOnly Toggles whether or not the form should be read-only
|
||||
* @returns Form created from the JSON specification
|
||||
*/
|
||||
|
Reference in New Issue
Block a user