Class TagoCores

Index

Constructors

constructor

Methods

delete edit info list standaloneDeviceInfo standaloneDeviceList tokenGenerate

Constructors

constructor

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

Methods

delete

delete(tagocoreID: string): Promise<string>
Permanently removes a TagoCore instance and its configurations.
Parameters
- tagocoreID: string
Returns Promise<string>
See
https://help.tago.io/portal/en/kb/articles/tagocore TagoCore
Example
```
const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const result = await resources.tagocores.delete("core-id-123");
console.log(result);
```
- Defined in modules/Resources/TagoCores.ts:121

edit

edit(tagoCoreID: string, tagoCoreObj: Partial<TagoCoreInfo>): Promise<string>
Updates configuration and settings for a TagoCore instance.
Parameters
- tagoCoreID: string
- tagoCoreObj: Partial<TagoCoreInfo>
Returns Promise<string>
See
https://help.tago.io/portal/en/kb/articles/tagocore TagoCore
Example
```
const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const result = await resources.tagocores.edit("core-id-123", { name: "Production Core" });
console.log(result);
```
- Defined in modules/Resources/TagoCores.ts:78

info

info(tagoCoreID: string, summary?: boolean): Promise<TagoCoreInfo>
Retrieves detailed information about a specific TagoCore instance.
Parameters
- tagoCoreID: string
- Optionalsummary: boolean
Returns Promise<TagoCoreInfo>
See
https://help.tago.io/portal/en/kb/articles/tagocore TagoCore
Example
```
const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const coreInfo = await resources.tagocores.info("core-id-123", true);
console.log(coreInfo);
```
- Defined in modules/Resources/TagoCores.ts:56

list

list(queryObj?: TagoCoreQuery): Promise<TagoCoreListInfo[]>
Retrieves a paginated list of all TagoCores from the application with filtering and sorting options.
Parameters
- OptionalqueryObj: TagoCoreQuery
Returns Promise<TagoCoreListInfo[]>
See
https://help.tago.io/portal/en/kb/articles/tagocore TagoCore
Example
```
const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const cores = await resources.tagocores.list({
  page: 1,
  fields: ["id", "name"],
  amount: 20
});
console.log(cores);
```
- Defined in modules/Resources/TagoCores.ts:24

standaloneDeviceInfo

standaloneDeviceInfo(tagoCoreID: string, deviceID: string): Promise<DeviceInfo>
Retrieves detailed information about a device connected to a Standalone TagoCore instance.
Parameters
- tagoCoreID: string
- deviceID: string
Returns Promise<DeviceInfo>
See
https://help.tago.io/portal/en/kb/articles/tagocore TagoCore
Example
```
const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const deviceInfo = await resources.tagocores.standaloneDeviceInfo("core-id-123", "device-id-456");
console.log(deviceInfo);
```
- Defined in modules/Resources/TagoCores.ts:142

standaloneDeviceList

standaloneDeviceList<T extends DeviceQuery>(
    tagoCoreID: string,
    queryObj?: T,
): Promise<
    DeviceListItem<
        | "id"
        | "name"
        | (
            T["fields"] extends readonly (string | number | symbol)[]
                ? any[any][number]
                : never
        ),
    >[],
>
Retrieves a list of all devices connected to a Standalone TagoCore instance.
Type Parameters
- T extends DeviceQuery
Parameters
- tagoCoreID: string
- OptionalqueryObj: T
Returns Promise<
    DeviceListItem<
        | "id"
        | "name"
        | (
            T["fields"] extends readonly (string | number | symbol)[]
                ? any[any][number]
                : never
        ),
    >[],
>
See
https://help.tago.io/portal/en/kb/articles/tagocore TagoCore
Example
```
const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const devices = await resources.tagocores.standaloneDeviceList("core-id-123", {
  page: 1,
  fields: ["id", "name", "last_input"],
  amount: 20
});
console.log(devices);
```
- Defined in modules/Resources/TagoCores.ts:170

tokenGenerate

tokenGenerate(tagoCoreID: string): Promise<string>
Generates a new authentication token for a TagoCore instance.
Parameters
- tagoCoreID: string
Returns Promise<string>
See
https://help.tago.io/portal/en/kb/articles/tagocore TagoCore
Example
```
const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const token = await resources.tagocores.tokenGenerate("core-id-123");
console.log(token);
```
- Defined in modules/Resources/TagoCores.ts:100

Class TagoCores

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns TagoCores

Methods

delete

Parameters

Returns Promise<string>

See

Example

edit

Parameters

Returns Promise<string>

See

Example

info

Parameters

Returns Promise<TagoCoreInfo>

See

Example

list

Parameters

Returns Promise<TagoCoreListInfo[]>

See

Example

standaloneDeviceInfo

Parameters

Returns Promise<DeviceInfo>

See

Example

standaloneDeviceList

Type Parameters

Parameters

Returns Promise< DeviceListItem< | "id" | "name" | ( T["fields"] extends readonly (string | number | symbol)[] ? any[any][number] : never ), >[],>

See

Example

tokenGenerate

Parameters

Returns Promise<string>

See

Example

Settings

On This Page

Returns Promise<
DeviceListItem<
| "id"
| "name"
| (
T["fields"] extends readonly (string | number | symbol)[]
? any[any][number]
: never
),
>[],
>