Documentation

Namespace: PhotoSources

PhotoSources

Manage the app.PhotoSource objects

Source:

Members

<static, readonly> UseKey :enum

Enum for app.PhotoSource useKey

Type:
  • enum
Source:

Methods

<private, static> _getSelectedSources() → {Array.<app.PhotoSource>}

Get the selected sources from local storage

Source:
Returns:

Array of sources

Type
Array.<app.PhotoSource>

<static> getSelectedPhotos() → {Array.<app.PhotoSource.Photos>}

Get all the photos from all selected sources. These will be used by the screensaver.

Source:
Returns:

Array of sources photos

Type
Array.<app.PhotoSource.Photos>

<static> getUseKeys() → {Array.<string>}

Get all the useage keys

Source:
Returns:

Array of useage keys

Type
Array.<string>

<static> isUseKey(keyName) → {boolean}

Determine if a given key is a photo source

Parameters:
Name Type Description
keyName string

key to check
Source:
Returns:

true if photo source

Type
boolean

<static> process(useKey) → {Promise.<void>}

Process the given photo source and save to localStorage.

Parameters:
Name Type Description
useKey string

The photo source to retrieve
Source:
Returns:

void

Type
Promise.<void>

<static> processAll()

Process all the selected photo sources. This normally requires a https call and may fail for various reasons

Source:

<static> processDaily()

Process all the selected photo sources that are to be updated every day. This normally requires a https call and may fail for various reasons

Source: