Class TagoCores

Hierarchy

TagoIOModule<GenericModuleParams>
- TagoCores

Index

Constructors

Methods

delete edit info list standaloneDeviceInfo standaloneDeviceList tokenGenerate

Constructors

constructor

new TagoCores(params): TagoCores
Parameters
- params: GenericModuleParams
Returns TagoCores
Inherited from TagoIOModule<GenericModuleParams>.constructor
- Defined in common/TagoIOModule.ts:79

Methods

delete

delete(tagocoreID): Promise<string>
Deletes a TagoCore
Parameters
- tagocoreID: string
Returns Promise<string>
- Defined in modules/Resources/TagoCores.ts:89

edit

edit(tagoCoreID, tagoCoreObj): Promise<string>
Modify any property of the TagoCore.
Parameters
- tagoCoreID: string
  TagoCore ID
- tagoCoreObj: Partial<TagoCoreInfo>
  TagoCore Object with data to replace
Returns Promise<string>
- Defined in modules/Resources/TagoCores.ts:62

info

info(tagoCoreID, summary?): Promise<TagoCoreInfo>
Gets information about the TagoCore
Parameters
- tagoCoreID: string
  TagoCore ID
- Optional summary: boolean
  Fetch summary from the instance if it is connected
Returns Promise<TagoCoreInfo>
- Defined in modules/Resources/TagoCores.ts:47

list

list(queryObj?): Promise<TagoCoreListInfo[]>
Retrieves a list with all TagoCores from the account
Parameters
- Optional queryObj: TagoCoreQuery
  Search query params
Returns Promise<TagoCoreListInfo[]>
Default
```
queryObj: {
  page: 1,
  fields: ["id", "name"],
  filter: {},
  amount: 20,
  orderBy: "name,asc",
}
```json
```
- Defined in modules/Resources/TagoCores.ts:22

standaloneDeviceInfo

standaloneDeviceInfo(tagoCoreID, deviceID): Promise<DeviceInfo>
Get Info of the Device from a Standalone TagoCore instance.
Parameters
- tagoCoreID: string
  Standalone TagoCore ID
- deviceID: string
  Device ID
Returns Promise<DeviceInfo>
- Defined in modules/Resources/TagoCores.ts:103

standaloneDeviceList

standaloneDeviceList<T>(tagoCoreID, queryObj?): Promise<DeviceListItem<"id" | "name" | T["fields"][number]>[]>
Retrieves a list with all devices from a Standalone TagoCore instance.
Type Parameters
- T extends DeviceQuery
Parameters
- tagoCoreID: string
  Standalone TagoCore ID
- Optional queryObj: T
  Search query params
Returns Promise<DeviceListItem<"id" | "name" | T["fields"][number]>[]>
Default
```
queryObj: {
  page: 1,
  fields: ["id", "name"],
  filter: {},
  amount: 20,
  orderBy: "name,asc",
  resolveBucketName: false,
}
```
- Defined in modules/Resources/TagoCores.ts:129

tokenGenerate

tokenGenerate(tagoCoreID): Promise<string>
Generate a new token for the TagoCore
Parameters
- tagoCoreID: string
  TagoCore ID
Returns Promise<string>
- Defined in modules/Resources/TagoCores.ts:76