JavaScript SDK Overview

This page lists all classes of the Telerik Backend Services JavaScript SDK and their members. Follow the respective links to find more details.

AggregateQuery [class]

AggregateQuery instance members

Name Return type Description
avg(field, [resultFieldName]) AggregateQuery Adds aggregation function 'avg' (average) to the current query. Could set [resultFieldName]
count(field, [resultFieldName]) AggregateQuery Adds aggregation function 'count' to the current query. Could set [resultFieldName]
groupBy(field, array) AggregateQuery Applies a groupBy to the current query. This allows you to group results by
max(field, [resultFieldName]) AggregateQuery Adds aggregation function 'max' to the current query. Could set [resultFieldName]
min(field, [resultFieldName]) AggregateQuery Adds aggregation function 'min' to the current query. Could set [resultFieldName]
sum(field, [resultFieldName]) AggregateQuery Adds aggregation function 'sum' to the current query. Could set [resultFieldName]

Authentication [class]

new Everlive.Authentication(el, setup)

Authentication instance members

Name Return type Description
clearAuthorization() Clears the authentication token that the Backend Services JavaScript SDK currently uses. Note that this is different than logging out, because the authorization token that was used, will not be invalidated.
clearPersistedAuthentication() Clears the current persisted authentication from the local store for the current Backend Services JavaScript SDK instance. Will not logout or modify the current authentication of the Javascript SDK.
getAuthenticationStatus([success], [error]) Gets the current authentication status of the Telerik Backend Services JavaScript SDK instance.
getAuthenticationStatus() Promise Gets the current authentication status of the Telerik Backend Services JavaScript SDK instance.
login(username, password) Promise Logs in a user using a username and a password to the current Backend Services JavaScript SDK instance. All requests initiated by the current Backend Services JavaScript SDK instance will be authenticated with that user's credentials.
login(username, password, [success], [error]) Logs in a user using a username and a password to the current Backend Services JavaScript SDK instance. All requests initiated by the current Backend Services JavaScript SDK instance will be authenticated with that user's credentials.
loginWithADFS(accessToken) Promise Log in a user using an ADFS access token.
loginWithADFS(accessToken, [success], [error]) Log in a user using an ADFS access token.
loginWithFacebook(accessToken, [success], [error]) Log in a user using an Facebook access token.
loginWithFacebook(accessToken) Promise Log in a user using an Facebook access token.
loginWithGoogle(accessToken) Promise Log in a user using a Google access token.
loginWithGoogle(accessToken, [success], [error]) Log in a user using a Google access token.
loginWithLiveID(accessToken) Promise Log in a user using a LiveID access token.
loginWithLiveID(accessToken, [success], [error]) Log in a user using a LiveID access token.
loginWithTwitter(token, tokenSecret, [success], [error]) Log in a user with a Twitter token. A secret token needs to be provided.
loginWithTwitter(token, tokenSecret) Promise Log in a user with a Twitter token. A secret token needs to be provided.
logout([success], [error]) Log out the user who is currently logged in.
logout() Promise Log out the user who is currently logged in.
setAuthorization(token, tokenType, principalId) Sets the token and token type that the Telerik Backend Services JavaScript SDK will use for authorization.

BasePersister [class]

BasePersister static members

Name Return type Description
getAllData(success, error) Object Gets all the saved data.
getData(contentType, success, error) string Returns the saved data for a specific content type.
purge(contentType, success, error) Clears the persisted data for a specific content type.
purgeAll(success, error) Clears all persisted data in the offline store.
saveData(contentType, data, success, error) Saves data for a specific content type.

BusinessLogic [class]

new Everlive.BusinessLogic(setup)

BusinessLogic instance members

Name Return type Description
invokeCloudFunction(funcName, params) Promise Invokes a Cloud Function from the app's Business Logic layer.
invokeCloudFunction(funcName, params, success, error) Invokes a Cloud Function from the app's Business Logic layer.
invokeStoredProcedure(funcName, funcParams) Promise Invokes a Stored Procedure from the app's Business Logic layer.
invokeStoredProcedure(funcName, funcParams, success, error) Invokes a Stored Procedure from the app's Business Logic layer.

CacheModule [class]

CacheModule instance members

Name Return type Description
clear(contentType, [success], [error]) Clears the cached data for a specified content type.
clear(contentType) Promise Clears the cached data for a specified content type.
clearAll([success], [error]) Clears all data from the cache.
clearAll() Promise Clears all data from the cache.

CurrentDevice [class]

Deprecated

new Everlive.CurrentDevice(pushHandler)####new Everlive.CurrentDevice(pushHandler)

CurrentDevice instance members

