Class Devices

Hierarchy

UrlSection
- Devices

Index

Constructors

constructor

Methods

Constructors

constructor

new Devices(prv: PathSegment, id?: string, service?: any): Devices

Overrides UrlSection.constructor
- Defined in paths/Devices.ts:5
Parameters
- prv: PathSegment
- Optional id: string
- Optional service: any
Returns Devices

Methods

getEndpoint

getEndpoint(withValue?: boolean): string

Inherited from UrlSection.getEndpoint
- Defined in PathSegment.ts:26
Parameters
- Default value withValue: boolean = true
Returns string

Protected getRest

getRest(): RestClient

Inherited from UrlSection.getRest
- Defined in PathSegment.ts:34
Returns RestClient

list

list(query?: ListQuery): Promise<PagingOnlyGroupDevices>

- Defined in paths/Devices.ts:13
Since 1.0.32 (Release 9.3)
Returns the list of paging devices assigned to this group.
Required Permissions
Permission Description
ReadAccounts Viewing user account info (including name, business name, address and phone number/account number)
Usage Plan Group
Light

Parameters
- Optional query: ListQuery
Returns Promise<PagingOnlyGroupDevices>

toString

toString(withValue?: boolean): string

Inherited from UrlSection.toString
- Defined in PathSegment.ts:18
Parameters
- Default value withValue: boolean = true
Returns string

Generated using TypeDoc