Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IliasBuddyApi

API to easily manage to get feed updates, cached entries, etc.

Hierarchy

  • IliasBuddyApi

Index

Interfaces

Type aliases

Constructors

Methods

Type aliases

NewEntriesFoundCallback

NewEntriesFoundCallback: function

New entries found callback

param

The new entries from the latest feed to the current cached ones

Type declaration

    • (newEntries: Entry[]): void

    • Parameters

      Returns void

Constructors

constructor

  • new IliasBuddyApi(url: string, userName: string, password: string, newEntriesFoundCallback: function): IliasBuddyApi

  • Creates an instance of IliasBuddyApi

    Parameters

    • url: string

      Private Ilias RSS feed url

    • userName: string

      Private Ilias RSS feed username

    • password: string

      Private Ilias RSS feed password

    • newEntriesFoundCallback: function
        • (newEntries: Entry[]): void

        • Parameters

          Returns void

    Returns IliasBuddyApi

Methods

getCurrentEntries

  • getCurrentEntries(callback?: boolean): Promise<Entry[]>

  • Get the current feed entries

    Parameters

    • Default value callback: boolean = false

    Returns Promise<Entry[]>

    {Promise<import('../FETCH/FetchEntriesTypes') .IliasBuddyFetchEntries.Entry[]>}

Static getCache

Static renderEntriesHtml

  • renderEntriesHtml(entries: Entry[]): string[]

Static testConnection

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

  • Test if a connection with a 200 response can be established

    Parameters

    • url: string

      Private Ilias feed URL

    • userName: string

      Private Ilias feed user name for authentication

    • password: string

      Private Ilias feed password for authentication

    Returns Promise<void>

Generated using TypeDoc