File

projects/netgrif-components-core/src/lib/task-content/services/single-task-content.service.ts

Description

Provides an implementation of the TaskContentService abstract class that allows only a single call to the setter of the managed Task object.

If you want to use an unlimited number of calls use UnlimitedTaskContentService instead.

Extends

TaskContentService

Index

Constructor

constructor(_fieldConverterService: FieldConverterService, _snackBarService: SnackBarService, _translate: TranslateService, _logger: LoggerService, _injector: Injector)

Defined in projects/netgrif-components-core/src/lib/task-content/services/single-task-content.service.ts:24

Parameters :

Name	Type	Optional
_fieldConverterService	`FieldConverterService`	No
_snackBarService	`SnackBarService`	No
_translate	`TranslateService`	No
_logger	`LoggerService`	No
_injector	`Injector`	No

Methods

ngOnDestroy

ngOnDestroy()

Inherited from TaskContentService

Defined in TaskContentService:68

Completes the underling stream.

Returns : void

Public blockFields

blockFields(blockingState: boolean)

Inherited from TaskContentService

Defined in TaskContentService:196

Changes the blocking state of all fields in the managed Task.

Parameters :

Name	Type	Optional	Description
blockingState	`boolean`	No	whether the field should be blocked or not

Returns : void

Public expansionFinished

expansionFinished()

Inherited from TaskContentService

Defined in TaskContentService:124

Changes the state of the task content to not expanding.

Returns : void

Public expansionStarted

expansionStarted()

Inherited from TaskContentService

Defined in TaskContentService:117

Changes the state of the task content to expanding.

Returns : void

Protected findTaskRefId

findTaskRefId(taskId: string, fields: literal type)

Inherited from TaskContentService

Defined in TaskContentService:312

Parameters :

Name	Type	Optional
taskId	`string`	No
fields	`literal type`	No

Returns : DataField<any>

Public getInvalidTaskData

getInvalidTaskData()

Inherited from TaskContentService

Defined in TaskContentService:156

Finds invalid data of task

Returns : Array<DataField<any>>

array of invalid datafields

Protected getReferencedTaskId

getReferencedTaskId(changedField: string, chFields: ChangedFields)

Inherited from TaskContentService

Defined in TaskContentService:306

Parameters :

Name	Type	Optional
changedField	`string`	No
chFields	`ChangedFields`	No

Returns : string

Protected isFieldInTask

isFieldInTask(taskId: string, changedField: string)

Inherited from TaskContentService

Defined in TaskContentService:299

Parameters :

Name	Type	Optional
taskId	`string`	No
changedField	`string`	No

Returns : boolean

Protected updateField

updateField(chFields: ChangedFields, field: DataField<any>, frontendActions: Change, referenced: boolean)

Inherited from TaskContentService

Defined in TaskContentService:237

Parameters :

Name	Type	Optional	Default value
chFields	`ChangedFields`	No
field	`DataField<any>`	No
frontendActions	`Change`	No
referenced	`boolean`	No	`false`

Returns : void

Public updateFromChangedFields

updateFromChangedFields(chFields: ChangedFields)

Inherited from TaskContentService

Defined in TaskContentService:221

Updates the properties of fields in the managed task based on a delta of changes from previous state.

Parameters :

Name	Type	Optional	Description
chFields	`ChangedFields`	No	object containing the delta of the changes from the previous state

Returns : void

Public updateStateData

updateStateData(eventOutcome: TaskEventOutcome)

Inherited from TaskContentService

Defined in TaskContentService:209

Clears the assignee, start date and finish date from the managed Task.

Parameters :

Name	Type	Optional
eventOutcome	`TaskEventOutcome`	No

Returns : void

Public validateDynamicEnumField

validateDynamicEnumField()

Inherited from TaskContentService

Defined in TaskContentService:163

Returns : boolean

Public validateTaskData

validateTaskData(taskId?: string)

Inherited from TaskContentService

Defined in TaskContentService:135

Checks the validity of all data fields in the managed Task.

If some of the fields are invalid touches them so their validation errors will appear (if set). A snackbar will also be displayed to the user, informing them of the fact that the fields are invalid.

Parameters :

Name	Type	Optional
taskId	`string`	Yes

Returns : boolean

whether the task is valid or not

Properties

Protected _task$

Type : ReplaySubject<Task>

Defined in projects/netgrif-components-core/src/lib/task-content/services/single-task-content.service.ts:24

