flowground for Business Customers

Technical Specifications

startFlow

OnInit
./lib/triggers/startFlow.js
OnStartup
-
OnClose
-

Attributes

-

books_cloudloading_addBook

OnInit
./lib/actions/books_cloudloading_addBook.js
OnStartup
-
OnClose
-

Attributes

-

books_cloudloading_deleteBook

Remove the book and its contents

OnInit
./lib/actions/books_cloudloading_deleteBook.js
OnStartup
-
OnClose
-

Attributes

-

books_cloudloading_updateBook

OnInit
./lib/actions/books_cloudloading_updateBook.js
OnStartup
-
OnClose
-

Attributes

-

books_dictionary_listOfflineMetadata

Returns a list of offline dictionary metadata available

OnInit
./lib/actions/books_dictionary_listOfflineMetadata.js
OnStartup
-
OnClose
-

Attributes

-

books_familysharing_getFamilyInfo

Gets information regarding the family that the user is part of.

OnInit
./lib/actions/books_familysharing_getFamilyInfo.js
OnStartup
-
OnClose
-

Attributes

-

books_familysharing_share

Initiates sharing of the content with the user's family. Empty response indicates success.

OnInit
./lib/actions/books_familysharing_share.js
OnStartup
-
OnClose
-

Attributes

-

books_familysharing_unshare

Initiates revoking content that has already been shared with the user's family. Empty response indicates success.

OnInit
./lib/actions/books_familysharing_unshare.js
OnStartup
-
OnClose
-

Attributes

-

books_myconfig_getUserSettings

Gets the current settings for the user.

OnInit
./lib/actions/books_myconfig_getUserSettings.js
OnStartup
-
OnClose
-

Attributes

-

books_myconfig_releaseDownloadAccess

Release downloaded content access restriction.

OnInit
./lib/actions/books_myconfig_releaseDownloadAccess.js
OnStartup
-
OnClose
-

Attributes

-

books_myconfig_requestAccess

Request concurrent and download access restrictions.

OnInit
./lib/actions/books_myconfig_requestAccess.js
OnStartup
-
OnClose
-

Attributes

-

books_myconfig_syncVolumeLicenses

Request downloaded content access for specified volumes on the My eBooks shelf.

OnInit
./lib/actions/books_myconfig_syncVolumeLicenses.js
OnStartup
-
OnClose
-

Attributes

-

books_myconfig_updateUserSettings

Sets the settings for the user. If a sub-object is specified, it will overwrite the existing sub-object stored in the server. Unspecified sub-objects will retain the existing value.

OnInit
./lib/actions/books_myconfig_updateUserSettings.js
OnStartup
-
OnClose
-

Attributes

-

books_mylibrary_annotations_list

Retrieves a list of annotations, possibly filtered.

OnInit
./lib/actions/books_mylibrary_annotations_list.js
OnStartup
-
OnClose
-

Attributes

-

books_mylibrary_annotations_insert

Inserts a new annotation.

OnInit
./lib/actions/books_mylibrary_annotations_insert.js
OnStartup
-
OnClose
-

Attributes

-

books_mylibrary_annotations_summary

Gets the summary of specified layers.

OnInit
./lib/actions/books_mylibrary_annotations_summary.js
OnStartup
-
OnClose
-

Attributes

-

books_mylibrary_annotations_delete

Deletes an annotation.

OnInit
./lib/actions/books_mylibrary_annotations_delete.js
OnStartup
-
OnClose
-

Attributes

-

books_mylibrary_annotations_update

Updates an existing annotation.

OnInit
./lib/actions/books_mylibrary_annotations_update.js
OnStartup
-
OnClose
-

Attributes

-

books_mylibrary_bookshelves_list

Retrieves a list of bookshelves belonging to the authenticated user.

OnInit
./lib/actions/books_mylibrary_bookshelves_list.js
OnStartup
-
OnClose
-

Attributes

-

books_mylibrary_bookshelves_get

Retrieves metadata for a specific bookshelf belonging to the authenticated user.

OnInit
./lib/actions/books_mylibrary_bookshelves_get.js
OnStartup
-
OnClose
-

Attributes

-

books_mylibrary_bookshelves_addVolume

Adds a volume to a bookshelf.

OnInit
./lib/actions/books_mylibrary_bookshelves_addVolume.js
OnStartup
-
OnClose
-

Attributes

-

books_mylibrary_bookshelves_clearVolumes

Clears all volumes from a bookshelf.

OnInit
./lib/actions/books_mylibrary_bookshelves_clearVolumes.js
OnStartup
-
OnClose
-

Attributes

-

books_mylibrary_bookshelves_moveVolume

Moves a volume within a bookshelf.

OnInit
./lib/actions/books_mylibrary_bookshelves_moveVolume.js
OnStartup
-
OnClose
-

Attributes

-

books_mylibrary_bookshelves_removeVolume

Removes a volume from a bookshelf.

OnInit
./lib/actions/books_mylibrary_bookshelves_removeVolume.js
OnStartup
-
OnClose
-

Attributes

-

books_mylibrary_bookshelves_volumes_list

Gets volume information for volumes on a bookshelf.

OnInit
./lib/actions/books_mylibrary_bookshelves_volumes_list.js
OnStartup
-
OnClose
-

