Class TagoCores

Hierarchy

TagoIOModule<GenericModuleParams>
- TagoCores

Index

Constructors

constructor

Methods

Constructors

constructor

new TagoCores(params: GenericModuleParams): TagoCores

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

Methods

clusterCreate

clusterCreate(clusterObj: TagoCoreClusterCreateInfo): Promise<{ id: string; token: string }>

- Defined in src/modules/Account/TagoCores.ts:183
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 }>

clusterDelete

clusterDelete(clusterID: string): Promise<string>

- Defined in src/modules/Account/TagoCores.ts:197
Deletes a TagoCore Cluster

Parameters
- clusterID: string
  
  TagoCore Cluster ID
Returns Promise<string>

clusterDeviceInfo

clusterDeviceInfo(clusterID: string, deviceID: string): Promise<Types.Account.Devices.DeviceInfo>

- Defined in src/modules/Account/TagoCores.ts:228
Get Info of the Device from a TagoCore Cluster.

Parameters
- clusterID: string
  
  TagoCore Cluster ID
- deviceID: string
  
  Device ID
Returns Promise<Types.Account.Devices.DeviceInfo>

clusterDeviceList

clusterDeviceList(clusterID: string, queryObj?: DeviceQuery): Promise<DeviceListItem[]>

- Defined in src/modules/Account/TagoCores.ts:290
Retrieves a list with all devices from a TagoCore Cluster.

default
queryObj: { page: 1, fields: ["id", "name"], filter: {}, amount: 20, orderBy: "name,asc", resolveBucketName: false, }

Parameters
- clusterID: string
  
  TagoCore Cluster ID
- Optional queryObj: DeviceQuery
  
  Search query params
Returns Promise<DeviceListItem[]>

clusterEdit

clusterEdit(clusterID: string, updateObj: Partial<TagoCoreClusterInfo>): Promise<string>

- Defined in src/modules/Account/TagoCores.ts:169
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>

clusterInfo

clusterInfo(clusterID: string): Promise<TagoCoreClusterInfo>

- Defined in src/modules/Account/TagoCores.ts:155
Gets information about the TagoCore Cluster

Parameters
- clusterID: string
  
  TagoCore Cluster ID
Returns Promise<TagoCoreClusterInfo>

clusterList

clusterList(queryObj?: TagoCoreClusterQuery): Promise<TagoCoreClusterListInfo[]>

- Defined in src/modules/Account/TagoCores.ts:120
Retrieves a list with all TagoCore Clusters from the account

default
json queryObj: { page: 1, fields: ["id", "name"], filter: {}, amount: 20, orderBy: "name,asc", } json

Parameters
- Optional queryObj: TagoCoreClusterQuery
  
  Search query params
Returns Promise<TagoCoreClusterListInfo[]>

clusterTokenCreate

clusterTokenCreate(clusterID: string): Promise<string>

- Defined in src/modules/Account/TagoCores.ts:142
Generate a new token for the TagoCore

Parameters
- clusterID: string
  
  TagoCore Cluster ID
Returns Promise<string>

delete

delete(tagocoreID: string): Promise<string>

- Defined in src/modules/Account/TagoCores.ts:97
Deletes a TagoCore

Parameters
- tagocoreID: string
Returns Promise<string>

edit

edit(tagoCoreID: string, tagoCoreObj: Partial<TagoCoreInfo>): Promise<string>

- Defined in src/modules/Account/TagoCores.ts:70
Modify any property of the TagoCore.

Parameters
- tagoCoreID: string
  
  TagoCore ID
- tagoCoreObj: Partial<TagoCoreInfo>
  
  TagoCore Object with data to replace
Returns Promise<string>

info

info(tagoCoreID: string, summary?: boolean): Promise<TagoCoreInfo>

- Defined in src/modules/Account/TagoCores.ts:55
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>

list

list(queryObj?: TagoCoreQuery): Promise<TagoCoreListInfo[]>

- Defined in src/modules/Account/TagoCores.ts:30
Retrieves a list with all TagoCores from the account

default
json queryObj: { page: 1, fields: ["id", "name"], filter: {}, amount: 20, orderBy: "name,asc", } json

Parameters
- Optional queryObj: TagoCoreQuery
  
  Search query params
Returns Promise<TagoCoreListInfo[]>

standaloneDeviceInfo

standaloneDeviceInfo(tagoCoreID: string, deviceID: string): Promise<Types.Account.Devices.DeviceInfo>

- Defined in src/modules/Account/TagoCores.ts:211
Get Info of the Device from a Standalone TagoCore instance.

Parameters
- tagoCoreID: string
  
  Standalone TagoCore ID
- deviceID: string
  
  Device ID
Returns Promise<Types.Account.Devices.DeviceInfo>

standaloneDeviceList

standaloneDeviceList(tagoCoreID: string, queryObj?: DeviceQuery): Promise<DeviceListItem[]>

- Defined in src/modules/Account/TagoCores.ts:254
Retrieves a list with all devices from a Standalone TagoCore instance.

default
queryObj: { page: 1, fields: ["id", "name"], filter: {}, amount: 20, orderBy: "name,asc", resolveBucketName: false, }

Parameters
- tagoCoreID: string
  
  Standalone TagoCore ID
- Optional queryObj: DeviceQuery
  
  Search query params
Returns Promise<DeviceListItem[]>

tokenGenerate

tokenGenerate(tagoCoreID: string): Promise<string>

- Defined in src/modules/Account/TagoCores.ts:84
Generate a new token for the TagoCore

Parameters
- tagoCoreID: string
  
  TagoCore ID
Returns Promise<string>