Aurelia Deco Documentation - v2.0.9

Index

Namespaces

Classes

Interfaces

Type aliases

Steps

Variables

Functions

Type aliases

Steps

Steps: "login" | "double-auth" | "create-account" | "validate-account" | "account-created" | "forgot-password" | "reset-password"

Variables

Let addressArrayDecorator

addressArrayDecorator: TypeDecorator = ...

Let addressDecorator

addressDecorator: TypeDecorator = ...

Let initState

initState: { stateVersion: string } = ...

Type declaration

stateVersion: string

Functions

Let adDialogModel

adDialogModel(instance: Model, options: AdDialogOptions, properties?: string[] | "all"): ArDialog

- Defined in src/deco/components/form/ad-dialog-model.ts:60
Parameters
- instance: Model
- options: AdDialogOptions
- properties: string[] | "all" = ...
Returns ArDialog

Const address

address(optionsOrTarget?: any, key?: string, descriptor?: PropertyDescriptor): any

- Defined in src/decorators/address.ts:25
Parameters
- Optional optionsOrTarget: any
- Optional key: string
- Optional descriptor: PropertyDescriptor
Returns any

Const addressArray

addressArray(optionsOrTarget?: any, key?: string, descriptor?: PropertyDescriptor): any

- Defined in src/decorators/address.ts:53
Parameters
- Optional optionsOrTarget: any
- Optional key: string
- Optional descriptor: PropertyDescriptor
Returns any

authenticate

authenticate(state: AppState, user: SwissdataUser, accessToken?: string, profile?: ProfileModel): AppState

- Defined in src/state/actions.ts:62
Parameters
- state: AppState
- user: SwissdataUser
- Optional accessToken: string
- Optional profile: ProfileModel
Returns AppState

clearDecoState

clearDecoState(state: DecoAppState): DecoAppState

- Defined in src/deco/state/actions.ts:7
Parameters
- state: DecoAppState
Returns DecoAppState

clearProfile

clearProfile(state: AppState): AppState

- Defined in src/state/actions.ts:160
Parameters
- state: AppState
Returns AppState

clearSwissdataState

clearSwissdataState(state: AppState): AppState

- Defined in src/state/actions.ts:10
Parameters
- state: AppState
Returns AppState

cloneDeco

cloneDeco(originalDeco: Deco): Deco

- Defined in src/deco/interfaces/deco.ts:26
Parameters
- originalDeco: Deco
Returns Deco

configure

configure(config: FrameworkConfiguration, pluginConfig?: AureliaSwissdataConfig): void

- Defined in src/index.ts:25
Parameters
- config: FrameworkConfiguration
- Optional pluginConfig: AureliaSwissdataConfig
Returns void

errorHandler

errorHandler(handlerId?: string, options?: ErrorHandlerOptions): (error: Error) => void

- Defined in src/components/notification/swissdata-notification.ts:103
Parameters
- handlerId: string = 'main'
- Optional options: ErrorHandlerOptions
Returns (error: Error) => void
- - (error: Error): void
  - Parameters
    - error: Error
    Returns void

getI18NSetupOptions

getI18NSetupOptions(): i18NSetupOptions

- Defined in src/helpers/i18n-setup.ts:25
Returns i18NSetupOptions

Let i18nSetup

i18nSetup(options: i18NSetupOptions): (instance: I18N) => Promise<any>

- Defined in src/helpers/i18n-setup.ts:29
Parameters
- options: i18NSetupOptions
Returns (instance: I18N) => Promise<any>
- - (instance: I18N): Promise<any>
  - Parameters
    - instance: I18N
    Returns Promise<any>

initDecoState

initDecoState(state: DecoAppState): DecoAppState

- Defined in src/deco/state/actions.ts:17
Parameters
- state: DecoAppState
Returns DecoAppState

initSwissdataState

initSwissdataState(state: AppState): AppState

- Defined in src/state/actions.ts:23
Parameters
- state: AppState
Returns AppState

Let inputAddress

inputAddress(value: any): any

- Defined in src/decorators/address.ts:5
Parameters
- value: any
Returns any

Let inputAddressArray

inputAddressArray(value: any): any

- Defined in src/decorators/address.ts:27
Parameters
- value: any
Returns any

isSameAddress

isSameAddress(a: Address, b: Address): boolean

- Defined in src/decorators/address.ts:63
Parameters
- a: Address
- b: Address
Returns boolean

jsonify

jsonify(response: Response): Promise<any>

- Defined in src/deco/helpers/deco-api.ts:177
Parameters
- response: Response
Returns Promise<any>

logout

logout(state: AppState): AppState

- Defined in src/state/actions.ts:83
Parameters
- state: AppState
Returns AppState

Const model

model(baseroute: string, options?: ModelOptions): (target: any) => void

- Defined in src/deco/decorators/model.ts:65
Parameters
- baseroute: string
- options: ModelOptions = ...
Returns (target: any) => void
- - (target: any): void
  - Parameters
    - target: any
    Returns void

notifier

notifier(handlerId?: string, options?: ErrorHandlerOptions): (title: string, message: string, type?: "confirmation" | "info" | "error" | "warning") => void