Name Return type Description
disableNotifications([success], [error]) Disables push notifications for the current device. This method invalidates any push tokens that were obtained for the device from the current application.
disableNotifications() Object Disables push notifications for the current device. This method invalidates any push tokens that were obtained for the device from the current application.
disableNotifications() Object Disables push notifications for the current device. This method invalidates any push tokens that were obtained for the device from the current application.
disableNotifications([success], [error]) Disables push notifications for the current device. This method invalidates any push tokens that were obtained for the device from the current application.
enableNotifications(pushSettings, [success], [error]) Initializes the current device for push notifications. This method requests a push token from the device vendor and enables the push notification functionality on the device. Once this is done, you can register the device in Everlive using the register() method.
enableNotifications(pushSettings, [success], [error]) Initializes the current device for push notifications. This method requests a push token from the device vendor and enables the push notification functionality on the device. Once this is done, you can register the device in Everlive using the register() method.
enableNotifications(pushSettings) Object Initializes the current device for push notifications. This method requests a push token from the device vendor and enables the push notification functionality on the device. Once this is done, you can register the device in Telerik Backend Services using the register() method.
enableNotifications(pushSettings) Object Initializes the current device for push notifications. This method requests a push token from the device vendor and enables the push notification functionality on the device. Once this is done, you can register the device in Telerik Backend Services using the register() method.
getRegistration(success, error) Returns the push registration for the current device.
getRegistration() Object Returns the push registration for the current device.
getRegistration(success, error) Returns the push registration for the current device.
getRegistration() Object Returns the push registration for the current device.
register(customParameters) Object Registers the current device for push notifications in Telerik Backend Services. This method can be called only after enableNotifications() has completed successfully.
register(customParameters, [success], [error]) Registers the current device for push notifications in Telerik Backend Services. This method can be called only after enableNotifications() has completed successfully.
register(customParameters, [success], [error]) Registers the current device for push notifications in Telerik Backend Services. This method can be called only after enableNotifications() has completed successfully.
register(customParameters) Object Registers the current device for push notifications in Telerik Backend Services. This method can be called only after enableNotifications() has completed successfully.
unregister() Object Unregisters the current device from push notifications in Telerik Backend Services. After this call completes successfully, Backend Services will no longer send notifications to this device. Note that this does not prevent the device from receiving notifications and does not invalidate push tokens.
unregister() Object Unregisters the current device from push notifications in Telerik Backend Services. After this call completes successfully, Backend Services will no longer send notifications to this device. Note that this does not prevent the device from receiving notifications and does not invalidate push tokens.
unregister([success], [error]) Unregisters the current device from push notifications in Telerik Backend Services. After this call completes successfully, Backend Services will no longer send notifications to this device. Note that this does not prevent the device from receiving notifications and does not invalidate push tokens.
unregister([success], [error]) Unregisters the current device from push notifications in Telerik Backend Services. After this call completes successfully, Backend Services will no longer send notifications to this device. Note that this does not prevent the device from receiving notifications and does not invalidate push tokens.
updateRegistration(customParameters) Object Updates the registration of the current device.
updateRegistration(customParameters, [success], [error]) Updates the registration for the current device.
updateRegistration(customParameters, [success], [error]) Updates the registration for the current device.
updateRegistration(customParameters) Object Updates the registration of the current device.

CurrentDevice [class]

Deprecated

new Everlive.CurrentDevice(pushHandler)####new Everlive.CurrentDevice(pushHandler)

CurrentDevice instance members

