Class KioskSession

Hierarchy

KioskSession

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new KioskSession(__namedParameters: { accessToken: string }, connection: MetricsConnection): KioskSession

- Defined in src/session.ts:384
Parameters
- __namedParameters: { accessToken: string }
  - accessToken: string
- connection: MetricsConnection
Returns KioskSession

Accessors

facilityId

get facilityId(): number

- Defined in src/session.ts:397
Returns number

kioskToken

get kioskToken(): string

- Defined in src/session.ts:393
Returns string

sessionHandler

get sessionHandler(): KioskSessionHandler

- Defined in src/session.ts:389
Returns KioskSessionHandler

Methods

close

close(): void

- Defined in src/session.ts:401
Returns void

fingerprintLogin

fingerprintLogin(params: { facilityRelationshipId: number; hash: string }): Promise<FacilityUserSession>

- Defined in src/session.ts:418
Parameters
- params: { facilityRelationshipId: number; hash: string }
  - facilityRelationshipId: number
  - hash: string
Returns Promise<FacilityUserSession>

getAccessControl

getAccessControl(): Promise<FacilityAccessControl>

- Defined in src/session.ts:438
Returns Promise<FacilityAccessControl>

getConfiguration

getConfiguration(): Promise<FacilityConfiguration>

- Defined in src/session.ts:443
Returns Promise<FacilityConfiguration>

getFacility

getFacility(): Promise<Facility<KioskSessionHandler>>

- Defined in src/session.ts:433
Returns Promise<Facility<KioskSessionHandler>>

getMemberRelationship

getMemberRelationship(params: { id: number }): Promise<FacilityUserMemberRelationship>

- Defined in src/session.ts:458
Parameters
- params: { id: number }
  - id: number
Returns Promise<FacilityUserMemberRelationship>

getMemberRelationships

getMemberRelationships(options?: { ascending?: boolean; includeSession?: boolean; limit?: number; memberIdentifier?: string; name?: string; offset?: number; sort?: FacilityUserRelationshipSorting }): Promise<FacilityUserMemberRelationships>

- Defined in src/session.ts:463
Parameters
- options: { ascending?: boolean; includeSession?: boolean; limit?: number; memberIdentifier?: string; name?: string; offset?: number; sort?: FacilityUserRelationshipSorting } = {}
  - Optional ascending?: boolean
  - Optional includeSession?: boolean
  - Optional limit?: number
  - Optional memberIdentifier?: string
  - Optional name?: string
  - Optional offset?: number
  - Optional sort?: FacilityUserRelationshipSorting
Returns Promise<FacilityUserMemberRelationships>

getRelationship

getRelationship(params: { id: number }): Promise<FacilityUserRelationship>

- Defined in src/session.ts:448
Parameters
- params: { id: number }
  - id: number
Returns Promise<FacilityUserRelationship>

getRelationships

getRelationships(options?: { ascending?: boolean; employee?: boolean; includeSession?: boolean; limit?: number; member?: boolean; memberIdentifier?: string; name?: string; offset?: number; sort?: FacilityUserRelationshipSorting }): Promise<FacilityUserRelationships>

- Defined in src/session.ts:453
Parameters
- options: { ascending?: boolean; employee?: boolean; includeSession?: boolean; limit?: number; member?: boolean; memberIdentifier?: string; name?: string; offset?: number; sort?: FacilityUserRelationshipSorting } = {}
  - Optional ascending?: boolean
  - Optional employee?: boolean
  - Optional includeSession?: boolean
  - Optional limit?: number
  - Optional member?: boolean
  - Optional memberIdentifier?: string
  - Optional name?: string
  - Optional offset?: number
  - Optional sort?: FacilityUserRelationshipSorting
Returns Promise<FacilityUserRelationships>

logout

logout(): Promise<void>

- Defined in src/session.ts:405
Returns Promise<void>

sessionEnd

sessionEnd(params: { echipData: object; echipId: string }): Promise<Session>

- Defined in src/session.ts:428
Parameters
- params: { echipData: object; echipId: string }
  - echipData: object
  - echipId: string
Returns Promise<Session>

sessionUpdate

sessionUpdate(params: { echipData: object; echipId: string }): Promise<Session>

- Defined in src/session.ts:423
Parameters
- params: { echipData: object; echipId: string }
  - echipData: object
  - echipId: string
Returns Promise<Session>

userLogin

userLogin(params: { primaryIdentification: string | number; secondaryIdentification?: string | number }): Promise<FacilityUserSession>

- Defined in src/session.ts:413
Parameters
- params: { primaryIdentification: string | number; secondaryIdentification?: string | number }
  - primaryIdentification: string | number
  - Optional secondaryIdentification?: string | number
Returns Promise<FacilityUserSession>