Class default

Handles group related API requests

Index

Constructors

Properties

Methods

get getGroup join leave

Constructors

constructor

new default(authService): default
Parameters
- authService: default
Returns default
- Defined in apiFunctions/Group.ts:13

Properties

`Private` auth

The AuthService for this instance

Methods

get

get(): Promise<null | Group[]>
Gets the Groups that the current User is a member of

Returns Promise<null | Group[]>
- Defined in apiFunctions/Group.ts:20

getGroup

getGroup(groupId): Promise<null | GroupResponse>
Gets the Groups that the current User is a member of
Parameters
- groupId: string
  The Group#id to get Posts
Returns Promise<null | GroupResponse>
- Defined in apiFunctions/Group.ts:79

join

join(groupId): Promise<boolean>
Joins a Group with the current User
Parameters
- groupId: string
  The Group#id to join
Returns Promise<boolean>
- Defined in apiFunctions/Group.ts:46

leave

leave(groupId): Promise<boolean>
Leaves a Group with the current User
Parameters
- groupId: string
  The Group#id to leave
Returns Promise<boolean>
- Defined in apiFunctions/Group.ts:105

Generated using TypeDoc