arlas-wui-toolkit > "src/app/services/startup/startup.service" > ArlasStartupService
Class: ArlasStartupService
Hierarchy
ArlasStartupService
Index
Constructors
Properties
- analytics
- arlasExploreApi
- arlasIsUp
- collectionId
- collectionsMap
- configurationUpdaterService
- contributorRegistry
- emptyMode
- errorStartUpServiceBus
- selectorById
- shouldRunApp
- temporalContributor
Methods
- applyAppSettings
- applyFGA
- authenticate
- buildContributor
- enrichHeaders
- errorStartUp
- getAppConfigurationObject
- getCollections
- getFGAService
- listAvailableFields
- load
- loadExtraConfig
- setCollaborativeService
- setConfigService
- testArlasUp
- translationLoaded
- updateConfiguration
- validateConfiguration
- validateSettings
Constructors
constructor
⊕ new ArlasStartupService(settingsService: ArlasSettingsService, configService: ArlasConfigService, collaborativesearchService: ArlasCollaborativesearchService, injector: Injector
, fetchOptions: any
, http: HttpClient
, translateService: TranslateService
, configUpdater: any
, persistenceService: PersistenceService, errorService: ErrorService, fetchInterceptorService: FetchInterceptorService): ArlasStartupService
Defined in src/app/services/startup/startup.service.ts:119
Parameters:
Name | Type |
---|---|
settingsService | ArlasSettingsService |
configService | ArlasConfigService |
collaborativesearchService | ArlasCollaborativesearchService |
injector | Injector |
fetchOptions | any |
http | HttpClient |
translateService | TranslateService |
configUpdater | any |
persistenceService | PersistenceService |
errorService | ErrorService |
fetchInterceptorService | FetchInterceptorService |
Returns: ArlasStartupService
Properties
analytics
● analytics: Array
<object
>
Defined in src/app/services/startup/startup.service.ts:110
arlasExploreApi
● arlasExploreApi: ArlasExploreApi
Defined in src/app/services/startup/startup.service.ts:118
arlasIsUp
● arlasIsUp: Subject
<boolean
> = new Subject
Defined in src/app/services/startup/startup.service.ts:117
collectionId
● collectionId: string
Defined in src/app/services/startup/startup.service.ts:112
collectionsMap
● collectionsMap: Map
<string
, CollectionReferenceParameters
> = new Map()
Defined in src/app/services/startup/startup.service.ts:111
configurationUpdaterService
● configurationUpdaterService: ArlasConfigurationUpdaterService
Defined in src/app/services/startup/startup.service.ts:119
contributorRegistry
● contributorRegistry: Map
<string
, any
> = new Map
Defined in src/app/services/startup/startup.service.ts:107
emptyMode
● emptyMode: boolean
= false
Defined in src/app/services/startup/startup.service.ts:109
errorStartUpServiceBus
● errorStartUpServiceBus: Subject
<any
> = new Subject
Defined in src/app/services/startup/startup.service.ts:116
selectorById
● selectorById: string
Defined in src/app/services/startup/startup.service.ts:113
shouldRunApp
● shouldRunApp: boolean
= true
Defined in src/app/services/startup/startup.service.ts:108
temporalContributor
● temporalContributor: Array
<string
> = new Array
Defined in src/app/services/startup/startup.service.ts:114
Methods
applyAppSettings
▸ applyAppSettings(): Promise
<ArlasSettings>
Defined in src/app/services/startup/startup.service.ts:302
Returns: Promise
<ArlasSettings>
ARLAS settings object Promise
applyFGA
▸ applyFGA(data: any
): Promise
<any
>
Defined in src/app/services/startup/startup.service.ts:272
Parameters:
Name | Type | Description |
---|---|---|
data | any |
configuration object |
Returns: Promise
<any
>
authenticate
▸ authenticate(settings: ArlasSettings): Promise
<ArlasSettings>
Defined in src/app/services/startup/startup.service.ts:344
Parameters:
Name | Type | Description |
---|---|---|
settings | ArlasSettings | ArlasSettings object |
Returns: Promise
<ArlasSettings>
buildContributor
▸ buildContributor(data: any
): Promise
<any
>
Defined in src/app/services/startup/startup.service.ts:562
Parameters:
Name | Type |
---|---|
data | any |
Returns: Promise
<any
>
enrichHeaders
▸ enrichHeaders(settings: ArlasSettings): Promise
<ArlasSettings>
Defined in src/app/services/startup/startup.service.ts:378
Parameters:
Name | Type | Description |
---|---|---|
settings | ArlasSettings |
Returns: Promise
<ArlasSettings>
errorStartUp
▸ errorStartUp(): void
Defined in src/app/services/startup/startup.service.ts:138
Returns: void
getAppConfigurationObject
▸ getAppConfigurationObject(settings: ArlasSettings): Promise
<any
>
Defined in src/app/services/startup/startup.service.ts:422
Parameters:
Name | Type | Description |
---|---|---|
settings | ArlasSettings | Arlas Settings object |
Returns: Promise
<any
>
ARLAS Configuration object Promise
getCollections
▸ getCollections(data: any
): Promise
<any
>
Defined in src/app/services/startup/startup.service.ts:514
Parameters:
Name | Type |
---|---|
data | any |
Returns: Promise
<any
>
getFGAService
▸ getFGAService(): ArlasConfigurationUpdaterService
Defined in src/app/services/startup/startup.service.ts:134
Returns: ArlasConfigurationUpdaterService
listAvailableFields
▸ listAvailableFields(collectionNames: Set
<string
>): Promise
<Set
<string
>>
Defined in src/app/services/startup/startup.service.ts:538
Parameters:
Name | Type |
---|---|
collectionNames | Set <string > |
Returns: Promise
<Set
<string
>>
available fields
load
▸ load(): Promise
<any
>
Defined in src/app/services/startup/startup.service.ts:638
Returns: Promise
<any
>
loadExtraConfig
▸ loadExtraConfig(extraConfig: ExtraConfig, data: Object
): Promise
<any
>
Defined in src/app/services/startup/startup.service.ts:619
Parameters:
Name | Type | Description |
---|---|---|
extraConfig | ExtraConfig | This object specifies the path to the extra configuration file, the attribute to change in the main configuration file, and the attribute to take from the extra configuration file. |
data | Object |
Content of the extra configuration file |
Returns: Promise
<any
>
setCollaborativeService
▸ setCollaborativeService(data: any
): Promise
<any
>
Defined in src/app/services/startup/startup.service.ts:483
Parameters:
Name | Type |
---|---|
data | any |
Returns: Promise
<any
>
setConfigService
▸ setConfigService(data: any
): any
Defined in src/app/services/startup/startup.service.ts:229
Parameters:
Name | Type | Description |
---|---|---|
data | any |
configation object |
Returns: any
the same configuration object
testArlasUp
▸ testArlasUp(configData: any
): Promise
<any
>
Defined in src/app/services/startup/startup.service.ts:496
Parameters:
Name | Type |
---|---|
configData | any |
Returns: Promise
<any
>
translationLoaded
▸ translationLoaded(data: any
): Promise
<any
>
Defined in src/app/services/startup/startup.service.ts:198
Parameters:
Name | Type |
---|---|
data | any |
Returns: Promise
<any
>
updateConfiguration
▸ updateConfiguration(data: any
, availableFields: Set
<string
>): any
Defined in src/app/services/startup/startup.service.ts:254
Parameters:
Name | Type | Description |
---|---|---|
data | any |
configuration object |
availableFields | Set <string > |
list of fields that are available for exploration |
Returns: any
the updated configuration object
validateConfiguration
▸ validateConfiguration(data: any
): Promise
<any
>
Defined in src/app/services/startup/startup.service.ts:163
Parameters:
Name | Type |
---|---|
data | any |
Returns: Promise
<any
>
validateSettings
▸ validateSettings(settings: any
): Promise
<any
>
Defined in src/app/services/startup/startup.service.ts:143
Parameters:
Name | Type |
---|---|
settings | any |
Returns: Promise
<any
>