Class TagoCores

Hierarchy

TagoIOModule<GenericModuleParams>
- TagoCores

Index

Constructors

Methods

clusterCreate clusterDelete clusterDeviceInfo clusterDeviceList clusterEdit clusterInfo clusterList clusterTokenCreate 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

clusterCreate

clusterCreate(clusterObj): Promise<{
id: string;
token: string;
}>
Generates and retrieves a new Cluster for the account
Parameters
- clusterObj: TagoCoreClusterCreateInfo
  Object with data to create new bucket
Returns Promise<{
id: string;
token: string;
}>
- Defined in modules/Resources/TagoCores.ts:183

clusterDelete

clusterDelete(clusterID): Promise<string>
Deletes a TagoCore Cluster
Parameters
- clusterID: string
  TagoCore Cluster ID
Returns Promise<string>
- Defined in modules/Resources/TagoCores.ts:197

clusterDeviceInfo

clusterDeviceInfo(clusterID, deviceID): Promise<DeviceInfo>
Get Info of the Device from a TagoCore Cluster.
Parameters
- clusterID: string
  TagoCore Cluster ID
- deviceID: string
  Device ID
Returns Promise<DeviceInfo>
- Defined in modules/Resources/TagoCores.ts:228

clusterDeviceList

clusterDeviceList<T>(clusterID, queryObj?): Promise<DeviceListItem<"id" | "name" | T["fields"][number]>[]>
Retrieves a list with all devices from a TagoCore Cluster.
Type Parameters
- T extends DeviceQuery
Parameters
- clusterID: string
  TagoCore Cluster 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:288

clusterEdit

clusterEdit(clusterID, updateObj): Promise<string>
Modify any property of the TagoCore Cluster.
Parameters
- clusterID: string
  TagoCore Cluster ID
- updateObj: Partial<TagoCoreClusterInfo>
  TagoCore Cluster Object with data to replace
Returns Promise<string>
- Defined in modules/Resources/TagoCores.ts:169

clusterInfo

clusterInfo(clusterID): Promise<TagoCoreClusterInfo>
Gets information about the TagoCore Cluster
Parameters
- clusterID: string
  TagoCore Cluster ID
Returns Promise<TagoCoreClusterInfo>
- Defined in modules/Resources/TagoCores.ts:155

clusterList

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

clusterTokenCreate

clusterTokenCreate(clusterID): Promise<string>
Generate a new token for the TagoCore
Parameters
- clusterID: string
  TagoCore Cluster ID
Returns Promise<string>
- Defined in modules/Resources/TagoCores.ts:142

delete

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

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:70

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:55

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:30

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:211

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:254

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:84

Class TagoCores

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns TagoCores

Methods

clusterCreate

Parameters

Returns Promise<{ id: string; token: string; }>

clusterDelete

Parameters

Returns Promise<string>

clusterDeviceInfo

Parameters

Returns Promise<DeviceInfo>

clusterDeviceList

Type Parameters

Parameters

Returns Promise<DeviceListItem<"id" | "name" | T["fields"][number]>[]>

Default

clusterEdit

Parameters

Returns Promise<string>

clusterInfo

Parameters

Returns Promise<TagoCoreClusterInfo>

clusterList

Parameters

Returns Promise<TagoCoreClusterListInfo[]>

Default

clusterTokenCreate

Parameters

Returns Promise<string>

delete

Parameters

Returns Promise<string>

edit

Parameters

Returns Promise<string>

info

Parameters

Returns Promise<TagoCoreInfo>

list

Parameters

Returns Promise<TagoCoreListInfo[]>

Default

standaloneDeviceInfo

Parameters

Returns Promise<DeviceInfo>

standaloneDeviceList

Type Parameters

Parameters

Returns Promise<DeviceListItem<"id" | "name" | T["fields"][number]>[]>

Default

tokenGenerate

Parameters

Returns Promise<string>

Settings

Member Visibility

Theme

On This Page

Returns Promise<{
id: string;
token: string;
}>