Name Return type Description
disableNotifications([success], [error]) Disables push notifications for the current device. This method invalidates any push tokens that were obtained for the device from the current application.
disableNotifications() Object Disables push notifications for the current device. This method invalidates any push tokens that were obtained for the device from the current application.
disableNotifications() Object Disables push notifications for the current device. This method invalidates any push tokens that were obtained for the device from the current application.
disableNotifications([success], [error]) Disables push notifications for the current device. This method invalidates any push tokens that were obtained for the device from the current application.
enableNotifications(pushSettings, [success], [error]) Initializes the current device for push notifications. This method requests a push token from the device vendor and enables the push notification functionality on the device. Once this is done, you can register the device in Everlive using the register() method.
enableNotifications(pushSettings, [success], [error]) Initializes the current device for push notifications. This method requests a push token from the device vendor and enables the push notification functionality on the device. Once this is done, you can register the device in Everlive using the register() method.
enableNotifications(pushSettings) Object Initializes the current device for push notifications. This method requests a push token from the device vendor and enables the push notification functionality on the device. Once this is done, you can register the device in Telerik Backend Services using the register() method.
enableNotifications(pushSettings) Object Initializes the current device for push notifications. This method requests a push token from the device vendor and enables the push notification functionality on the device. Once this is done, you can register the device in Telerik Backend Services using the register() method.
getRegistration(success, error) Returns the push registration for the current device.
getRegistration() Object Returns the push registration for the current device.
getRegistration(success, error) Returns the push registration for the current device.
getRegistration() Object Returns the push registration for the current device.
register(customParameters) Object Registers the current device for push notifications in Telerik Backend Services. This method can be called only after enableNotifications() has completed successfully.
register(customParameters, [success], [error]) Registers the current device for push notifications in Telerik Backend Services. This method can be called only after enableNotifications() has completed successfully.
register(customParameters, [success], [error]) Registers the current device for push notifications in Telerik Backend Services. This method can be called only after enableNotifications() has completed successfully.
register(customParameters) Object Registers the current device for push notifications in Telerik Backend Services. This method can be called only after enableNotifications() has completed successfully.
unregister() Object Unregisters the current device from push notifications in Telerik Backend Services. After this call completes successfully, Backend Services will no longer send notifications to this device. Note that this does not prevent the device from receiving notifications and does not invalidate push tokens.
unregister() Object Unregisters the current device from push notifications in Telerik Backend Services. After this call completes successfully, Backend Services will no longer send notifications to this device. Note that this does not prevent the device from receiving notifications and does not invalidate push tokens.
unregister([success], [error]) Unregisters the current device from push notifications in Telerik Backend Services. After this call completes successfully, Backend Services will no longer send notifications to this device. Note that this does not prevent the device from receiving notifications and does not invalidate push tokens.
unregister([success], [error]) Unregisters the current device from push notifications in Telerik Backend Services. After this call completes successfully, Backend Services will no longer send notifications to this device. Note that this does not prevent the device from receiving notifications and does not invalidate push tokens.
updateRegistration(customParameters) Object Updates the registration of the current device.
updateRegistration(customParameters, [success], [error]) Updates the registration for the current device.
updateRegistration(customParameters, [success], [error]) Updates the registration for the current device.
updateRegistration(customParameters) Object Updates the registration of the current device.

Data [class]

new Everlive.Data(setup, collectionName)

Data instance members

Name Return type Description
aggregate(GroupBy, [success], [error]) A fluent API aggregation / grouping data from server. Can accept aggregationExpression or fluent chaining rules.
aggregate(GroupBy) Promise A fluent API aggregation / grouping data from server. Can accept aggregationExpression or fluent chaining rules.
applyOffline(applyOffline) Data Modifies whether the query should be applied offline, if the sdk is currenty working online.
Default is true.
Only valid when offlineStorage is enabled.
count(filter) Promise Gets the count of the data items that match the filter.
count(filter, [success], [error]) Gets the count of the items that match the filter.
create(data) Promise Creates a data item.
create(data, [success], [error]) Creates an item.
destroy(filter) Promise Deletes all data items that match a filter.
destroy(filter, [success], [error]) Deletes all items that match the filter.
destroySingle(model, [success], [error]) Deletes a single data item by ID.
destroySingle(itemId, [success], [error]) Deletes a single data item by ID.
destroySingle(item) Promise Deletes a single data item by ID.
destroySingle(itemId) Promise Deletes a single data item by ID.
expand(expandExpression) Data Sets an expand expression to be used in the data request. This allows you to retrieve complex data sets using a single query based on relations between data types.
forceCache() Data Forces the request to get the data from the cache even if the data is already expired.
Only valid when caching is enabled.
get(filter) Promise Gets all data items that match the filter. This allows you to retrieve a subset of the items based on various filtering criteria.
get(filter, [success], [error]) Gets all data items that match the filter. This allows you to retrieve a subset of the items based on various filtering criteria.
getById(id) Promise Gets a data item by ID.
getById(id, [success], [error]) Gets an item by ID.
ignoreCache() Data Does not use the cache when retrieving the data.
Only valid when caching is enabled.
isNew(model) boolean Checks if the specified data item is new or not.
maxAge(maxAgeInMinutes) Data Sets cache expiration specifically for the current query.
Only valid when caching is enabled.
rawUpdate(updateObject, id, [success], [error]) Updates an object by ID with the specified update expression.
rawUpdate(updateObject, filter) Promise Updates all objects that match a filter with the specified update expression.
rawUpdate(updateObject, filter, [success], [error]) Updates all objects that match a filter with the specified update expression.
rawUpdate(updatedObject, id) Promise Updates an object by ID with the specified update expression.
save(model, [success], [error]) Saves the provided data item. This operation will create or update the item depending on whether it is new or existing.
save(item) Promise Saves the provided data item. This operation will create or update the item depending on whether it is new or existing.
setAcl(acl, id, [success], [error]) Sets the Access Control List (ACL) of an item with a specified ID.
setAcl(acl, id) Promise Sets the Access Control List (ACL) of a specified data item.
setAcl(acl, item) Promise Sets the Access Control List (ACL) of a specified data item.
setAcl(acl, item, operationParameters, [success], [error]) Sets the Access Control List (ACL) of a specified data item.
setOwner(ownerId, id) Promise Sets the owner of the specified data item.
setOwner(ownerId, id, [success], [error]) Sets the owner of the specified data item.
setOwner(acl, item) Promise Sets the owner of the specified data item.
setOwner(acl, item, operationParameters) Sets the owner of the specified data item.
skipAuth(skipAuth) Data Modifies whether the query should try to authenticate if the security token has expired.
Default is false.
Only valid when the authentication module has an onAuthenticationRequired function.
update(updateObject, filter) Promise Updates all items that match a filter with the specified update object.
update(model, filter, [success], [error]) Updates all items that match the filter with the specified update object.
updateSingle(model, [success], [error]) Updates the provided item.
updateSingle(item) Promise Updates a single data item. This operation takes an object that specifies both the data item to be updated and the updated values.
useOffline([useOffline]) Data Modifies whether the query should be invoked on the offline storage.
withHeaders(headers) Data Sets additional non-standard HTTP headers in the current data request. See List of Request Parameters for more information.

