Class IliasBuddyFetchEntriesApi

Module to easily fetch Ilias entries / test connection to RSS feed / ...

Hierarchy

IliasBuddyFetchEntriesApi

Index

Constructors

constructor

Methods

Constructors

constructor

new IliasBuddyFetchEntriesApi(url: string, userName: string, password: string): IliasBuddyFetchEntriesApi

- Defined in modules/IliasBuddy/FETCH/FetchEntriesApi.js:63
Creates an instance of IliasBuddyFetchEntriesApi

Parameters
- url: string
  
  Private Ilias RSS feed url
- userName: string
  
  Private Ilias RSS feed username
- password: string
  
  Private Ilias RSS feed password
Returns IliasBuddyFetchEntriesApi

Methods

getCurrentEntries

getCurrentEntries(): Promise<Entry[]>

- Defined in modules/IliasBuddy/FETCH/FetchEntriesApi.js:113
Get the current Ilias entries

Returns Promise<Entry[]>

{Promise<import('../PARSER/RawEntryParserTypes') .IliasBuddyRawEntryParser.Entry[]>}

getCurrentEntriesRaw

getCurrentEntriesRaw(): Promise<WholeThing>

- Defined in modules/IliasBuddy/FETCH/FetchEntriesApi.js:81
Get the current entries "Raw" which means parsed as JSON but not modified in any way

Returns Promise<WholeThing>

{Promise<import('./FetchEntriesTypes') .IliasPrivateRssFeed.WholeThing>}

Static testConnection

testConnection(url: string, userName: string, password: string): Promise<any>

- Defined in modules/IliasBuddy/FETCH/FetchEntriesApi.js:23
Test if a successful connection can be established

Parameters
- url: string
  
  Private Ilias RSS feed url
- userName: string
  
  Private Ilias RSS feed username
- password: string
  
  Private Ilias RSS feed password
Returns Promise<any>

Generated using TypeDoc