Class FLEXAdmins

A class that contains methods for interacting with the Amplify API

Hierarchy (View Summary)

Devices
- FLEXAdmins

Constructors

constructor

new FLEXAdmins(isDev?: boolean): FLEXAdmins
- Public Methods **
Parameters
- isDev: boolean = true
Returns FLEXAdmins
Inherited from Devices.constructor
- Defined in Model/Databases/DGAmplify.m.ts:104

Properties

`Protected`_ctx

_ctx: FLEXContextVariables

Member

ctx

`Protected`_error

_error: (message?: any) => void = alert

Protected Methods **

Type Declaration

- (message?: any): void
- window.alert() instructs the browser to display a dialog with an optional message, and to wait until the user dismisses the dialog.
  
  MDN Reference
  Parameters
  - Optionalmessage: any
  Returns void

`Protected`_errorFunction

_errorFunction: (errors: string[] | number[] | object[]) => void = console.error

Accessors

amplify

get amplify(): Client
Returns Client
Inherited from Devices.amplify
- Defined in Model/DGUtility.m.ts:84
set amplify(amplify: Client): void
Parameters
- amplify: Client
Returns void
Inherited from Devices.amplify
- Defined in Model/DGUtility.m.ts:72

ctx

get ctx(): FLEXContextVariables
Returns FLEXContextVariables
Inherited from Devices.ctx
- Defined in Model/DGUtility.m.ts:80
set ctx(ctx: FLEXContextVariables): void
Parameters
- ctx: FLEXContextVariables
Returns void
Inherited from Devices.ctx
- Defined in Model/DGUtility.m.ts:76

deviceLogs

get deviceLogs(): string[]
Returns string[]
Inherited from Devices.deviceLogs
- Defined in ViewModel/Devices.vm.ts:518
set deviceLogs(logs: string[]): void
Parameters
- logs: string[]
Returns void
Inherited from Devices.deviceLogs
- Defined in ViewModel/Devices.vm.ts:522

errorFunction

set errorFunction(error: (errors: string[] | number[] | object[]) => void): void
Parameters
- error: (errors: string[] | number[] | object[]) => void
Returns void
Inherited from Devices.errorFunction
- Defined in Model/DGUtility.m.ts:68

Methods

`Protected`_init

_init(): void
- Protected Methods **
Returns void
Inherited from Devices._init
- Defined in Model/DGUtility.m.ts:36

avg

avg(arr: number[]): number
Averages an array of numbers
Parameters
- arr: number[]
  an array of numbers to average
Returns number
the average of the elements in the array
Inherited from Devices.avg
- Defined in Model/DGUtility.m.ts:58

batchDeleteS3Files

batchDeleteS3Files(fileNames: string[]): Promise<any>
Delete many S3 files at once
Parameters
- fileNames: string[]
  the list of file names to delete
Returns Promise<any>
the list of the files which had errors, if any
Inherited from Devices.batchDeleteS3Files
- Defined in ViewModel/Devices.vm.ts:420

createID

createID(): string | number[]
Generate a random string of characters to be used as a unique id

Returns string | number[]
the result of the call to the uuid function
Inherited from Devices.createID
- Defined in Model/DGElement.m.ts:30

deleteDevice

deleteDevice(
    deviceID: number,
): Promise<
    {
        __typename: "Device";
        ID: number;
        ImageURL?: string;
        Name?: string;
        Password?: string;
        RadiusRA?: number;
        RadiusRB?: number;
        RadiusRC?: number;
        RadiusRD?: number;
        SerialNumber?: string;
        SpringConstant?: number;
    },
>
Delete a device from the database
Parameters
- deviceID: number
  the ID of the device to delete
Returns Promise<
    {
        __typename: "Device";
        ID: number;
        ImageURL?: string;
        Name?: string;
        Password?: string;
        RadiusRA?: number;
        RadiusRB?: number;
        RadiusRC?: number;
        RadiusRD?: number;
        SerialNumber?: string;
        SpringConstant?: number;
    },
>
Inherited from Devices.deleteDevice
- Defined in ViewModel/Devices.vm.ts:177

deleteDeviceAuthenticationEntity

deleteDeviceAuthenticationEntity(deviceID: number): Promise<boolean>
Delete the device authentication entity
Parameters
- deviceID: number
  the ID of the device to delete the authentication entity for