EventQuery [class]

EventQuery instance members

Name Return type Description
cancel() Cancels the query.
contentTypeName The name of the content type, e.g. EmailSubcrbers.
data The query data which will be send to the server.
expand An expand expression definition.
fields A fields expression definition.
filter A filter expression definition.
headers The query headers which will be send with the HTTP request.
isCanceled() boolean Indicates whether the query has been canceled.
isSync Indicates whether the query is a synchronization query. Used with Offline Support.
itemId The Id of the item.
operation The type of the operation--read, write, update, delete.
powerfields A power fields expression.
settings A custom settings object.
settings An object allowing to modify the settings of the EventQuery.
skip The number of result items to skip. Used for paging.
sort A sort expression definition.
take The number of result items to take. Used for paging.

Everlive [class]

new Everlive(options)

Everlive instance members

Name Return type Description
Files An instance of the Files class for working with files.
Users An instance of the Users class for working with users.
addListener(eventName, eventListener) Adds an event listener to the SDK.
authInfo() Promise Gets the current authentication status of the Telerik Backend Services JavaScript SDK instance.
authInfo([success], [error]) Gets the current authentication status of the Telerik Backend Services JavaScript SDK instance.
authentication An instance of the Authentication class for working with the authentication of the SDK.
authentication An instance of the Authentication class for working with the authentication of the SDK.
buildAuthHeader() Object Generates the Authorization headers that are used by the Telerik Backend Services (Everlive) JavaScript SDK to make requests to the Backend Services servers.
buildUrl() string Returns the URL to the Backend Services application endpoint that the SDK uses.
businessLogic An instance of the BusinessLogic class for invoking cloud functions and stored procedures through the SDK
cache Represents the CacheModule class.
files An instance of the Files class for working with files.
getHierarchicalDataSource(typeName, dataSourceOptions) HierarchicalDataSource Get a Kendo UI HierarchicalDataSource that is attached to the current instance of the SDK with default options.
getKendoDataSource(typeName, [options]) DataSource Get a Kendo UI DataSource that is attached to the current instance of the SDK with default options.
isOffline() boolean Check if the SDK is in offline mode.
isOnline() boolean Check if the SDK is in online mode.
off(eventListener) Removes an SDK event listener.
offline([isOffline]) Sets the SDK to work in offline mode.
offlineStorage Represents the OfflineModule class.
on(eventName, eventListener) Adds an event listener to the SDK.
once(eventName, eventListener) Adds an event listener to the SDK which will be called only the first time the event is emitted.
online([isOnline]) Sets the SDK to work in online mode.
push An instance of the Push class for working with push notifications.
removeAllListeners() Removes all SDK event listeners.
removeListener(eventName, eventListener) Removes an SDK event listener.
request(options) function Make a request to the current Backend Services JavaScript SDK instance.
sync() Starts the synchronization procedure. Emits the 'syncStart' event when started and the 'syncEnd' event when the procedure finishes. 'syncEnd' contains information about the completed sync operation that you can use to find out how many items were synchronized.
users An instance of the Users class for working with users.

Everlive static members

