Class PlaceGroup

Representation of a group in PlaceOS.

Index

Constructors

constructor

Properties

authority_id children_count? created_at description id name parent_id subsystems updated_at

Constructors

constructor

new PlaceGroup(raw_data?: Partial<PlaceGroup>): PlaceGroup
Parameters
- raw_data: Partial<PlaceGroup> = {}
Returns PlaceGroup
- Defined in groups/group.ts:22

Properties

`Readonly`authority_id

authority_id: string

ID of the authority associated with the group

`Optional` `Readonly`children_count

children_count?: number

Count of child groups for this group

`Readonly`created_at

created_at: string

ISO8601 timestamp of the creation time of the group

`Readonly`description

description: string

Description of the group's purpose

`Readonly`id

id: string

Unique identifier of the group

`Readonly`name

name: string

Human readable name of the group

`Readonly`parent_id

parent_id: string

ID of the parent group

`Readonly`subsystems

subsystems: string[]

Subsystems this group participates in

`Readonly`updated_at

updated_at: string

ISO8601 timestamp of the last update time of the group

Class PlaceGroup

Index

Constructors

Properties

Constructors

constructor

Parameters

Returns PlaceGroup

Properties

`Readonly`authority_id

`Optional` `Readonly`children_count

`Readonly`created_at

`Readonly`description

`Readonly`id

`Readonly`name

`Readonly`parent_id

`Readonly`subsystems

`Readonly`updated_at

Settings

On This Page

Class PlaceGroup

Index

Constructors

Properties

Constructors

constructor

Parameters

Returns PlaceGroup

Properties

Readonlyauthority_id

Optional Readonlychildren_count

Readonlycreated_at

Readonlydescription

Readonlyid

Readonlyname

Readonlyparent_id

Readonlysubsystems

Readonlyupdated_at

Settings

On This Page

`Readonly`authority_id

`Optional` `Readonly`children_count

`Readonly`created_at

`Readonly`description

`Readonly`id

`Readonly`name

`Readonly`parent_id

`Readonly`subsystems

`Readonly`updated_at