Class GoogleSource

A source of photos from Google Photos

Hierarchy

PhotoSource
- GoogleSource

Index

Constructors

constructor

Accessors

Constructors

constructor

new GoogleSource(useKey: UseKey, photosKey: string, type: Type, desc: string, isLimited: boolean, isDaily: boolean, isArray: boolean, loadArg?: any): GoogleSource

Overrides PhotoSource.constructor
- Defined in scripts/sources/photo_source_google.ts:787
Parameters
- useKey: UseKey
- photosKey: string
- type: Type
- desc: string
- isLimited: boolean
- isDaily: boolean
- isArray: boolean
- Optional loadArg: any
Returns GoogleSource

Accessors

Static DEF_FILTER

get DEF_FILTER(): object

- Defined in scripts/sources/photo_source_google.ts:118
Default photo filter

Returns object
- contentFilter: object
  - includedContentCategories: string[]
- mediaTypeFilter: object
  - mediaTypes: string[]

Static MAX_ALBUMS

get MAX_ALBUMS(): number

- Defined in scripts/sources/photo_source_google.ts:147
Max albums to use

Returns number

Static MAX_ALBUM_PHOTOS

get MAX_ALBUM_PHOTOS(): number

- Defined in scripts/sources/photo_source_google.ts:152
Max photos per album to use

Returns number

Static MAX_FILTERED_PHOTOS

get MAX_FILTERED_PHOTOS(): number

- Defined in scripts/sources/photo_source_google.ts:162
Max photos for google images mode

Returns number

Static MAX_PHOTOS

get MAX_PHOTOS(): number

- Defined in scripts/sources/photo_source_google.ts:157
Max photos total to use for album mode

Returns number

Static NO_FILTER

get NO_FILTER(): object

- Defined in scripts/sources/photo_source_google.ts:136
No filtering

Returns object
- mediaTypeFilter: object
  - mediaTypes: string[]

Methods

fetchPhotos

fetchPhotos(): Promise<IPhoto[] | ISelectedAlbum[]>

Overrides PhotoSource.fetchPhotos
- Defined in scripts/sources/photo_source_google.ts:800
Fetch the albums or photos for this source

throws

An error if we couldn't update

Returns Promise<IPhoto[] | ISelectedAlbum[]>

An array of albums or array of photos

getDesc

getDesc(): string

Inherited from PhotoSource.getDesc
- Defined in scripts/sources/photo_source.ts:162
Get a human readable description

Returns string

getLoadArg

getLoadArg(): any

Inherited from PhotoSource.getLoadArg
- Defined in scripts/sources/photo_source.ts:172
Get extra argument

Returns any

getPhotos

getPhotos(): Promise<IPhotos>

Inherited from PhotoSource.getPhotos
- Defined in scripts/sources/photo_source.ts:191
Get the photos from local storage

Returns Promise<IPhotos>

the source's photos

getPhotosKey

getPhotosKey(): string

Inherited from PhotoSource.getPhotosKey
- Defined in scripts/sources/photo_source.ts:157
Get the photos key that is persisted

Returns string

getUseKey

getUseKey(): UseKey

Inherited from PhotoSource.getUseKey
- Defined in scripts/sources/photo_source.ts:167
Get use key name

Returns UseKey

isDaily

isDaily(): boolean

Inherited from PhotoSource.isDaily
- Defined in scripts/sources/photo_source.ts:182
Get if we should update daily

Returns boolean

isLimited

isLimited(): boolean

Inherited from PhotoSource.isLimited
- Defined in scripts/sources/photo_source.ts:177
Get if we should limit updates when possible

Returns boolean

process

process(): Promise<undefined>

Inherited from PhotoSource.process
- Defined in scripts/sources/photo_source.ts:226
Process the photo source.

throws

An error if we failed to retrieve photos

Returns Promise<undefined>

use

use(): null | false | true

Inherited from PhotoSource.use
- Defined in scripts/sources/photo_source.ts:217
Determine if this source has been selected for display

Returns null | false | true

true if selected

Static addPhoto

addPhoto(photos: IPhoto[], url: string, author: string, asp: number, ex: any, point?: string): void

Inherited from PhotoSource.addPhoto
- Defined in scripts/sources/photo_source.ts:74
Add a IPhoto to an existing Array

Parameters
- photos: IPhoto[]
  
  The array to add to
- url: string
  
  The url to the photo
- author: string
  
  The photographer
- asp: number
  
  The aspect ratio of the photo
- ex: any
  
  Additional information about the photo
- Default value point: string = ""
  
  An optional geolocation
Returns void

Static createPoint

createPoint(lat: number, lon: number): string

Inherited from PhotoSource.createPoint
- Defined in scripts/sources/photo_source.ts:96
Create a geo point string from a latitude and longitude

Parameters
- lat: number
  
  latitude
- lon: number
  
  longitude
Returns string

'lat lon'

Static Private fetchAlbums

fetchAlbums(): Promise<ISelectedAlbum[]>