Name Return type Description
$ Reference to the current Telerik Backend Services (Everlive) JavaScript SDK.
AuthStatus A class used to represent the current authentication status of the Telerik Backend Services JavaScript SDK instance.
Callbacks Defines callback functions used throughout the SDK.
ResultTypes Defines result types returned by functions throughout the SDK.

FileSystemPersister [class]

Files [class]

Files instance members

Name Return type Description
download(fileToDownload, pathOnDevice, [options], [trustAllHosts]) Promise Downloads a file to the device's file system. Wraps the Apache Cordova "download()" FileTransfer method. Note that the signatures of these methods differ.
download(fileToDownload, pathOnDevice, [options], [trustAllHosts], [success], [error]) Downloads a file to the device's file system. Wraps the Apache Cordova "download()" FileTransfer method. Note that the signatures of these methods differ.
getDownloadUrl(fileId) string Get the download URL for a file.
getDownloadUrlById(fileId) Promise Gets the download URL for a file by ID.
getDownloadUrlById(fileId, [success], [error]) Gets the download URL for a file by ID.
getUpdateUrl(fileId) string Get a URL that can be used as an endpoint for updating a file. It is specific to each Telerik Backend Services app.
getUploadUrl() string Get a URL that can be used as an endpoint for uploading a file. It is specific to each Telerik Backend Services app.
updateContent(fileId, file, [success], [error]) Promise Updates a file's content
upload(fileToUpload, [options], [trustAllHosts]) Promise Uploads a file from the device's file system to Backend Services. Wraps the Apache Cordova "upload()" FileTransfer method. Note that the signatures of these methods differ.
upload(fileToUpload, [options], [trustAllHosts], [success], [error]) Uploads a file from the device's file system to Backend Services. Wraps the Apache Cordova "upload()" FileTransfer method. Note that the signatures of these methods differ.

GeoPoint [class]

new Everlive.GeoPoint(longitude, latitude)

Helpers [class]

Helpers static members

Name Return type Description
html Everlive helper for html related operations, such as processing html elements with specific tags.

LocalStoragePersister [class]

OfflineFilesModule [class]

OfflineFilesModule instance members

Name Return type Description
downloadOffline(location, overwrite, [success], [error]) Updates a file's content.
downloadOffline(location, overwrite) Promise Updates a file's content.
exists(location, [success], [error]) Checks if a file exists offline.
exists(location) Promise Checks if a file exists offline.
getOfflineLocation(location, [success], [error]) Gets the native URL for a file that is stored offline.
getOfflineLocation(location) Promise Gets the native URL for a file that is stored offline.
purge(location, [success], [error]) Physically deletes the offline copy of a file.
purge(location) Promise Physically deletes the offline copy of a file.
purgeAll([success], [error]) Physically deletes the offline copies of all files.
purgeAll() Promise Physically deletes the offline copies of all files.

OfflineModule [class]

OfflineModule instance members

Name Return type Description
files An instance of the OfflineFilesModule class for working with files in offline mode.
getItemsForSync() Promise Get all the offline items that have not been synced online.
getItemsForSync([success], [error]) Get all the offline items that have not been synced online.
purge(contentType) Promise Removes all data for a specific content type from the offline storage. If caching is enabled clears the cache
for the specified content type as well.
purge(contentType, [success], [error]) Removes all data for a specific content type from the offline storage. If caching is enabled clears the cache
for the specified content type as well.
purgeAll() Promise Removes all data from the offline storage. If caching is enabled clears the entire cache as well.
purgeAll([success], [error]) Removes all data from the offline storage. If caching is enabled clears the entire cache as well.

Push [class]

new Everlive.Push(el)

Push instance members

Name Return type Description
areNotificationsEnabled(options) Promise This method provides a different operation on each supported platform:

- On iOS: Checks if Notifications is enabled for this application in the device's Notification Center.
- On Windows Phone: Checks if the application has an active open channel for communication with the Microsoft Push Notification Service. The outcome does not depend on the device's notification settings.
- On Android: Checks if the application has established a connection with Google Cloud Messaging. The outcome does not depend on the device's notification settings.
areNotificationsEnabled(options, [onSuccess], [onError]) iOS: Checks if the Notifications are enabled for this Application in the Device's Notification Center.
Windows Phone: Checks if the Application has an active opened Channel for communication with the Notification Service. Not relying on the device notification settings.
Android: Checks if the Application has established connection with the Notification Service. Not relying on the device notification settings.
areNotificationsEnabled(options) Promise This method provides a different operation on each supported platform:

