Class BootstrapService

Index

Constructors

Methods

constellationInit createCase factoryInit getCaseTypes init initScreen openAssignment openCase openPage

Constructors

constructor

new BootstrapService(): BootstrapService
Returns BootstrapService

Methods

`Static`constellationInit

constellationInit(
    serverUrl: string,
    deployUrl: string,
    token: TokenInfo,
    authConfig?: OAuth2Config,
    localeID?: string,
): Promise<Bootstrap>
Initializes the constellation environment by bootstrapping with the provided server URL and token.

This method performs the following steps:
1. Calls factoryInit to register container types.
2. Constructs a base URL using the current window location.
3. Configures the bootstrap process with a custom rendering option and authorization header.
4. Dynamically imports and initializes the bootstrap shell with the configuration.
5. Disables dynamic component loading behavior in PCore.
6. Registers a component creator with PCore for handling properties.
Parameters
- serverUrl: string
  The URL of the server to connect to.
- deployUrl: string
  Constellation core will be downloaded from this location When no value is provided, then the deploy URL is determined as the url on which the applicaiton is running.
- token: TokenInfo
  The token information containing authorization details.
- OptionalauthConfig: OAuth2Config
  The configuration used to retrieve the token.
- localeID: string = 'en-US'
  The locale to use for this application (default en-US)
Returns Promise<Bootstrap>
A promise that resolves to the initialized Bootstrap instance.

`Static`createCase

createCase(
    caseTypeID: string,
    context: string,
    startingFields: any,
    pageName?: string,
): Promise<void>
Parameters
- caseTypeID: string
- context: string
- startingFields: any
- pageName: string = 'pyEmbedAssignment'
Returns Promise<void>

`Static`factoryInit

factoryInit(): void
Returns void

`Static`getCaseTypes

getCaseTypes(serverUrl: string, token: TokenInfo): Promise<CaseTypes>
Parameters
- serverUrl: string
- token: TokenInfo
Returns Promise<CaseTypes>

`Static`init

init(config: BootConfig): Promise<PContainer<any>>
Parameters
- config: BootConfig
Returns Promise<PContainer<any>>

`Static`initScreen

initScreen(
    shell: Bootstrap,
    portal?: string,
    localeID?: string,
    appID?: string,
    headers?: { [key: string]: string },
): Promise<PConnect>
Parameters
- shell: Bootstrap
- Optionalportal: string
- OptionallocaleID: string
- OptionalappID: string
- headers: { [key: string]: string } = {}
Returns Promise<PConnect>

`Static`openAssignment

openAssignment(
    assignmentID: string,
    context: string,
    pageName?: string,
): Promise<void>
Parameters
- assignmentID: string
- context: string
- pageName: string = 'pyEmbedAssignment'
Returns Promise<void>

`Static`openCase

openCase(caseID: string, context: string, pageName?: string): Promise<void>
Parameters
- caseID: string
- context: string
- pageName: string = 'pyEmbedAssignment'
Returns Promise<void>

`Static`openPage

openPage(
    pageID: string,
    className: string,
    context: string,
    pageName?: string,
): Promise<void>
Parameters
- pageID: string
- className: string
- context: string
- pageName: string = 'pyEmbedAssignment'
Returns Promise<void>