Progress will discontinue Telerik Platform on May 10th, 2018. Learn more

Everlive constructor

new Everlive(options)

Parameters

Parameter Name Type Default Description
options object / string An object containing configuration options for the Setup object. Alternatively, you can pass a string representing your App ID.
options.apiKey string Your API Key. Deprecated: use options.appId instead.
options.appId string Your Telerik Platform app's App ID.
[options.url] string //api.everlive.com/v1/ The Telerik Backend Services URL.
[options.token] string An authentication token. The instance will be associated with the provided previously obtained token.
[options.tokenType] string bearer The type of the token that is used for authentication.
[options.masterKey] string The master key of the Telerik Platform app. Use this authorization scheme for operations that require it or to override you app's access control. Use only for development purposes. Do not deploy it with your app.
[options.scheme] string http The URI scheme used to make requests. Supported values: http, https
[options.parseOnlyCompleteDateTimeObjects] boolean false If set to true, the SDK will parse only complete date strings (according to the ISO 8601 standard).
[options.emulatorMode] boolean false Set this option to true to set the SDK in emulator mode.
[options.offline] object / boolean Set this option to true to enable Offline Support using the default offline settings.
[options.offline.enabled] boolean false When using an object to initialize Offline Support with non-default settings, set this option to enable or disable Offline Support.
[options.offline.isOnline] boolean true Whether the storage is in online mode initially.
[options.offline.conflicts.strategy] ConflictResolutionStrategy / function ConflictResolutionStrategy.ClientWins A constant specifying the conflict resolution strategy or a function used to resolve the conflicts.
[options.offline.syncUnmodified] boolean false Whether to synchronize items updated or deleted on the server but not on the device.
[options.offline.storage] object An object specifying settings for the offline storage.
[options.offline.storage.provider] string platform dependant Allows you to select an offline storage provider. Possible values: Everlive.Constants.StorageProvider.LocalStorage, Everlive.Constants.StorageProvider.FileSystem, Everlive.Constants.StorageProvider.Custom. Default value: Cordova, Web: Everlive.Constants.StorageProvider.LocalStorage; NativeScript, Node.js: Everlive.Constants.StorageProvider.FileSystem.
[options.offline.storage.storagePath] string el_store A relative path specifying where data will be saved if the FileSystem provider is used.
[options.offline.storage.requestedQuota] number 10485760 How much memory (in bytes) to be requested when using FileSystem for persistence. This option is only valid for Chrome as the other platforms use all the available space.
[options.offline.storage.implementation] object When storage.provider is set to custom, use this object to specify your custom offline storage implementation.
[options.offline.encryption.key] string A key that will be used to encrypt the data stored offline.
[options.offline.files.storagePath] string el_file_store A relative path specifying where the files will be saved if file system is used for persistence of files in offline mode.
[options.offline.files.metaPath] string el_file_mapping A relative path specifying where the metadata file will be saved if file system is used for persistence of files in offline mode.
[options.offline.files] object / boolean Set this option to true to enable support for files in offline mode.
[options.offline.files.maxConcurrentDownloads] number The maximum amount of files that can be downloaded simultaneously.
[options.authentication.persist] boolean false Indicates whether the current user's authentication will be persisted.
[options.authentication.onAuthenticationRequired] function Invoked when the user's credentials have expired. Allowing you to perform custom logic.
[options.helpers] object An object holding options for all Everlive helper components.
[options.helpers.html] object HTML Helper configuration objects.
[options.helpers.html.processOnLoad] boolean false Whether to process all HTML elements when the window loads.
[options.helpers.html.processOnResize] boolean false Whether to process all HTML elements when the window resizes.
[options.helpers.html.loadingImageUrl] string The image to be displayed while the original image is being processed.
[options.helpers.html.errorImageUrl] string The image to be displayed when the original image processing fails.
[options.helpers.html.attributes] object HTML Helper attributes configuration object.
[options.helpers.html.attributes.loadingImage] object data-loading-image A custom name for the attribute to be used to set a loading image.
[options.helpers.html.attributes.errorImage] object data-error-image A custom name for the attribute to be used to set an error image.
[options.helpers.html.attributes.dpi] object data-dpi A custom name for the attribute to be used to specify DPI settings.
[options.helpers.html.attributes.imageSource] object data-src A custom name for the attribute to be used to set the image source.
[options.helpers.html.attributes.fileSource] object data-href A custom name for the attribute to be used to set the anchor source.
[options.helpers.html.attributes.enableOffline] object data-offline A custom name for the attribute to be used to control offline processing.
[options.helpers.html.attributes.enableResponsive] object data-responsive A custom name for the attribute to be used to control Responsive Images processing.
[options.caching] object / boolean false Set this option to true to enable caching using the default cache settings.
[options.caching.maxAge] number 60 Global setting for maximum age of cached items in minutes.
[options.caching.enabled] boolean false Global setting for enabling or disabling cache.
[options.caching.typeSettings] object Specify per-content-type settings that override the global settings.
Start a free trial Request a demo
Contact us: +1-888-365-2779
sales@telerik.com
Copyright © 2016-2017, Progress Software Corporation and/or its subsidiaries or affiliates. All rights reserved.