- On iOS: Checks if Notifications is enabled for this application in the device's Notification Center.
- On Windows Phone: Checks if the application has an active open channel for communication with the Microsoft Push Notification Service. The outcome does not depend on the device's notification settings.
- On Android: Checks if the application has established a connection with Google Cloud Messaging. The outcome does not depend on the device's notification settings.
areNotificationsEnabled(options, [onSuccess], [onError]) iOS: Checks if the Notifications are enabled for this Application in the Device's Notification Center.
Windows Phone: Checks if the Application has an active opened Channel for communication with the Notification Service. Not relying on the device notification settings.
Android: Checks if the Application has established connection with the Notification Service. Not relying on the device notification settings.
areNotificationsEnabled(options) Promise This method provides a different operation on each supported platform:

- On iOS: Checks if Notifications is enabled for this application in the device's Notification Center.
- On Windows Phone: Checks if the application has an active open channel for communication with the Microsoft Push Notification Service. The outcome does not depend on the device's notification settings.
- On Android: Checks if the application has established a connection with Google Cloud Messaging. The outcome does not depend on the device's notification settings.
areNotificationsEnabled(options, [onSuccess], [onError]) iOS: Checks if the Notifications are enabled for this Application in the Device's Notification Center.
Windows Phone: Checks if the Application has an active opened Channel for communication with the Notification Service. Not relying on the device notification settings.
Android: Checks if the Application has established connection with the Notification Service. Not relying on the device notification settings.
clearBadgeNumber() Promise Resets the badge number on the Telerik Backend Services server to 0.
clearBadgeNumber([onSuccess], [onError]) Clears the badge number on the server by setting it to 0
currentDevice([emulatorMode]) CurrentDevice Returns the current device for sending push notifications
ensurePushIsAvailable() Ensures that the Telerik Push Notifications plug-in has been loaded and is ready to use. An {EverliveError} is returned if the plug-in is not available.
getRegistration() Promise Returns the push notifications registration for the current device.
getRegistration([onSuccess], [onError]) Returns the push registration for the current device.
notificationProcessed() Use this method in case you are working with iOS interactive push notifications in background mode, including TextInput, or iOS silent push notifications
Call it once you are done with processing your push notification in notificationCallbackIOS.
notificationProcessed() Currently available only for iOS
Use this method in case you are working with iOS interactive push notifications in background mode, including TextInput, or iOS silent push notifications
Call it once you are done with processing your push notification in notificationCallbackIOS.
notificationProcessed() Currently available only for iOS
Use this method in case you are working with iOS interactive push notifications in background mode, including TextInput, or iOS silent push notifications
Call it once you are done with processing your push notification in notificationCallbackIOS.
notificationProcessed() Currently available only for iOS
Use this method in case you are working with iOS interactive push notifications in background mode, including TextInput, or iOS silent push notifications
Call it once you are done with processing your push notification in notificationCallbackIOS.
register(settings) Promise Enables push notifications on the device and registers it for the feature with Telerik Backend Services if it hasn't already been registered. If it has been registered, the registration details are updated.
register(settings, [success], [error]) Enables push notifications on the device and registers it for the feature with Telerik Backend Services if it hasn't already been registered. If it has been registered, the registration details are updated.
Telerik Backend Services if it hasn't already been registered.
If it was registered the registration details are updated.
send(notification) Promise Sends a push notification.
send(notification, [onSuccess], [onError]) Sends a push message
setBadgeNumber(badge, [onSuccess], [onError]) Sets the badge number on the server
setBadgeNumber(badge) Promise Sets the badge number on the Telerik Backend Services server.
unregister() Promise Disables push notifications for the current device. This method invalidates any push tokens that were obtained for the device from the current application. The device will also be unregistered from Telerik Backend Services.
unregister([onSuccess], [onError]) Disables push notifications for the current device. This method invalidates any push tokens that were obtained for the device from the current application. The device will also be unregistered from Telerik Backend Services.
This method invalidates any push tokens that were obtained for the device from the current application.
The device will also be unregistered from Telerik Backend Services.
updateRegistration(customParameters, [onSuccess], [onError]) Updates the registration for the current device.
updateRegistration(customParameters) Promise Updates the registration of the current device.

Query [class]

new Everlive.Query([filter], [fields], [sort], [skip], [take], [expand])

Query instance members

Name Return type Description
build() Object Builds an object containing the different expressions that will be sent to Telerik Backend Services. It basically translates any previously specified expressions into standard queries that Backend Services can understand.
expand(expandExpression) Query Sets an expand expression for the current query. This allows you to retrieve complex data sets using a single query based on relations between data types.
order(field) Query Sorts the items in the current query in ascending order by the specified field.
orderDesc(field) Query Sorts the items in the current query in descending order by the specified field.
select(fieldsExpression) Query Applies a fields selection to the current query. This allows you to retrieve only a subset of all available item fields.
skip(value) Query Skips a certain number of items from the beginning before returning the rest of the items. Used for paging.
take(value) Query Takes a specified number of items from the query result. Used for paging.
where() WhereQuery Defines a filter definition for the current query.
where(filter) Query Applies a filter to the current query. This allows you to retrieve only a subset of the items based on various filtering criteria.

