Class GroupsService<GroupType>

An implementation of the FIN Groups service.

Type Parameters

GroupType extends Group = Group

Index

Constructors

Methods

create createGroup deleteById readAll readByFilter readById update

Constructors

constructor

new GroupsService<GroupType extends Group = Group>(
serviceConfig: ClientServiceConfig,
): GroupsService<GroupType>
Constructs a new groups service object.
Type Parameters
- GroupType extends Group = Group
Parameters
- serviceConfig: ClientServiceConfig
  Service configuration.
Returns GroupsService<GroupType>
- Defined in src/client/groups/GroupService.ts:44

Methods

create

create(
groups: HaysonDict[] | GroupType[] | HGrid<GroupType> | HList<GroupType>,
): Promise<HGrid<GroupType>>
Create multiple group records.
Parameters
- groups: HaysonDict[] | GroupType[] | HGrid<GroupType> | HList<GroupType>
  The groups to create.
Returns Promise<HGrid<GroupType>>
A grid of groups.
- Defined in src/client/groups/GroupService.ts:121

createGroup

createGroup(group: HaysonDict | GroupType): Promise<GroupType>
Create a single group record.
Parameters
- group: HaysonDict | GroupType
  The group record to create.
Returns Promise<GroupType>
The created group record.
- Defined in src/client/groups/GroupService.ts:141

deleteById

deleteById(id: string | HRef): Promise<void>
Delete a group record via its id.
Parameters
- id: string | HRef
  The id of the record to delete.
Returns Promise<void>
- Defined in src/client/groups/GroupService.ts:179

readAll

readAll(options?: GroupsReadOptions): Promise<GroupType[]>
Query all groups.
Parameters
- Optionaloptions: GroupsReadOptions
  Optional options for read operation.
Returns Promise<GroupType[]>
The result of the read operation.
- Defined in src/client/groups/GroupService.ts:55

readByFilter

readByFilter(
filter: string,
options?: GroupsReadOptions,
): Promise<HGrid<GroupType>>
Query some groups via a haystack filter.
Parameters
- filter: string
  The haystack filter to query by.
- Optionaloptions: GroupsReadOptions
  Optional options for read operation.
Returns Promise<HGrid<GroupType>>
The result of the read operation.
- Defined in src/client/groups/GroupService.ts:99

readById

readById(id: string | HRef): Promise<GroupType>
Read a group via its id.
Parameters
- id: string | HRef
  The id of the group to read.
Returns Promise<GroupType>
The group record.

Throws
An error if the group can't be found.
- Defined in src/client/groups/GroupService.ts:80

update

update(group: HaysonDict | GroupType): Promise<GroupType>
Update a group record.
Parameters
- group: HaysonDict | GroupType
  The group record to update.
Returns Promise<GroupType>
A updated record. Please note, this record doesn't have any group information just the id and mod.
- Defined in src/client/groups/GroupService.ts:160