C# Class Bloom.Api.BrandingApi

Supports branding (e.g. logos) needed by projects

Show file Open project: BloomBooks/BloomDesktop

Public Methods

Method	Description
BrandingApi ( CollectionSettings collectionSettings ) : System
GetSettings ( string brandingNameOrFolderPath ) : Settings	branding folders can optionally contain a settings.json file which aligns with this Settings class
RegisterWithServer ( EnhancedImageServer server ) : void

Method Details

BrandingApi() public method

public BrandingApi ( CollectionSettings collectionSettings ) : System
collectionSettings	Bloom.Collection.CollectionSettings
return	System

GetSettings() public static method

branding folders can optionally contain a settings.json file which aligns with this Settings class

public static GetSettings ( string brandingNameOrFolderPath ) : Settings
brandingNameOrFolderPath	string	Normally, the branding is just a name, which we look up in the official branding folder //but unit tests can instead provide a path to the folder. ///
return	Settings

RegisterWithServer() public method

public RegisterWithServer ( EnhancedImageServer server ) : void
server	EnhancedImageServer
return	void