App Codex Version: 1.0.0

Source

externalCode/AppInitialisation.js

  1. /**
  2.  * @typedef {Object} Site
  3.  * @property {number} blog_id
  4.  * @property {string} blogname
  5.  * @property {string} domain
  6.  * @property {string} path
  7.  * @property {string} siteurl
  8.  * @property {?string} app_home_screen_logo
  9.  * @property {?string} app_splash
  10.  */
  12. /**
  13.  * @typedef {Object} SitesState
  14.  * @property {?Array<Site>} sites
  15.  * @property {?Site} selectedSite
  16.  */
  18. /**
  19.  * @typedef {Function} ServerUrlOverriderFunction
  20.  * @param {SitesState} sitesState
  21.  * @return {?string} url
  22.  */
  24. /**
  25.  * @class
  26.  * App Initialisation Hooks.
  27.  * Instance name: appInitialisationApi
  28.   
  29.    You can use this hook to customize your app initialization screen and help improve UX for your app. 
  30.    There are a range of things you can do with this hook such as loading home screen in the background, displaying splash toast message and more.
  31.  * @example
  32.  * externalCodeSetup.appInitialisationApi.METHOD_NAME
  33.  */
  34. export class AppInitialisationApi {
  35. 	/**
  36. 	 * @ignore
  37. 	 * @private
  38. 	 * @property {boolean} sandboxEnabled
  39. 	 */
  40. 	sandboxEnabled = false;
  42. 	/**
  43. 	 * @ignore
  44. 	 * Enables connection to sandbox.
  45. 	 * @method
  46. 	 * @example
  47. 	 * externalCodeSetup.appInitialisationApi.enableSandbox();
  48. 	 */
  49. 	enableSandbox = () => {
  50. 		this.sandboxEnabled = true;
  51. 	};
  53. 	/**
  54. 	 * @ignore
  55. 	 * @property {string} sandBoxSessionId
  56. 	 */
  57. 	sandBoxSessionId = null;
  59. 	/**
  60. 	 * @ignore
  61. 	 * @method
  62. 	 * @example
  63. 	 * externalCodeSetup.setSandboxSessionId(sessionId);
  64. 	 */
  65. 	setSandboxSessionId = sandBoxSessionId => {
  66. 		this.sandBoxSessionId = sandBoxSessionId;
  67. 	};
  69. 	/**
  70. 	 * @ignore
  71. 	 * @property {Object} sandboxSessionHeaders
  72. 	 */
  73. 	sandboxSessionHeaders = {};
  75. 	/**
  76. 	 * @ignore
  77. 	 * @method
  78. 	 * @example
  79. 	 * externalCodeSetup.setSandboxSessionHeaders(headers);
  80. 	 */
  81. 	setSandboxSessionHeaders = headers => {
  82. 		this.sandboxSessionHeaders = headers;
  83. 	};
  85. 	/**
  86. 	 * @ignore
  87. 	 * @private
  88. 	 * @property {boolean} enableReportSandbox
  89. 	 */
  90. 	enableReportSandbox = false;
  92. 	/**
  93. 	 * @ignore
  94. 	 * If sandBoxEnabled = true, enabling this will show "Report Sandbox" link in Settings screen.
  95. 	 * @method
  96. 	 * @example
  97. 	 * externalCodeSetup.appInitialisationApi.enableSandboxReport();
  98. 	 */
  99. 	enableSandboxReport = () => {
  100. 		this.enableReportSandbox = true;
  101. 	};
  103. 	/**
  104. 	 * @private
  105. 	 * @property {?string} splashScreenToastText
  106. 	 */
  107. 	splashScreenToastText = null;
  109. 	/**
  110. 	 * The hook is used to set a splash screen toast message to show up during app initialization.
  111. 	 * The splash screen toast message is a small message that shows up at the bottom of the screen for a while and then disappears.
  112. 	 * It is often used to make a program more interactive and visual.
  113. 	 * @method
  114. 	 * @param {?String} text Sets splash screen toast message during app initialization
  115. 	 * @example
  116. 	 * externalCodeSetup.appInitialisationApi.setSplashScreenToastText("Welcome to my app!")
  117. 	 */
  118. 	setSplashScreenToastText = text => {
  119. 		this.splashScreenToastText = text;
  120. 	};
  122. 	/**
  123. 	 * @private
  124. 	 * @property {ServerUrlOverriderFunction} initialServerUrlOverrider
  125. 	 */
  126. 	initialServerUrlOverrider = sitesState => null;
  128. 	/**
  129. 	 * You can use this if you are using multisite and want to override the initial `server_url` in `RootWrapper`.
  130. 	 * For example, the hook can be used to make the app call API requests to "https://my.example.com" instead of "https://example.com" for your BuddyBoss website.
  131. 	 * @method
  132. 	 * @param {ServerUrlOverriderFunction} initialServerUrlOverrider Overrides initial `server_url` in `RootWrapper` for multisite user
  133. 	 * @example
  134. 	 * externalCodeSetup.appInitialisationApi.setInitialServerUrlOverrider((props) => {
  135. 	 *  return props.sites[1].siteurl;
  136. 	 * })
  137. 	 */
  138. 	setInitialServerUrlOverrider = initialServerUrlOverrider => {
  139. 		this.initialServerUrlOverrider = initialServerUrlOverrider;
  140. 	};
  142. 	/**
  143. 	 * @private
  144. 	 * @property {Boolean} homeScreenPrefetchEnabled
  145. 	 */
  146. 	homeScreenPrefetchEnabled = false;
  147. 	/**
  148. 	 * When the hook is enabled, it can help improve the UX.
  149. 	 * It enables the home screen to load as the background of the app launch screen even before the user signs in.
  150. 	 * When the hook is set to false, the app will only show the home screen once the user signs in.
  151. 	 * @method
  152. 	 * @param {Boolean} isEnabled True if home screen should be prefetched
  153. 	 * @example
  154. 	 * externalCodeSetup.appInitialisationApi.setHomeScreenPrefetchEnabled(true)
  155. 	 */
  156. 	setHomeScreenPrefetchEnabled = isEnabled => {
  157. 		this.homeScreenPrefetchEnabled = isEnabled;
  158. 	};
  160. 	composeHocs = [];
  161. 	/**
  162. 	 * @ignore
  163. 	 * @method
  164. 	 * @param {array} hocs
  165. 	 * externalCodeSetup.appInitialisationApi.addComposeHocs(hocs)
  166. 	 */
  168. 	addComposeHocs = composeHocs => {
  169. 		this.composeHocs = composeHocs;
  170. 	};
  171. }