- Defined in src/components/notification/swissdata-notification.ts:85
Parameters
- handlerId: string = 'main'
- Optional options: ErrorHandlerOptions
Returns (title: string, message: string, type?: "confirmation" | "info" | "error" | "warning") => void
- - (title: string, message: string, type?: "confirmation" | "info" | "error" | "warning"): void
  - Parameters
    - title: string
    - message: string
    - type: "confirmation" | "info" | "error" | "warning" = 'info'
    Returns void

setAccessToken

setAccessToken(state: AppState, accessToken: string): AppState

- Defined in src/state/actions.ts:48
Parameters
- state: AppState
- accessToken: string
Returns AppState

setApiHost

setApiHost(state: AppState, host: string): AppState

- Defined in src/state/actions.ts:36
Parameters
- state: AppState
- host: string
Returns AppState

setAppModels

setAppModels(state: AppState, prop: string, models: DynamicDataModel[]): AppState

- Defined in src/state/actions.ts:123
Parameters
- state: AppState
- prop: string
- models: DynamicDataModel[]
Returns AppState

setCountries

setCountries(state: DecoAppState, countries: string[] | null): DecoAppState

- Defined in src/deco/state/actions.ts:78
Parameters
- state: DecoAppState
- countries: string[] | null
Returns DecoAppState

setCountry

setCountry(state: DecoAppState, countryCode: undefined | string): DecoAppState

- Defined in src/deco/state/actions.ts:74
Parameters
- state: DecoAppState
- countryCode: undefined | string
Returns DecoAppState

setCountryCode

setCountryCode(state: DecoAppState, countryCode: undefined | string): DecoAppState

- Defined in src/deco/state/actions.ts:63
Parameters
- state: DecoAppState
- countryCode: undefined | string
Returns DecoAppState

setCurrentRoute

setCurrentRoute(state: AppState, instruction: NavigationInstruction): AppState

- Defined in src/state/actions.ts:135
Parameters
- state: AppState
- instruction: NavigationInstruction
Returns AppState

setDoubleAuthValidationToken

setDoubleAuthValidationToken(state: AppState, token: string): AppState

- Defined in src/state/actions.ts:55
Parameters
- state: AppState
- token: string
Returns AppState

setLanguage

setLanguage(state: DecoAppState, language: string | null): DecoAppState

- Defined in src/deco/state/actions.ts:43
Parameters
- state: DecoAppState
- language: string | null
Returns DecoAppState

setLanguages

setLanguages(state: DecoAppState, languages: string[] | null): DecoAppState

- Defined in src/deco/state/actions.ts:33
Parameters
- state: DecoAppState
- languages: string[] | null
Returns DecoAppState

setLoginStep

setLoginStep(state: AppState, step: Steps): AppState

- Defined in src/state/actions.ts:95
Parameters
- state: AppState
- step: Steps
Returns AppState

setOnline

setOnline(state: AppState, online: "unkown" | boolean): AppState

- Defined in src/state/actions.ts:148
Parameters
- state: AppState
- online: "unkown" | boolean
Returns AppState

setProfile

setProfile(state: AppState, profile: ProfileModel): AppState

- Defined in src/state/actions.ts:154
Parameters
- state: AppState
- profile: ProfileModel
Returns AppState

setRefLanguage

setRefLanguage(state: DecoAppState, language: string | null): DecoAppState

- Defined in src/deco/state/actions.ts:53
Parameters
- state: DecoAppState
- language: string | null
Returns DecoAppState

setState

setState(state: AppState, swissDataState: SwissdataState): AppState

- Defined in src/state/actions.ts:42
Parameters
- state: AppState
- swissDataState: SwissdataState
Returns AppState

setStateVersion

setStateVersion(state: DecoAppState, stateVersion: string): DecoAppState

- Defined in src/deco/state/actions.ts:27
Parameters
- state: DecoAppState
- stateVersion: string
Returns DecoAppState

setSwissdataStateProps

setSwissdataStateProps(state: AppState, keyValues: StringAnyMap): AppState

- Defined in src/state/actions.ts:101
Parameters
- state: AppState
- keyValues: StringAnyMap
Returns AppState

Const uniqueByApp

uniqueByApp<T>(target: T, key: keyof T, descriptor?: PropertyDescriptor): any

- Defined in src/decorators/validate.ts:5
Type parameters
- T
Parameters
- target: T
- key: keyof T
- Optional descriptor: PropertyDescriptor
Returns any

updateUser

updateUser(state: AppState, user: UserModel, properties: string[] | string): AppState

- Defined in src/components/form/swissdata-user-field.ts:230
Parameters
- state: AppState
- user: UserModel
- properties: string[] | string
Returns AppState

Let validateAddress

validateAddress(value: any, options?: any): boolean

- Defined in src/decorators/address.ts:11
Parameters
- value: any
- Optional options: any
Returns boolean

Let validateAddressArray

validateAddressArray(value: any, options?: any): boolean

- Defined in src/decorators/address.ts:34
Parameters
- value: any
- Optional options: any
Returns boolean

waitForDoubleAuth

waitForDoubleAuth(state: AppState, doubleAuthValidationToken: string): AppState

- Defined in src/state/actions.ts:73
Parameters
- state: AppState
- doubleAuthValidationToken: string
Returns AppState

Generated using TypeDoc