Attributes

-

books_mylibrary_readingpositions_get

Retrieves my reading position information for a volume.

OnInit
./lib/actions/books_mylibrary_readingpositions_get.js
OnStartup
-
OnClose
-

Attributes

-

books_mylibrary_readingpositions_setPosition

Sets my reading position information for a volume.

OnInit
./lib/actions/books_mylibrary_readingpositions_setPosition.js
OnStartup
-
OnClose
-

Attributes

-

books_notification_get

Returns notification details for a given notification id.

OnInit
./lib/actions/books_notification_get.js
OnStartup
-
OnClose
-

Attributes

-

books_onboarding_listCategories

List categories for onboarding experience.

OnInit
./lib/actions/books_onboarding_listCategories.js
OnStartup
-
OnClose
-

Attributes

-

books_onboarding_listCategoryVolumes

List available volumes under categories for onboarding experience.

OnInit
./lib/actions/books_onboarding_listCategoryVolumes.js
OnStartup
-
OnClose
-

Attributes

-

books_personalizedstream_get

Returns a stream of personalized book clusters

OnInit
./lib/actions/books_personalizedstream_get.js
OnStartup
-
OnClose
-

Attributes

-

books_promooffer_accept

OnInit
./lib/actions/books_promooffer_accept.js
OnStartup
-
OnClose
-

Attributes

-

books_promooffer_dismiss

OnInit
./lib/actions/books_promooffer_dismiss.js
OnStartup
-
OnClose
-

Attributes

-

books_promooffer_get

Returns a list of promo offers available to the user

OnInit
./lib/actions/books_promooffer_get.js
OnStartup
-
OnClose
-

Attributes

-

books_series_get

Returns Series metadata for the given series ids.

OnInit
./lib/actions/books_series_get.js
OnStartup
-
OnClose
-

Attributes

-

books_series_membership_get

Returns Series membership data given the series id.

OnInit
./lib/actions/books_series_membership_get.js
OnStartup
-
OnClose
-

Attributes

-

books_bookshelves_list

Retrieves a list of public bookshelves for the specified user.

OnInit
./lib/actions/books_bookshelves_list.js
OnStartup
-
OnClose
-

Attributes

-

books_bookshelves_get

Retrieves metadata for a specific bookshelf for the specified user.

OnInit
./lib/actions/books_bookshelves_get.js
OnStartup
-
OnClose
-

Attributes

-

books_bookshelves_volumes_list

Retrieves volumes in a specific bookshelf for the specified user.

OnInit
./lib/actions/books_bookshelves_volumes_list.js
OnStartup
-
OnClose
-

Attributes

-

books_volumes_list

Performs a book search.

OnInit
./lib/actions/books_volumes_list.js
OnStartup
-
OnClose
-

Attributes

-

books_volumes_mybooks_list

Return a list of books in My Library.

OnInit
./lib/actions/books_volumes_mybooks_list.js
OnStartup
-
OnClose
-

Attributes

-

books_volumes_recommended_list

Return a list of recommended books for the current user.

OnInit
./lib/actions/books_volumes_recommended_list.js
OnStartup
-
OnClose
-

Attributes

-

books_volumes_recommended_rate

Rate a recommended book for the current user.

OnInit
./lib/actions/books_volumes_recommended_rate.js
OnStartup
-
OnClose
-

Attributes

-

books_volumes_useruploaded_list

Return a list of books uploaded by the current user.

OnInit
./lib/actions/books_volumes_useruploaded_list.js
OnStartup
-
OnClose
-

Attributes

-

books_volumes_get

Gets volume information for a single volume.

OnInit
./lib/actions/books_volumes_get.js
OnStartup
-
OnClose
-

Attributes

-

books_volumes_associated_list

Return a list of associated books.

OnInit
./lib/actions/books_volumes_associated_list.js
OnStartup
-
OnClose
-

Attributes

-

books_layers_volumeAnnotations_list

Gets the volume annotations for a volume and layer.

OnInit
./lib/actions/books_layers_volumeAnnotations_list.js
OnStartup
-
OnClose
-

Attributes

-

books_layers_volumeAnnotations_get

Gets the volume annotation.

OnInit
./lib/actions/books_layers_volumeAnnotations_get.js
OnStartup
-
OnClose
-

Attributes

-

books_layers_annotationData_list

Gets the annotation data for a volume and layer.

OnInit
./lib/actions/books_layers_annotationData_list.js
OnStartup
-
OnClose
-

Attributes

-

books_layers_annotationData_get

Gets the annotation data.

OnInit
./lib/actions/books_layers_annotationData_get.js
OnStartup
-
OnClose
-

Attributes

-

books_layers_list

List the layer summaries for a volume.

OnInit
./lib/actions/books_layers_list.js
OnStartup
-
OnClose
-

Attributes

-

books_layers_get

Gets the layer summary for a volume.

OnInit
./lib/actions/books_layers_get.js
OnStartup
-
OnClose
-

Attributes

-

No data available for terms

OAUTH_CLIENT_ID

OAuth Client ID

type
-
required
-
example
-

OAUTH_CLIENT_SECRET

OAuth Client Secret

type
-
required
-
example
-