Class Devices

Hierarchy (View Summary)

default
- Devices

Constructors

constructor

new Devices(): Devices
Class constructor. Calls _init() on the superclass. Add parameters as needed

Returns Devices
Overrides default.constructor
- Defined in src/ViewModel/Devices.vm.ts:68

Properties

`Protected`_ctx

_ctx: FLEXContextVariables

Member

ctx

Accessors

amplify

get amplify(): Client
Returns Client
Inherited from DGUtility.amplify
- Defined in src/Model/DGUtility.m.ts:86
set amplify(amplify: Client): void
Parameters
- amplify: Client
Returns void
Inherited from DGUtility.amplify
- Defined in src/Model/DGUtility.m.ts:74

ctx

get ctx(): FLEXContextVariables
Returns FLEXContextVariables
Inherited from DGUtility.ctx
- Defined in src/Model/DGUtility.m.ts:82
set ctx(ctx: FLEXContextVariables): void
Parameters
- ctx: FLEXContextVariables
Returns void
Inherited from DGUtility.ctx
- Defined in src/Model/DGUtility.m.ts:78

errorFunction

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

Methods

`Protected`_error

_error(errors: string[] | number[] | object[]): void
- Protected Members **
Parameters
- errors: string[] | number[] | object[]
Returns void
Inherited from default._error
- Defined in src/Model/DGUtility.m.ts:22

`Protected`_errorFunction

_errorFunction(errors: string[] | number[] | object[]): void
Parameters
- errors: string[] | number[] | object[]
Returns void
Inherited from default._errorFunction
- Defined in src/Model/DGUtility.m.ts:42

`Protected`_init

_init(): void
Initialize and perform setup for the class

Returns void
Overrides default._init
- Defined in src/ViewModel/Devices.vm.ts:58

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 default.avg
- Defined in src/Model/DGUtility.m.ts:60

batchDeleteS3Files

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

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 default.createID
- Defined in src/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;
    },
>
- Defined in src/ViewModel/Devices.vm.ts:123

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
- Defined in src/ViewModel/Devices.vm.ts:345

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
- Defined in src/ViewModel/Devices.vm.ts:140

getCognitoUser

getCognitoUser(deviceID: number): Promise<AdminGetUserResponse>
Get the Cognito user for a device
Parameters
- deviceID: number
Returns Promise<AdminGetUserResponse>
the Cognito user
- Defined in src/ViewModel/Devices.vm.ts:281

getDB

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

See
DGAmplifyTools
Inherited from default.getDB
- Defined in src/Model/DGUtility.m.ts:66

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
- Defined in src/ViewModel/Devices.vm.ts:405

initCognito

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

initS3

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

Returns Promise<S3>
- Defined in src/ViewModel/Devices.vm.ts:266

isNumeric

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

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
- Defined in src/ViewModel/Devices.vm.ts:220

loadTeams

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

Returns Promise<Team[]>
the list of teams
- Defined in src/ViewModel/Devices.vm.ts:206

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
- Defined in src/ViewModel/Devices.vm.ts:183

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
- Defined in src/ViewModel/Devices.vm.ts:324

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
- Defined in src/ViewModel/Devices.vm.ts:169

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
- Defined in src/ViewModel/Devices.vm.ts:303

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
- Defined in src/ViewModel/Devices.vm.ts:156

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;
    },
>
- Defined in src/ViewModel/Devices.vm.ts:94

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
- Defined in src/ViewModel/Devices.vm.ts:79

Class Devices

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Devices

Properties

Protected_ctx

Member

Accessors

amplify

Returns Client

Parameters

Returns void

ctx

Returns FLEXContextVariables

Parameters

Returns void

errorFunction

Parameters

Returns void

Methods

Protected_error

Parameters

Returns void

Protected_errorFunction

Parameters

Returns void

Protected_init

Returns void

avg

Parameters

Returns number

batchDeleteS3Files

Parameters

Returns Promise<Error[]>

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>

deleteDeviceKey

Parameters

Returns Promise<boolean>

getCognitoUser

Parameters

Returns Promise<AdminGetUserResponse>

getDB

Returns Client

See

getRunsForDevice

Parameters

Returns Promise<RunConnection>

initCognito

Parameters

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

initS3

Returns Promise<S3>

isNumeric

Parameters

Returns boolean

loadDevices

Parameters

Returns Promise<Device[]>

loadTeams

Returns Promise<Team[]>

moveS3File

Parameters

Returns Promise<boolean>

reauthorizeDevice

Parameters

Returns Promise<boolean>

reauthorizeDeviceKey

`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: CognitoIdentityServiceProvider;
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;
},
>