Class Activities

Constructors

constructor

Methods

getActivityAttendance getActivityAttendances

Constructors

constructor

Methods

getActivityAttendance

  • getActivityAttendance(
        context: "team" | "organisation" | "admin",
        contextId: number,
        attendanceId: number,
    ): Promise<Activity>

  • 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

    • attendanceId: number

      The numeric identifier for a resource

    Returns Promise<Activity>

    • An animal item

getActivityAttendances

  • getActivityAttendances(
        context: "team" | "organisation" | "admin",
        contextId: number,
        options?: {
            activity_id?: number | number[];
            activity_resource_type?: string;
            deleted?: boolean;
            ends_after?: string;
            ends_before?: string;
            id?: number | number[];
            member_id?: number | number[];
            order?: "asc" | "desc";
            page?: number;
            role_id?: number | number[];
            size?: number;
            sort?: "createdAt" | "id" | "updatedAt";
            starts_after?: string;
            starts_before?: string;
            status?: string;
        },
    ): Promise<Activity[]>

  • 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: {
          activity_id?: number | number[];
          activity_resource_type?: string;
          deleted?: boolean;
          ends_after?: string;
          ends_before?: string;
          id?: number | number[];
          member_id?: number | number[];
          order?: "asc" | "desc";
          page?: number;
          role_id?: number | number[];
          size?: number;
          sort?: "createdAt" | "id" | "updatedAt";
          starts_after?: string;
          starts_before?: string;
          status?: string;
      }
      • Optionalactivity_id?: number | number[]

        One or more activity resource identifiers

      • Optionalactivity_resource_type?: string

        One or more attendance statuses

      • Optionaldeleted?: boolean

        Return only attendances from deleted activities

      • Optionalends_after?: string

        Return only resources ending after this datetime

      • Optionalends_before?: string

        Return only resources ending before this datetime

      • Optionalid?: number | number[]

        A list of ids

      • Optionalmember_id?: number | number[]

        One or more member resource identifiers

      • Optionalorder?: "asc" | "desc"

        Default: "asc"

      • Optionalpage?: number

        Page number

      • Optionalrole_id?: number | number[]

        One or more role resource identifiers

      • Optionalsize?: number

        Items per page

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

        Default: "id"

      • Optionalstarts_after?: string

        Return only resources starting after this datetime

      • Optionalstarts_before?: string

        Return only resources starting before this datetime

      • Optionalstatus?: string

        One or more attendance statuses

    Returns Promise<Activity[]>

Settings

Member Visibility

On This Page

Constructors
Methods