The Built module acts as the entry point for the SDK.
Members
-
staticBuilt.ACL
-
Represents a ACL
-
staticBuilt.App
-
Represents a App
-
staticBuilt.CachePolicyString
-
Set of cache policies
Properties:
Name Type Default Description ONLY_NETWORK
String ONLY_NETWORK No cache is being maintained. Always a network call is made to retrieve data (Default). CACHE_ELSE_NETWORK
String CACHE_ELSE_NETWORK It will try to first get the data from cache. On failure would make a network call. NETWORK_ELSE_CACHE
String NETWORK_ELSE_CACHE It will try to make a network call. On failure would fetch it from cache. CACHE_THEN_NETWORK
String CACHE_THEN_NETWORK Get data from both cache and network. Example
//'blt5d4sample2633b' is a dummy Application API key var app = Built.App('blt5d4sample2633b') .setCachePolicy(Built.CachePolicy.CACHE_ELSE_NETWORK);
-
staticBuilt.ConstantsString
-
Constants for system classes names on Built.io Backend
Properties:
Name Type Default Description APPLICATION_USER
String Constants.APP_USER_CLS Class name for application-user class on Built.io Backend APPLICATION_USER_ROLE
String Constants.APP_ROLE_CLS Class name for application-user-role class on Built.io Backend INSTALLATION
String Constants.APP_INSTALLATION_CLS Class name for installation class on Built.io Backend Example
//'blt5d4sample2633b' is a dummy Application API key var app = Built.App('blt5d4sample2633b').Class(Built.Constants.APPLICATION_USER);
-
staticBuilt.Events
-
Events raised on this application. For example, an event is raised every time an http request is fired.
-
staticBuilt.Group
-
Represents a Group
-
staticBuilt.GroupMultiple
-
Represents a GroupMultiple
-
staticBuilt.Location
-
Represents an Location
-
staticBuilt.Mixin
-
Represents a Mixin
-
staticBuilt.Presence
-
Presence details of User.
-
staticBuilt.SessionString
-
Set of modes through which logged-in user's session can be maintained
Properties:
Name Type Default Description COOKIE
String COOKIE Set Cookie as the storage medium to maintain session LOCAL_STORAGE
String LOCAL_STORAGE Set HTML 5 local storage as the storage medium to maintain session MEMORY
String MEMORY By Default, sessions are not maintained in Node; to maintain sessions, set persistSession to Memory. NONE
String NONE No session would be maintained Example
//'blt5d4sample2633b' is a dummy Application API key var app = Built.App('blt5d4sample2633b').persistSessionWith(Built.Session.COOKIE);
-
staticBuilt.Upsert
-
Represents a Upsert