Documentation

Mistake on this page? Email us

DeviceGroup repository

Hierarchy

Index

Constructors

constructor

  • Initalise a new instance of the repository

    Parameters

    • Optional config: Config

      The configuration to use, if null then repository will initalise its own using dotenv

    • Optional client: Client

      The client instance to use

    Returns DeviceGroupRepository

Properties

client

client: Client

The repository client instance

config

config: Config

The repository configuration class

Methods

addDevice

  • addDevice

    Parameters

    Returns Promise<void>

create

delete

  • delete(id: string): Promise<void>
  • delete

    Parameters

    • id: string

      The ID of the group.

    Returns Promise<void>

devices

list

read

  • read

    Parameters

    • id: string

      The group ID.

    Returns Promise<DeviceGroup>

removeDevice

  • removeDevice

    Parameters

    Returns Promise<void>

update