Users [class]

Users instance members

Name Return type Description
changePassword(username, password, newPassword, keepTokens) Promise Changes the password of a user.
changePassword(username, password, newPassword, keepTokens, [success], [error]) Changes the password of a user.
clearAuthorization() Clears the authentication token that the Backend Services JavaScript SDK currently uses. Note that this is different than logging out, because the current authorization token is not invalidated.
currentUser([success], [error]) Gets information about the user that is currently authenticated to the Backend Services JavaScript SDK. The success function is called with currentUserResult.
currentUser() Promise Gets information about the user that is currently authenticated to the Backend Services JavaScript SDK. The success function is called with currentUserResult.
linkWithADFS(userId, accessToken, [success], [error]) Links a Telerik Backend Services user account to an ADFS access token.
linkWithADFS(userId, accessToken) Promise Links a Telerik Backend Services user account to an ADFS access token.
linkWithFacebook(userId, accessToken, [success], [error]) Links a Backend Services user with a Facebook access token.
linkWithFacebook(userId, accessToken) Promise Links a Telerik Backend Services user account to a Facebook access token.
linkWithGoogle(userId, accessToken, [success], [error]) Links a Telerik Backend Services user account to a Google access token.
linkWithGoogle(userId, accessToken) Promise Links a Telerik Backend Services user account to a Google access token.
linkWithLiveID(userId, accessToken) Promise Links a Telerik Backend Services user account to a Microsoft Account access token.
linkWithLiveID(userId, accessToken, [success], [error]) Links a Telerik Backend Services user account to a Microsoft Account access token.
linkWithTwitter(userId, token, tokenSecret, [success], [error]) Links a Telerik Backend Services user to a Twitter token. A secret token needs to be provided. * Links a Backend Services user with a Twitter token. A secret token needs to be provided.
linkWithTwitter(userId, token, tokenSecret) Promise Links a Telerik Backend Services user to a Twitter token. A secret token needs to be provided.
login(username, password) Promise Logs in a user using a username and a password to the current Backend Services JavaScript SDK instance. All requests initiated by the current Backend Services JavaScript SDK instance will be authenticated with that user's credentials.
login(username, password, [success], [error]) Logs in a user using a username and a password to the current Backend Services JavaScript SDK instance. All requests initiated by the current Backend Services JavaScript SDK instance will be authenticated with that user's credentials.
loginWithADFS(accessToken) Promise Log in a user using an ADFS access token.
loginWithADFS(accessToken, [success], [error]) Log in a user using an ADFS access token.
loginWithFacebook(accessToken, [success], [error]) Log in a user using an Facebook access token.
loginWithFacebook(accessToken) Promise Log in a user using an Facebook access token.
loginWithGoogle(accessToken) Promise Log in a user using a Google access token.
loginWithGoogle(accessToken, [success], [error]) Log in a user using a Google access token.
loginWithLiveID(accessToken, [success], [error]) Log in a user using a Microsoft Account access token.
loginWithLiveID(accessToken) Promise Log in a user using a Microsoft Account access token.
loginWithTwitter(token, tokenSecret, [success], [error]) Log in a user with a Twitter token. A secret token needs to be provided.
loginWithTwitter(token, tokenSecret) Promise Log in a user with a Twitter token. A secret token needs to be provided.
logout() Promise Log out the user who is currently logged in.
logout([success], [error]) Log out the user who is currently logged in.
register(username, password, userInfo) Promise Registers a new user with username and password.
register(username, password, attrs, [success], [error]) Registers a new user using a username and a password.
resetPassword(user, [success], [error]) Sends a password reset email to a specified user.
resetPassword(user) Promise Sends a password reset email to a specified user.
setAuthorization(token, tokenType, principalId) Sets the token and token type that the Telerik Backend Services JavaScript SDK will use for authorization.
setPassword(setPasswordObject, [success], [error]) Set a new password for a user using a password reset code.
setPassword(setPasswordObject) Promise Set a new password for a user using a password reset code.
setPassword(setPasswordObject) Promise Set a new password for a user using a password reset code.
setPassword(setPasswordObject, [success], [error]) Set a new password for a user using a password reset code.
unlinkFromADFS(userId) Promise Unlinks a Telerik Backend Services user account from the ADFS token that it is linked to.
unlinkFromADFS(userId, [success], [error]) Unlinks a Telerik Backend Services user account from the ADFS token that it is linked to.
unlinkFromFacebook(userId) Promise Unlinks a Telerik Backend Services user account from the Facebook token that it is linked to.
unlinkFromFacebook(userId, [success], [error]) Unlinks a Telerik Backend Services user account from the Facebook token that it is linked to.
unlinkFromGoogle(userId, [success], [error]) Unlinks a Telerik Backend Services user account from the Google access token that it is linked to.
unlinkFromGoogle(userId) Promise Unlinks a Telerik Backend Services user account from the Google access token that it is linked to.
unlinkFromLiveID(userId) Promise Unlinks a Telerik Backend Services user account from the Microsoft Account access token that it is linked to.
unlinkFromLiveID(userId, [success], [error]) Unlinks a Telerik Backend Services user account from the Microsoft Account access token that it is linked to.
unlinkFromTwitter(userId) Promise Unlinks a Telerik Backend Services user account from the Twitter access token that it is linked to.
unlinkFromTwitter(userId, [success], [error]) Unlinks a Telerik Backend Services user account from the Twitter access token that it is linked to.