Acts as the underling stream for notifications on Task changes.

bufferSize of the ReplaySubject instance is set to 1.

Protected _isExpanding$

Type : BehaviorSubject<boolean>

Inherited from TaskContentService

Defined in TaskContentService:38

Protected _referencedTaskAndCaseIds

Type : literal type

Default value : {}

Inherited from TaskContentService

Defined in TaskContentService:42

Protected _task

Type : Task

Inherited from TaskContentService

Defined in TaskContentService:36

Protected _taskDataReloadRequest$

Type : Subject<Change>

Inherited from TaskContentService

Defined in TaskContentService:37

Protected _taskFieldsIndex

Type : literal type

Default value : {}

Inherited from TaskContentService

Defined in TaskContentService:39

$shouldCreate

Type : ReplaySubject<Array<DataGroup>>

Inherited from TaskContentService

Defined in TaskContentService:34

$shouldCreateCounter

Type : BehaviorSubject<number>

Inherited from TaskContentService

Defined in TaskContentService:35

Static Readonly ACTION

Type : string

Default value : 'action'

Inherited from TaskContentService

Defined in TaskContentService:32

Static Readonly FRONTEND_ACTIONS_KEY

Type : string

Default value : '_frontend_actions'

Inherited from TaskContentService

Defined in TaskContentService:31

Accessors

task

gettask()

Defined in projects/netgrif-components-core/src/lib/task-content/services/single-task-content.service.ts:38

Returns : Task | undefined

settask(task: Task)

Defined in projects/netgrif-components-core/src/lib/task-content/services/single-task-content.service.ts:46

The task can be only set once. All other call do nothing and log an error.

Parameters :

Name	Type	Optional	Description
task	`Task`	No	`the Task that owns the content managed by this service`

Returns : void

task$

gettask$()

Defined in projects/netgrif-components-core/src/lib/task-content/services/single-task-content.service.ts:61

Stream returns a single Task object and then completes.

Use task setter method to set the Task.

Returns : Observable<Task>

import {Injectable, Injector, OnDestroy} from '@angular/core';
import {TaskContentService} from './task-content.service';
import {FieldConverterService} from './field-converter.service';
import {SnackBarService} from '../../snack-bar/services/snack-bar.service';
import {TranslateService} from '@ngx-translate/core';
import {LoggerService} from '../../logger/services/logger.service';
import {Observable, ReplaySubject} from 'rxjs';
import {Task} from '../../resources/interface/task';

/**
 * Provides an implementation of the {@link TaskContentService} abstract class that allows only a
 * single call to the setter of the managed Task object.
 *
 * If you want to use an unlimited number of calls use {@link UnlimitedTaskContentService} instead.
 */
@Injectable()
export class SingleTaskContentService extends TaskContentService implements OnDestroy {

    /**
     * Acts as the underling stream for notifications on Task changes.
     *
     * `bufferSize` of the `ReplaySubject` instance is set to 1.
     */
    protected _task$: ReplaySubject<Task>;

    constructor(_fieldConverterService: FieldConverterService,
                _snackBarService: SnackBarService,
                _translate: TranslateService,
                _logger: LoggerService,
                _injector: Injector) {
        super(_fieldConverterService, _snackBarService, _translate, _logger);
        this._task$ = new ReplaySubject<Task>(1);
    }

    /**
     * @returns the Task object if set and `undefined` otherwise
     */
    get task(): Task | undefined {
        return this._task;
    }

    /**
     * The task can be only set once. All other call do nothing and log an error.
     * @param task the Task that owns the content managed by this service
     */
    set task(task: Task) {
        if (!this._task$.closed) {
            this._task = task;
            this._task$.next(task);
            this._task$.complete();
        } else {
            this._logger.error('TaskContentService can have it\'s task set only once');
        }
    }

    /**
     * Stream returns a single {@link Task} object and then completes.
     *
     * Use [task]{@link TaskContentService#task} setter method to set the Task.
     */
    get task$(): Observable<Task> {
        return this._task$.asObservable();
    }

    /**
     * Completes the underling stream.
     */
    ngOnDestroy(): void {
        super.ngOnDestroy();
        if (!this._task$.closed) {
            this._task$.complete();
        }
    }
}

File

Description

Extends

Index

Properties

Methods

Accessors

Constructor

Methods

Properties

Accessors

result-matching ""

No results matching ""