arlas-web-core / Exports / Contributor

Class: Contributor

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

• new Contributor(identifier, configService, collaborativeSearcheService, collection?)

Parameters

Name Type Description
identifier string identifier of the contributor.
configService ConfigService configService of the contributor.
collaborativeSearcheService CollaborativesearchService -
collection? string -

Defined in

models/contributor.ts:47

Properties

cacheDuration

• Protected cacheDuration: number

Defined in

models/contributor.ts:41

collaborativeSearcheService

• collaborativeSearcheService: CollaborativesearchService

Defined in

models/contributor.ts:49

collection

• collection: string

Defined in

models/contributor.ts:35

collections

• collections: CollectionAggField[]

Defined in

models/contributor.ts:36

configService

• configService: ConfigService

configService of the contributor.

Defined in

models/contributor.ts:48

endCollaborationEvent

• endCollaborationEvent: Subject<unknown>

Defined in

models/contributor.ts:37

identifier

• identifier: string

identifier of the contributor.

Defined in

models/contributor.ts:47

isDataUpdating

• isDataUpdating: boolean = false

Defined in

models/contributor.ts:34

linkedContributorId

• linkedContributorId: string

Defined in

models/contributor.ts:39

Accessors

updateData

• get updateData(): boolean

Returns

boolean

whether the data of contributor should be updated.

Defined in

models/contributor.ts:146

• set updateData(value): void

Parameters

Name Type Description
value boolean set if the data of contributor should be updated or not.

Returns

void

Defined in

models/contributor.ts:153

Methods

computeData

▸ Abstract computeData(data): any

Parameters

Name Type
data any

Returns

any

Defined in

models/contributor.ts:165

fetchData

▸ Abstract fetchData(collaborationEvent): Observable<any>

Parameters

Name Type
collaborationEvent CollaborationEvent

Returns

Observable<any>

Defined in

models/contributor.ts:163

getConfigValue

▸ getConfigValue(key): any

Parameters

Name Type Description
key string a key defined in configuration.

Returns

any

value of the key in configuration.

Defined in

models/contributor.ts:106

getFilterDisplayName

▸ Abstract getFilterDisplayName(): string

Returns

string

name and live informations about filter contributor.

Defined in

models/contributor.ts:161

getName

▸ getName(): string

Returns

string

name of contributor set in configuration.

Defined in

models/contributor.ts:132

getPackageName

▸ Abstract getPackageName(): string

Returns

string

package name of contributor used in configuration.

Defined in

models/contributor.ts:100

isMyLinkedContributorCollaboration

▸ isMyLinkedContributorCollaboration(collaborationEvent): boolean

Parameters

Name Type
collaborationEvent CollaborationEvent

Returns

boolean

Defined in

models/contributor.ts:123

isMyOwnCollaboration

▸ isMyOwnCollaboration(collaborationEvent): boolean

Parameters

Name Type
collaborationEvent CollaborationEvent

Returns

boolean

Defined in

models/contributor.ts:119

isUpdateEnabledOnOwnCollaboration

▸ Abstract isUpdateEnabledOnOwnCollaboration(): boolean

Returns

boolean

Defined in

models/contributor.ts:117

setData

▸ Abstract setData(data): any

Parameters

Name Type
data any

Returns

any

Defined in

models/contributor.ts:167

setName

▸ setName(name): void

Parameters

Name Type
name string

Returns

void

set the name of the contributor

Defined in

models/contributor.ts:139

setSelection

▸ Abstract setSelection(data, c): any

Parameters

Name Type
data any
c Collaboration

Returns

any

Defined in

models/contributor.ts:169

updateFromCollaboration

▸ updateFromCollaboration(collaborationEvent): void

Parameters

Name Type
collaborationEvent CollaborationEvent

Returns

void

Defined in

models/contributor.ts:171