Class Groups

Constructors

constructor

Methods

getMemberGroup getMemberGroupMemberships getMemberGroups

Constructors

constructor

Methods

getMemberGroup

  • getMemberGroup(
        context: "team" | "organisation" | "admin",
        contextId: number,
        groupId: number,
    ): Promise<memberGroup>

  • Parameters

    • context: "team" | "organisation" | "admin"

      The point of view from where the request takes place

    • contextId: number

      Either a team, organisation or admin's id

    • groupId: number

      A group identifier

    Returns Promise<memberGroup>

    • A member group

getMemberGroupMemberships

  • getMemberGroupMemberships(
        context: "team" | "organisation" | "admin",
        contextId: number,
        options?: {
            group_id?: number | number[];
            id?: number | number[];
            member_id?: number | number[];
            order?: "asc" | "desc";
            page?: number;
            size?: number;
            sort?: "createdAt" | "id" | "updatedAt";
            team_id?: number | number[];
        },
    ): Promise<groupMembership[]>

  • Parameters

    • context: "team" | "organisation" | "admin"

      The point of view from where the request takes place

    • contextId: number

      Either a team, organisation or admin's id

    • Optionaloptions: {
          group_id?: number | number[];
          id?: number | number[];
          member_id?: number | number[];
          order?: "asc" | "desc";
          page?: number;
          size?: number;
          sort?: "createdAt" | "id" | "updatedAt";
          team_id?: number | number[];
      }
      • Optionalgroup_id?: number | number[]

        One or more group identifiers

      • Optionalid?: number | number[]

        A list of ids

      • Optionalmember_id?: number | number[]

        One or more member identifiers

      • Optionalorder?: "asc" | "desc"

        Default: "asc"

      • Optionalpage?: number

        Page number

      • Optionalsize?: number

        Items per page

      • Optionalsort?: "createdAt" | "id" | "updatedAt"

        Default: "id"

      • Optionalteam_id?: number | number[]

        One or more team identifiers

    Returns Promise<groupMembership[]>

    • A list of member group memberships

getMemberGroups

  • getMemberGroups(
        context: "team" | "organisation" | "admin",
        contextId: number,
        options?: {
            id?: number;
            order?: "asc" | "desc";
            page?: number;
            size?: number;
            sort?: "createdAt" | "id" | "updatedAt";
            team_id?: number | number[];
            title?: string;
        },
    ): Promise<memberGroup[]>

  • Parameters

    • context: "team" | "organisation" | "admin"

      The point of view from where the request takes place

    • contextId: number

      Either a team, organisation or admin's id

    • Optionaloptions: {
          id?: number;
          order?: "asc" | "desc";
          page?: number;
          size?: number;
          sort?: "createdAt" | "id" | "updatedAt";
          team_id?: number | number[];
          title?: string;
      }
      • Optionalid?: number

        A list of ids

      • Optionalorder?: "asc" | "desc"

        Default: "asc"

      • Optionalpage?: number

        Page number

      • Optionalsize?: number

        Items per page

      • Optionalsort?: "createdAt" | "id" | "updatedAt"

        Default: "id"

      • Optionalteam_id?: number | number[]

        One or more team identifiers

      • Optionaltitle?: string

        A simple text search term, compared against the title

    Returns Promise<memberGroup[]>

Settings

Member Visibility

On This Page

Constructors
Methods