API method collection.deleteBackgroundImage

Deletes the background image of the specified collection.

Note: Requests must be made to https://api.flipsnack.com/v1.

If the request is successful, the API call returns information about the specified collection. Name Type Description collectionWidth number The embed width of the widget (measured in pixels). collectionHeight number The embed height of the widget (measured in pixels). collectionStatus string The type of collection. Possible values are public, editable and unlisted.

Public collections are listed on your public profile and in search results. They are publicly available to other users.

Editable collections are not published. They must be published manually from the Flipsnack editor or updated using the collection.update method.

Unlisted collections are published but not listed on your profile page and in search results. Other users may view them only if they receive a direct link or an embedded widget from you. enableDownload boolean If set to true, displays the download button in the flash widget menu. The menu is displayed only when the widget is in fullscreen. enableFullScreen boolean If set to true, allows the Flash widget to enter fullscreen mode: a "Click to read" button is displayed. enableSearch boolean If set to true, displays the search button in the flash widget menu. If there is no text to search within the current collection item, the search button is displayed as disabled. tooltipsLanguage string Selects the language for the tooltips displayed in the flash widget. Possible languages are: Basque, Bosanski, Català, Czech, Dansk, Deutsch, English, Español, כשר, Française, ελληνικά, Hrvatski, Indonesian, Italiano, Magyar, Nederlands, Nederlands, Norsk, Polski, Português, Português do Brasil, Română, Pусский, Cрпски, Slovene, Suomi, Slovak, Swedish, Turkish. transparentBackground boolean If set to true, the widget is displayed with no background. When embedding Flash widgets, make sure that the wmode parameter of the embed tag is set to 'transparent'. backgroundColor string The background color of the widget, specified as a hexadecimal value. If the transparentBackground is set to true, the widget will ignore the backgroundColor parameter. backgroundScaleType string The scale mode of images used as background for the widget. Possible values are scaleCrop, center and tile. Background images can be set using the collection.setBackgroundImage method. autoFlip boolean If set to true, allows the widget to automatically turn the pages of the flipbook. The pages turn after a time specified by the autoFlipDelay parameter. autoFlipDelay number Specifies the time in seconds for pages to turn automatically. If autoFlip is false, this parameter is ignored. rightToLeftOrientation boolean If set to true, allows the flipbook to be viewed from right to left: the first page is starts from the end as viewed in normal mode. This option is useful for documents written in right to left languages. singlePageView boolean If set to true, allows the flipbook to be viewed a single page at a time. logoUrl string The URL of the logo image. A logo image can be set only by uploading it with the collection.setLogo method. shareFacebook boolean If set to true, the Flash widget displays a Facebook sharing option in the widget menu, in fullscreen mode. shareTwitter boolean If set to true, the Flash widget displays a Twitter sharing option in the widget menu, in fullscreen mode. shareGooglePlus boolean If set to true, the Flash widget displays a Google+ sharing option in the widget menu, in fullscreen mode. sharePinterest boolean If set to true, the Flash widget displays a Pinterest sharing option in the widget menu, in fullscreen mode. shareEmail boolean If set to true, the Flash widget displays an email sharing option in the widget menu, in fullscreen mode. shareLinkText string The link opened from the link sharing option, within the widget. By default, this link is the direct link of the collection.

.