Returns Promise<boolean>
true if the entity was deleted, false otherwise
Inherited from Devices.deleteDeviceAuthenticationEntity
- Defined in ViewModel/Devices.vm.ts:399

deleteDeviceDebugLog

deleteDeviceDebugLog(log: DeviceDebugArchive): Promise<boolean | "Cancelled">
Parameters
- log: DeviceDebugArchive
Returns Promise<boolean | "Cancelled">
Inherited from Devices.deleteDeviceDebugLog
- Defined in ViewModel/Devices.vm.ts:466

deleteDeviceKey

deleteDeviceKey(deviceID: number): Promise<boolean>
Delete the device key from the S3 bucket
Parameters
- deviceID: number
  the ID of the device to delete the key for
Returns Promise<boolean>
true if the key was deleted, false otherwise
Inherited from Devices.deleteDeviceKey
- Defined in ViewModel/Devices.vm.ts:194

deleteS3Object

deleteS3Object(
path: string,
handleError?: (errors: string[] | number[] | object[]) => void,
): Promise<boolean>
Parameters
- path: string
- handleError: (errors: string[] | number[] | object[]) => void = ...
Returns Promise<boolean>
Inherited from Devices.deleteS3Object
- Defined in Model/Databases/DGAmplify.m.ts:206

downloadDeviceDebugLog

downloadDeviceDebugLog(log: DeviceDebugArchive): Promise<boolean>
Parameters
- log: DeviceDebugArchive
Returns Promise<boolean>
Inherited from Devices.downloadDeviceDebugLog
- Defined in ViewModel/Devices.vm.ts:450

executeLambda

executeLambda(
functionName: string,
functionArgs: any,
): Promise<{ logs: string; result: string }>
Executes a lambda function
Parameters
- functionName: string
  The name of the lambda function to execute
- functionArgs: any
  The arguments to pass to the lambda function
Returns Promise<{ logs: string; result: string }>
- The API response or error
Inherited from Devices.executeLambda
- Defined in Model/Databases/DGAmplify.m.ts:53

getCognitoUser

getCognitoUser(deviceID: number): Promise<AdminGetUserCommandOutput>
Get the Cognito user for a device
Parameters
- deviceID: number
Returns Promise<AdminGetUserCommandOutput>
the Cognito user
Inherited from Devices.getCognitoUser
- Defined in ViewModel/Devices.vm.ts:335

getDB

getDB(): Client
Returns Client
the value of the db private member

See
DGAmplifyTools
Inherited from Devices.getDB
- Defined in Model/DGUtility.m.ts:64

getDebugLogsForDeviceID

getDebugLogsForDeviceID(deviceID?: number): DeviceDebugArchive[]
Parameters
- deviceID: number = null
Returns DeviceDebugArchive[]
Inherited from Devices.getDebugLogsForDeviceID
- Defined in ViewModel/Devices.vm.ts:153

getLambdaParams

getLambdaParams(functionName: string): Promise<{ logs: string; result: string }>
Get all the parameters for a lambda function
Parameters
- functionName: string
  The name of the lambda function to execute
Returns Promise<{ logs: string; result: string }>
See
this.executeLambda
Inherited from Devices.getLambdaParams
- Defined in Model/Databases/DGAmplify.m.ts:116

getObjectPresignedUrl

getObjectPresignedUrl(
path: string,
handleError?: (errors: string[] | number[] | object[]) => void,
): Promise<string>
Parameters
- path: string
- handleError: (errors: string[] | number[] | object[]) => void = ...
Returns Promise<string>
Inherited from Devices.getObjectPresignedUrl
- Defined in Model/Databases/DGAmplify.m.ts:161

getRunsForDevice

getRunsForDevice(deviceID: number): Promise<RunConnection>
Load all run IDs from the database for the device
Parameters
- deviceID: number
  the ID of the device to load runs for
Returns Promise<RunConnection>
the list of runs
Inherited from Devices.getRunsForDevice
- Defined in ViewModel/Devices.vm.ts:485

initCognito

initCognito(
    deviceID: number,
): Promise<
    {
        cognito: CognitoIdentityProviderClient;
        params: { Username: string; UserPoolId: string };
    },
>
Initialize the Cognito service to manage device auth
Parameters
- deviceID: number
Returns Promise<
    {
        cognito: CognitoIdentityProviderClient;
        params: { Username: string; UserPoolId: string };
    },
