| Arm Pelion IoT Platform

Documentation

Mistake on this page? Email us

DeviceGroup repository

Hierarchy

Repository
- DeviceGroupRepository

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new DeviceGroupRepository(config?: ConfigOptions, client?: Client): DeviceGroupRepository

Inherited from Repository.constructor

Initalise a new instance of the repository

Parameters
- Optional config: ConfigOptions
  
  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(request: DeviceGroupAddDeviceRequest, id: string): Promise<void>

addDevice

Parameters
- request: DeviceGroupAddDeviceRequest
  
  The entity to perform action on.
- id: string
  
  The ID of the group.
Returns Promise<void>

create

create(request: DeviceGroupCreateRequest): Promise<DeviceGroup>

create

Parameters
- request: DeviceGroupCreateRequest
  
  The entity to perform action on.
Returns Promise<DeviceGroup>

delete

delete(id: string): Promise<void>

delete

Parameters
- id: string
  
  The ID of the group.
Returns Promise<void>

devices

devices(id: string, options?: DeviceGroupDeviceListOptions): Paginator<Device, ListOptions>

devices

Parameters
- id: string
  
  id
- Optional options: DeviceGroupDeviceListOptions
  
  Options to use for the List
Returns Paginator<Device, ListOptions>

list

list(options?: DeviceGroupListOptions): Paginator<DeviceGroup, ListOptions>

list

Parameters
- Optional options: DeviceGroupListOptions
  
  Options to use for the List
Returns Paginator<DeviceGroup, ListOptions>

read

read(id: string): Promise<DeviceGroup>

read

Parameters
- id: string
  
  The group ID.
Returns Promise<DeviceGroup>

removeDevice

removeDevice(request: DeviceGroupRemoveDeviceRequest, id: string): Promise<void>

removeDevice

Parameters
- request: DeviceGroupRemoveDeviceRequest
  
  The entity to perform action on.
- id: string
  
  The ID of the group.
Returns Promise<void>

update

update(request: DeviceGroupUpdateRequest, id: string): Promise<DeviceGroup>

update

Parameters
- request: DeviceGroupUpdateRequest
  
  The entity to perform action on.
- id: string
  
  The group ID.
Returns Promise<DeviceGroup>