Users static members

Name Return type Description
ResultTypes Defines the result types that can be returned by users functions.

WhereQuery [class]

WhereQuery instance members

Name Return type Description
all(field, value) WhereQuery Adds a condition that a field must include all of the specified values. Applicable to Array fields.
and() WhereQuery Adds an and clause to the current condition and returns it for further chaining.
done() Query Ends the definition of the current WhereQuery. You need to call this method in order to continue with the definition of the parent Query. All other WhereQuery methods return the current instance of WhereQuery to allow chaining.
endsWith(field, value, [options]) WhereQuery Adds a condition that a field value must end with a specified string.
eq(field, value) WhereQuery Adds a condition that a field must be equal to a specific value.
equal(field, value) WhereQuery Adds a condition that a field must be equal to a specific value.
greaterThan(field, value) WhereQuery Adds a condition that a field must be greater than a certain value. Applicable to Number, String, and Date fields.
greaterThanEqual(field, value) WhereQuery Adds a condition that a field must be greater than or equal to a certain value. Applicable to Number, String, and Date fields.
gt(field, value) WhereQuery Adds a condition that a field must be greater than a certain value. Applicable to Number, String, and Date fields.
gte(field, value) WhereQuery Adds a condition that a field must be greater than or equal to a certain value. Applicable to Number, String, and Date fields.
isin(field, value) WhereQuery Adds a condition that a field must be in a set of values.
lessThan(field, value) WhereQuery Adds a condition that a field must be less than a certain value. Applicable to Number, String, and Date fields.
lessThanEqual(field, value) WhereQuery Adds a condition that a field must be less than or equal to a certain value. Applicable to Number, String, and Date fields.
lt(field, value) WhereQuery Adds a condition that a field must be less than a certain value. Applicable to Number, String, and Date fields.
lte(field, value) WhereQuery Adds a condition that a field must be less than or equal to a certain value. Applicable to Number, String, and Date fields.
ne(field, value) WhereQuery Adds a condition that a field must not be equal to a specific value.
nearSphere(field, point, distance, [metrics]) WhereQuery Adds a Geospatial condition that a specified geopoint must be within a certain distance from another geopoint. Applicable to GeoPoint fields only.
not() WhereQuery Adds a not clause to the current condition and returns it for further chaining.
notEqual(field, value) WhereQuery Adds a condition that a field must not be equal to a specific value.
notin(field, value) WhereQuery Adds a condition that a field must not be in a set of values.
or() WhereQuery Adds an or clause to the current condition and returns it for further chaining.
regex(field, regularExpression, [options]) WhereQuery Adds a condition that a field must satisfy a specified regex.
size(field, value) WhereQuery Adds a condition that a field must contain an array whose length is larger than a specified value. Applicable to Array fields.
startsWith(field, value, [options]) WhereQuery Adds a condition that a field value must start with a specified string.
withinBox(field, pointBottomLeft, pointUpperRight) WhereQuery Adds a Geospatial condition that a specified geopoint must be within a specified coordinate rectangle. Applicable to GeoPoint fields only.
withinCenterSphere(field, center, radius, [metrics]) WhereQuery Adds a Geospatial condition that a specified geopoint must be within a coordinate circle. Applicable to GeoPoint fields only.
withinPolygon(field, points) WhereQuery Adds a Geospatial condition that a specified geopoint must be within a specified coordinate polygon. The polygon is specified as an array of geopoints. The last point in the array is implicitly connected to the first point thus closing the shape. Applicable to GeoPoint fields only.

constants

Constants static members

Name Return type Description
HttpMethod HTTP Methods
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.