>
Inherited from Devices.initCognito
- Defined in ViewModel/Devices.vm.ts:299

initS3

initS3(): Promise<S3Client>
Initialize the S3 service to manage device files

Returns Promise<S3Client>
Inherited from Devices.initS3
- Defined in ViewModel/Devices.vm.ts:320

isNumeric

isNumeric(n: string): boolean
Parameters
- n: string
Returns boolean
Inherited from Devices.isNumeric
- Defined in Model/DGUtility.m.ts:88

listS3Objects

listS3Objects(path: string): Promise<ListPaginateWithPathOutput>
Parameters
- path: string
Returns Promise<ListPaginateWithPathOutput>
Inherited from Devices.listS3Objects
- Defined in Model/Databases/DGAmplify.m.ts:177

loadAllDeviceLogs

loadAllDeviceLogs(): Promise<boolean>
Returns Promise<boolean>
Inherited from Devices.loadAllDeviceLogs
- Defined in ViewModel/Devices.vm.ts:142

loadAllUsers

loadAllUsers(callback: (err: object, data: object) => void): Promise<void>
Parameters
- callback: (err: object, data: object) => void
Returns Promise<void>
- Defined in ViewModel/FLEXAdmins.vm.ts:42

loadCurrentUserPoolID

loadCurrentUserPoolID(): Promise<string>
Returns Promise<string>
- Defined in ViewModel/FLEXAdmins.vm.ts:36

loadDevices

loadDevices(teamID: number): Promise<Device[]>
Load all devices from the database
Parameters
- teamID: number
  the ID of the team to load devices for
Returns Promise<Device[]>
the list of devices
Inherited from Devices.loadDevices
- Defined in ViewModel/Devices.vm.ts:274

loadFromS3

loadFromS3(
path: string,
handleError?: (error: string | number | object) => void,
): Promise<string>
Loads a text file from S3
Parameters
- path: string
  The S3 path to the file
- handleError: (error: string | number | object) => void = ...
  The error handler
Returns Promise<string>
- The file contents
Inherited from Devices.loadFromS3
- Defined in Model/Databases/DGAmplify.m.ts:132

loadTeams

loadTeams(): Promise<Team[]>
Load all teams from the database

Returns Promise<Team[]>
the list of teams
Inherited from Devices.loadTeams
- Defined in ViewModel/Devices.vm.ts:260

moveS3File

moveS3File(source: string, destination: string): Promise<boolean>
Move a file in the S3 bucket from one location to another
Parameters
- source: string
  the source path of the file to move
- destination: string
  the destination path of the file to move
Returns Promise<boolean>
true if the file was moved, false otherwise
Inherited from Devices.moveS3File
- Defined in ViewModel/Devices.vm.ts:237

parseArchiveName

parseArchiveName(archiveName: string): { date: Date; deviceID: number }
Parameters
- archiveName: string
Returns { date: Date; deviceID: number }
Inherited from Devices.parseArchiveName
- Defined in ViewModel/Devices.vm.ts:123

reauthorizeDevice

reauthorizeDevice(deviceID: number): Promise<boolean>
Reauthorize the device
Parameters
- deviceID: number
  the ID of the device to reauthorize
Returns Promise<boolean>
true if the device was reauthorized, false otherwise
Inherited from Devices.reauthorizeDevice
- Defined in ViewModel/Devices.vm.ts:378

reauthorizeDeviceKey

reauthorizeDeviceKey(deviceID: number): Promise<boolean>
Reauthorize the device key by moving it back to the device keys folder
Parameters
- deviceID: number
  the ID of the device to reauthorize the key for
Returns Promise<boolean>
true if the key was reauthorized, false otherwise
Inherited from Devices.reauthorizeDeviceKey
- Defined in ViewModel/Devices.vm.ts:223

revokeDeviceAuthorization

revokeDeviceAuthorization(deviceID: number): Promise<boolean>
Revoke the device authorization
Parameters
- deviceID: number
  the ID of the device to revoke authorization for
Returns Promise<boolean>
true if the device was revoked, false otherwise
Inherited from Devices.revokeDeviceAuthorization
- Defined in ViewModel/Devices.vm.ts:357

revokeDeviceKey

revokeDeviceKey(deviceID: number): Promise<boolean>
Revoke the device key by moving it to the revoked keys folder
Parameters
- deviceID: number
  the ID of the device to revoke the key for