- Defined in scripts/sources/photo_source_google.ts:674
Fetch the most recent state for the selected albums

throws

An error if we could not load an album

Returns Promise<ISelectedAlbum[]>

Array of albums

Static Private getImageSize

getImageSize(mediaMetadata: IMediaMetaData): ISize

- Defined in scripts/sources/photo_source_google.ts:713
Get the image size to retrieve

Parameters
- mediaMetadata: IMediaMetaData
  
  info on image
Returns ISize

image size

Static isAuthRevokedError

isAuthRevokedError(err: Error, name: string): boolean

- Defined in scripts/sources/photo_source_google.ts:172
Has the Google auth token been revoked

Parameters
- err: Error
  
  Error to check
- name: string
  
  calling method
Returns boolean

Static Private isFetch

isFetch(): boolean

- Defined in scripts/sources/photo_source_google.ts:656
Return true if we should be fetching from Google: trying to minimize Google Photos API usage

Returns boolean

Static Private isImage

isImage(mediaItem: IMediaItem): string | false

- Defined in scripts/sources/photo_source_google.ts:699
Determine if a mediaEntry is an image

Parameters
- mediaItem: IMediaItem
  
  Google Photos media object
Returns string | false

true if entry is a photo

Static loadAlbum

loadAlbum(id: string, name: string, interactive?: boolean, notify?: boolean): Promise<IAlbum>

- Defined in scripts/sources/photo_source_google.ts:257
Retrieve a Google Photos album

throws

An error if the album failed to load.

Parameters
- id: string
  
  Unique Album ID
- name: string
  
  Album name
- Default value interactive: boolean = true
- Default value notify: boolean = false
Returns Promise<IAlbum>

An album

Static loadAlbumList

loadAlbumList(): Promise<IAlbum[]>

- Defined in scripts/sources/photo_source_google.ts:193
Retrieve the user's list of albums

throws

An error if the album list failed to load.

Returns Promise<IAlbum[]>

Array of albums

Static loadAlbums

loadAlbums(interactive?: boolean, notify?: boolean): Promise<ISelectedAlbum[]>

- Defined in scripts/sources/photo_source_google.ts:335
Reload the saved albums from the Web

throws

An error if the albums could not be updated

Parameters
- Default value interactive: boolean = false
- Default value notify: boolean = false
Returns Promise<ISelectedAlbum[]>

The array of album selections

Static loadFilteredPhotos

loadFilteredPhotos(force?: boolean, notify?: boolean): Promise<IPhoto[]>

- Defined in scripts/sources/photo_source_google.ts:395
Load photos based on a filter

throws

An error if we could not load the photos

Parameters
- Default value force: boolean = false
- Default value notify: boolean = false
Returns Promise<IPhoto[]>

The array of photos

Static loadPhotos

loadPhotos(ids: string[]): Promise<IPhoto[]>

- Defined in scripts/sources/photo_source_google.ts:481
Load the given array of unique photo id's from Google Photos

throws

An error if the photos failed to load

Parameters
- ids: string[]
  
  array of ids
Returns Promise<IPhoto[]>

An array of photos

Static Private processPhoto

processPhoto(mediaItem: IMediaItem, albumName: string): undefined | IPhoto

- Defined in scripts/sources/photo_source_google.ts:743
Get a photo from a mediaItem

Parameters
- mediaItem: IMediaItem
  
  object from Google Photos API call
- albumName: string
  
  Album name
Returns undefined | IPhoto

photo or undefined

Static Private processPhotos

processPhotos(mediaItems: IMediaItem[], albumName?: string): IPhoto[]

- Defined in scripts/sources/photo_source_google.ts:773
Extract the photos into an Array

Parameters
- mediaItems: IMediaItem[]
  
  objects from Google Photos API call
- Default value albumName: string = ""
  
  optional Album name
Returns IPhoto[]

An array of photos

Static Private updateAlbumsBaseUrls

updateAlbumsBaseUrls(photos: IPhoto[]): Promise<boolean>

- Defined in scripts/sources/photo_source_google.ts:574
Update the baseUrls of the given photos in the saved albums

throws

An error on failure

Parameters
- photos: IPhoto[]
  
  photos to update
Returns Promise<boolean>

false if couldn't persist albumSelections

Static updateBaseUrls

updateBaseUrls(photos: IPhoto[]): Promise<boolean>

- Defined in scripts/sources/photo_source_google.ts:546
Update the baseUrls of the given photos

throws

An error on failure

Parameters
- photos: IPhoto[]
  
  photos to update
Returns Promise<boolean>

false if couldn't persist albumSelections

Static Private updatePhotosBaseUrls

updatePhotosBaseUrls(photos: IPhoto[]): Promise<boolean>

- Defined in scripts/sources/photo_source_google.ts:620
Update the baseUrls of the given photos in the saved photos

throws

An error on failure

Parameters
- photos: IPhoto[]
  
  photos to update
Returns Promise<boolean>

false if couldn't persist googleImages

Generated using TypeDoc