Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MainStore

Hierarchy

  • MainStore

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new MainStore(jmixREST: JmixRestConnection): MainStore

Properties

authenticated

authenticated: boolean = false

Whether the user authenticated.

Private Optional disposeTokenExpiryListener

disposeTokenExpiryListener: () => {}

Type declaration

    • (): {}

    • Returns {}

enums

enums: null | IObservableArray<EnumInfo> = null

Localized enums.

Private enumsRequestCount

enumsRequestCount: number = 0

initialized

initialized: boolean = false

Whether the MainStore instance is initialized.

locale

locale: null | string = null

Currently selected locale.

messages

messages: null | EntityMessages = null

Localized entity messages.

Private messagesRequestCount

messagesRequestCount: number = 0

metadata

metadata: null | IObservableArray<MetaClassInfo> = null

Information about project entities.

Private metadataRequestCount

metadataRequestCount: number = 0

security

security: Security

userName

userName: null | string = null

usingAnonymously

usingAnonymously: boolean = false

Whether the user is anonymous.

Static NAME

NAME: string = 'mainStore'

Accessors

loginRequired

  • get loginRequired(): boolean

Methods

Private handleLocaleChange

  • handleLocaleChange(locale: string): void

initialize

  • initialize(): Promise<void>

  • Initializes this MainStore instance.

    Returns Promise<void>

    a promise that resolves when initialization is complete.

isEntityDataLoaded

  • isEntityDataLoaded(): boolean

  • true means that MainStore is in a state when entity data can be displayed (i.e. entity metadata, localized entity messages, localized enums and permissions information has been loaded).

    Returns boolean

loadEnums

  • loadEnums(): void

loadMessages

  • loadMessages(): void

loadMetadata

  • loadMetadata(): void

login

  • login(login: string, password: string): Promise<void>

logout

  • logout(): Promise<void>

setLocale

  • setLocale(locale: string): void

  • Changes the active locale for this frontend client application.

    Parameters

    • locale: string

      locale to be set as active.

    Returns void

Private setSessionLocale

  • setSessionLocale(): void

Generated using TypeDoc