Class SigaaFile

Class to manager file

Hierarchy

AbstractUpdatableResource
- SigaaFile

Implements

File

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new SigaaFile(http: HTTP, options: FileData, updater?: UpdatableResourceCallback): SigaaFile

Overrides AbstractUpdatableResource.constructor
- Defined in src/resources/sigaa-file.ts:74
There are two ways to create the class the first is used the file's id and key the second is used the file form

Parameters
- http: HTTP
- options: FileData
- Optional updater: UpdatableResourceCallback
Returns SigaaFile

Properties

Protected __instanceIndentifier

__instanceIndentifier: string

Private Optional _description

_description: string

Private _id

_id: string

Private Optional _key

_key: string

Private Optional _title

_title: string

Private Optional form

form: SigaaForm

Protected isClosed

isClosed: boolean = false

Readonly type

type: "file" = 'file'

Protected Optional updater

updater: UpdatableResourceCallback

Accessors

_instanceIndentifier

get _instanceIndentifier(): string

Implementation of File._instanceIndentifier
- Defined in src/resources/updatable-resource.ts:37
Returns string

description

get description(): undefined | string

Implementation of File.description
- Defined in src/resources/sigaa-file.ts:122
Description in the sigaa

Returns undefined | string

id

get id(): string

- Defined in src/resources/sigaa-file.ts:127
Returns string

key

get key(): undefined | string

Implementation of File.key
- Defined in src/resources/sigaa-file.ts:117
Is a key to download a file, this is a security feature of SIGAA.

Returns undefined | string

title

get title(): undefined | string

Implementation of File.title
- Defined in src/resources/sigaa-file.ts:112
Label in SIGAA.

Returns undefined | string

Methods

Protected checkIfItWasClosed

checkIfItWasClosed(): void

Inherited from AbstractUpdatableResource.checkIfItWasClosed
- Defined in src/resources/updatable-resource.ts:31
Returns void

close

close(): void

Implementation of File.close

Inherited from AbstractUpdatableResource.close
- Defined in src/resources/updatable-resource.ts:41
Returns void

download

download(basepath: string, callback?: ProgressCallback, retry?: boolean): Promise<string>

Implementation of File.download
- Defined in src/resources/sigaa-file.ts:132
Download the file

Parameters
- basepath: string
- Optional callback: ProgressCallback
- retry: boolean = true
Returns Promise<string>

update

update(options: FileData): void

Implementation of File.update
- Defined in src/resources/sigaa-file.ts:92
Parameters
- options: FileData
Returns void

Protected updateInstance

updateInstance(): Promise<void>

Inherited from AbstractUpdatableResource.updateInstance
- Defined in src/resources/updatable-resource.ts:26
Returns Promise<void>

Generated using TypeDoc