Options
All
  • Public
  • Public/Protected
  • All
Menu

sigaa-api

Index

Public Enumerations

Internal Classes

Other Classes

Public Classes

Internal Interfaces

Other Interfaces

Public Interfaces

Internal Type aliases

Public Type aliases

Internal Method decorator to cache the return, it identifies the returns based on the parameter id of the first argument. Functions

Internal Type aliases

BondType

BondType: StudentBond | TeacherBond

Union of all bonds (StudentBont and TeacherBond).

FileData

FileData: FileDataForm | FileDataKey

HTTPMethod

HTTPMethod: "POST" | "GET"

UpdatableResourceCallback

UpdatableResourceCallback: () => Promise<void>

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

Without

Without<T, U>: {[ P in Exclude<keyof T, keyof U>]: never }

Typescript macro for Without

Type parameters

  • T

  • U

XOR

XOR<T, U>: (Without<T, U> & U) | (Without<U, T> & T)

Typescript macro for XOR

Type parameters

  • T

  • U

Public Type aliases

Activity

Activity: ActivityHomework | ActivityExam | ActivityQuiz

Attachment

Attachment: File | Homework | Quiz | CourseForum | WebContent | Survey | LinkAttachment | VideoAttachment

GradeGroup

GradeGroup: GradeGroupSumOfGrades | GradeGroupOnlyAverage | GradeGroupWeightedAverage

InstitutionType

InstitutionType: "IFSC" | "UFPB"

The institution serves to adjust interactions with SIGAA.

ProgressCallback

ProgressCallback: (totalSize: number, downloadedSize?: number) => void

Type declaration

    • (totalSize: number, downloadedSize?: number): void

    • Parameters

      • totalSize: number
      • Optional downloadedSize: number

      Returns void

SigaaOptionsConstructor

SigaaOptionsConstructor: SigaaCommonConstructorOptions & XOR<{ institution?: InstitutionType }, { session?: Session }> & XOR<SigaaConstructorURL, SigaaConstructorHTTP> & XOR<WithAccountFactory, XOR<WithBondFactory, WithActivityFactory & XOR<WithCourseFactory, WithoutCourseFactory>>>

Internal Method decorator to cache the return, it identifies the returns based on the parameter id of the first argument. Functions

sharedReturn

  • sharedReturn(): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void

  • Returns (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void

      • (target: any, propertyKey: string, descriptor: PropertyDescriptor): void

      • Parameters

        • target: any
        • propertyKey: string
        • descriptor: PropertyDescriptor

        Returns void

Generated using TypeDoc