Class Group

This class allows access to the details of each group a GroupRepository must be used to obtain instances of this class.

Hierarchy

Group

Index

Constructors

Properties

id name owner participants

Methods

minusParticipants plusParticipants with

Constructors

`Private` constructor

new Group(id: string, name: string, owner: string, participants: Iterable<string>): Group
Parameters
- id: string
- name: string
- owner: string
- participants: Iterable<string>
Returns Group
- Defined in src/groups/Group.ts:34

Properties

`Readonly` id

id: string

The unique id that identifies the group

`Readonly` name

name: string

The name of the group

`Readonly` owner

owner: string

The user that owns the group

`Readonly` participants

participants: readonly string[]

A list of the users that belong to the group

Methods

minusParticipants

minusParticipants(...participants: string[]): Group
Creates a new Group object removing the provided participants
Parameters
- Rest ...participants: string[]
Returns Group
- Defined in src/groups/Group.ts:58

plusParticipants

plusParticipants(...participants: string[]): Group
Creates a new Group object adding the provided participants
Parameters
- Rest ...participants: string[]
Returns Group
- Defined in src/groups/Group.ts:51

with

with(__namedParameters?: {
name: undefined | string;
participants: undefined | readonly string[];
}): Group
Creates a new Group object with the provided parameter changed
Parameters
- __namedParameters: {
  name: undefined | string;
  participants: undefined | readonly string[];
  } = {}
  - name: undefined | string
  - participants: undefined | readonly string[]
Returns Group
- Defined in src/groups/Group.ts:44

Generated using TypeDoc