Returns Promise<boolean>
true if the key was revoked, false otherwise
Inherited from Devices.revokeDeviceKey
- Defined in ViewModel/Devices.vm.ts:210

s3ObjectExists

s3ObjectExists(path: string): Promise<boolean>
Parameters
- path: string
Returns Promise<boolean>
Inherited from Devices.s3ObjectExists
- Defined in Model/Databases/DGAmplify.m.ts:191

saveToS3

saveToS3(path: string, data: File): Promise<boolean>
Parameters
- path: string
- data: File
Returns Promise<boolean>
Inherited from Devices.saveToS3
- Defined in Model/Databases/DGAmplify.m.ts:146

updateDevice

updateDevice(
    updateDeviceInput: UpdateDeviceInput,
): Promise<
    {
        __typename: "Device";
        ID: number;
        ImageURL?: string;
        Name?: string;
        Password?: string;
        RadiusRA?: number;
        RadiusRB?: number;
        RadiusRC?: number;
        RadiusRD?: number;
        SerialNumber?: string;
        SpringConstant?: number;
    },
>
Update the details for a device in the database
Parameters
- updateDeviceInput: UpdateDeviceInput
  the device input for the update
Returns Promise<
    {
        __typename: "Device";
        ID: number;
        ImageURL?: string;
        Name?: string;
        Password?: string;
        RadiusRA?: number;
        RadiusRB?: number;
        RadiusRC?: number;
        RadiusRD?: number;
        SerialNumber?: string;
        SpringConstant?: number;
    },
>
Inherited from Devices.updateDevice
- Defined in ViewModel/Devices.vm.ts:100

validateDevice

validateDevice(device: UpdateDeviceInput): boolean
Validate the device input
Parameters
- device: UpdateDeviceInput
  the device input to validate
Returns boolean
true if the device is valid, false otherwise
Inherited from Devices.validateDevice
- Defined in ViewModel/Devices.vm.ts:85

Class FLEXAdmins

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns FLEXAdmins

Properties

Protected_ctx

Member

Protected_error

Type Declaration

Parameters

Returns void

Protected_errorFunction

Accessors

amplify

Returns Client

Parameters

Returns void

ctx

Returns FLEXContextVariables

Parameters

Returns void

deviceLogs

Returns string[]

Parameters

Returns void

errorFunction

Parameters

Returns void

Methods

Protected_init

Returns void

avg

Parameters

Returns number

batchDeleteS3Files

Parameters

Returns Promise<any>

createID

Returns string | number[]

deleteDevice

Parameters

Returns Promise< { __typename: "Device"; ID: number; ImageURL?: string; Name?: string; Password?: string; RadiusRA?: number; RadiusRB?: number; RadiusRC?: number; RadiusRD?: number; SerialNumber?: string; SpringConstant?: number; },>

deleteDeviceAuthenticationEntity

Parameters

Returns Promise<boolean>

deleteDeviceDebugLog

Parameters

Returns Promise<boolean | "Cancelled">

deleteDeviceKey

Parameters

Returns Promise<boolean>

deleteS3Object

Parameters

Returns Promise<boolean>

downloadDeviceDebugLog

Parameters

Returns Promise<boolean>

executeLambda

Parameters

Returns Promise<{ logs: string; result: string }>

getCognitoUser

Parameters

Returns Promise<AdminGetUserCommandOutput>

getDB

Returns Client

See

getDebugLogsForDeviceID

Parameters

Returns DeviceDebugArchive[]

getLambdaParams

Parameters

Returns Promise<{ logs: string; result: string }>

See

`Protected`_ctx

`Protected`_error

`Protected`_errorFunction

`Protected`_init

Returns Promise<
{
__typename: "Device";
ID: number;
ImageURL?: string;
Name?: string;
Password?: string;
RadiusRA?: number;
RadiusRB?: number;
RadiusRC?: number;
RadiusRD?: number;
SerialNumber?: string;
SpringConstant?: number;
},
>

Returns Promise<
{
cognito: CognitoIdentityProviderClient;
params: { Username: string; UserPoolId: string };
},
>

Returns Promise<
{
__typename: "Device";
ID: number;
ImageURL?: string;
Name?: string;
Password?: string;
RadiusRA?: number;
RadiusRB?: number;
RadiusRC?: number;
RadiusRD?: number;
SerialNumber?: string;
SpringConstant?: number;
},
>