Home Reference Source Repository

Function

Static Public Summary
public

Factory to create an instance of the directive

public
public

Factory function to create the Object

public

ArrayToObjectFilter(input: *, srcIdName: *): *

Filter to convert an array into a map

public

Factory to create new instances of the ArrayToObjectFilter

public

AttachmentsFilter(attachmentsArray: *): *

Filter to get all the attachments from an array

public

Factory to create new instances of the AttachmentsFilter

public

BytesToSizeFilter(bytes: *, showZero: *): *

Filter to convert bytes to a size

public

Factory to create new instances of the BytesToSizeFilter

public

Factory to create a new instance of the directive

public

FormatDateFilter(date: *, format: *): *

Filter to format a date

public

Factory to create new instances of the FormatDateFilter

public

Export a factory to create a new HomeService

public

Factory to create a Lock

public

Factory to create a new instance of the directive

public

Factory to create a new instance of the directive

public

Object2ArrayFilter(input: *): *

Filter to convert a object's keys to a map

public

Factory to create new instances of the Object2ArrayFilter

public

Factory to create a new instance of the directive

public
public
public

An object that manages handlers that have tool specific handlers to manage the mining of attachments in tool specific data.

public

Handlers for responses to uploads.

public

Factory to create new instances of the SynthAttachments directive.

public

Handlers to find content that needs to be deleted.

public

These handlers go through the newly downloaded content of a tool and update the links to the actual location of the file on the device

public

Handlers to replace links embedded in tool content to links that open in an external browser.

public

Factory to create new instances of the SynthMenu directive

public

Factory to create a new SynthesisRESTClient

public

Factory to create a new instance of the directive

public

Factory to create new instances of the ToolSyncStatus directive

public
public

Factory to create instances of the UserSession class

public

Factory to create a new UserSettings service

public

convertToObject(jsonData: *): *

Convert an unknown jsonData type to an JSON Object

public

convertToString(jsonData: *): string

Convert an unknown jsonData type to an JSON Object

public

Returns a unique ID immediately

public

getNumberOfProperties(object: *, field: *): *

Class for utility methods.

Static Public

public AnimatedEllipseFactory(): * source

import AnimatedEllipseFactory from 'synthesis-mobile/js/base/directives/AnimatedEllipse.js'

Factory to create an instance of the directive

Return:

*

public AnnouncementServiceFactory(): * source

Return:

*

public AppSyncStatusFactory(): * source

import AppSyncStatusFactory from 'synthesis-mobile/js/base/factories/AppSyncStatus.js'

Factory function to create the Object

Return:

*

public ArrayToObjectFilter(input: *, srcIdName: *): * source

Filter to convert an array into a map

Params:

NameTypeAttributeDescription
input *

input Array

srcIdName *

name of the field in the source array that contains the id

Return:

*

public ArrayToObjectFilterFactory(): * source

import ArrayToObjectFilterFactory from 'synthesis-mobile/js/base/filters/ArrayToObjectFilter.js'

Factory to create new instances of the ArrayToObjectFilter

Return:

*

public AttachmentsFilter(attachmentsArray: *): * source

Filter to get all the attachments from an array

Params:

NameTypeAttributeDescription
attachmentsArray *

Return:

*

public AttachmentsFilterFactory(): * source

import AttachmentsFilterFactory from 'synthesis-mobile/js/base/filters/AttachmentsFilter.js'

Factory to create new instances of the AttachmentsFilter

Return:

*

public BytesToSizeFilter(bytes: *, showZero: *): * source

Filter to convert bytes to a size

Params:

NameTypeAttributeDescription
bytes *
showZero *

Return:

*

public BytesToSizeFilterFactory(): * source

import BytesToSizeFilterFactory from 'synthesis-mobile/js/base/filters/BytesToSizeFilter.js'

Factory to create new instances of the BytesToSizeFilter

Return:

*

public CurrentModuleNameFactory(): * source

import CurrentModuleNameFactory from 'synthesis-mobile/js/base/directives/CurrentModuleName.js'

Factory to create a new instance of the directive

Return:

*

public FormatDateFilter(date: *, format: *): * source

Filter to format a date

Params:

NameTypeAttributeDescription
date *
format *

Return:

*

public FormatDateFilterFactory(): * source

import FormatDateFilterFactory from 'synthesis-mobile/js/base/filters/FormatDateFilter.js'

Factory to create new instances of the FormatDateFilter

Return:

*

public HomeServiceFactory(): * source

import HomeServiceFactory from 'synthesis-mobile/js/base/home/HomeService.js'

Export a factory to create a new HomeService

Return:

*

public LockFactory(): * source

Factory to create a Lock

Return:

*

public ModuleCollapseFactory(): * source

import ModuleCollapseFactory from 'synthesis-mobile/js/base/directives/ModuleCollapse.js'

Factory to create a new instance of the directive

Return:

*

public ModuleNameFactory(): * source

Factory to create a new instance of the directive

Return:

*

public Object2ArrayFilter(input: *): * source

Filter to convert a object's keys to a map

Params:

NameTypeAttributeDescription
input *

Return:

*

public Object2ArrayFilterFactory(): * source

import Object2ArrayFilterFactory from 'synthesis-mobile/js/base/filters/Object2ArrayFilter.js'

Factory to create new instances of the Object2ArrayFilter

Return:

*

public OverallSyncStatusFactory(): * source

import OverallSyncStatusFactory from 'synthesis-mobile/js/base/directives/OverallSyncStatus.js'

Factory to create a new instance of the directive

Return:

*

public RegistrationServiceFactory(): * source

import RegistrationServiceFactory from 'synthesis-mobile/js/base/services/RegistrationService.js'

Return:

*

public SyncSelectionFactory(): * source

import SyncSelectionFactory from 'synthesis-mobile/js/base/sync/SyncSelection.js'

Return:

*

public SynthAttachmentMinerProvider() source

An object that manages handlers that have tool specific handlers to manage the mining of attachments in tool specific data.

Params: toolName - name of the tool locally to SynthMobile - not SynthService name funcHandler - function for handler - or the word "default" to use default implementation

The handler method should conform to the following rules: 1) Accept the tool data as the first parameter of the handler method and the download path as the second. 2) The handler must update the data to include the full local path for the attachments 3) Return an array of files to download. The data structure for these files are: { 'downloadKey' : '<the key>', 'downloadPath' : '<full cdv-file:// path>'

} 4) Return an empty array if there are no attachments to download

public SynthAttachmentMinerProvider() source

Handlers for responses to uploads. Some tools will have to fix ids for generated content to ids returned by the server.

The handler will be called with the following parameters $1 - sentObject - The original data String $2 - responseObject - The response from the server after the upload

The handler should return a string or object representing the fixed data.

Example function myUploadHandler(sentObject, responseObject){ var string = JSON.stringify(sentObject); // Replace Ids for(var oldKey in responseObject){ var newKey = responseObject[oldKey]; var regEx = new RegExp(oldKey, 'g'); // Replace all instances of the old key with the new key string = string.replace(regEx, newKey); } return string; }

public SynthAttachmentsFactory(): * source

import SynthAttachmentsFactory from 'synthesis-mobile/js/base/directives/SynthAttachments.js'

Factory to create new instances of the SynthAttachments directive.

Return:

*

public SynthDeleteHandlerProvider() source

Handlers to find content that needs to be deleted. The handler function will be called with the following parameters (dataDir

public SynthEmbeddedImageHandlerProvider() source

import SynthEmbeddedImageHandlerProvider from 'synthesis-mobile/js/base/handlers/SynthEmbeddedImageHandlerProvider.js'

These handlers go through the newly downloaded content of a tool and update the links to the actual location of the file on the device

The handler will be called with the following parameters $1 - toolContent - the new delta of tool content $2 - dataPath - The proper root path for attachments

The function must return the object with the fields updated

Example

function myHandler(toolContent){ var html = toolContent.fieldThatHasImage; toolContent.fieldThatHasImage = .fixForHtmlElement(html); return toolContent; }

public SynthLinkHandlerProvider() source

Handlers to replace links embedded in tool content to links that open in an external browser. The problem with embedded links is that they will 'takeover' your webview (i.e. your app!)

These handlers will need to find all the links and fix thems

public SynthMenuFactory(): * source

Factory to create new instances of the SynthMenu directive

Return:

*

public SynthesisRESTClientFactory(): * source

import SynthesisRESTClientFactory from 'synthesis-mobile/js/base/services/SynthesisRESTClient.js'

Factory to create a new SynthesisRESTClient

Return:

*

public ToolNameFactory(): * source

Factory to create a new instance of the directive

Return:

*

public ToolSyncStatusFactory(): * source

import ToolSyncStatusFactory from 'synthesis-mobile/js/base/directives/ToolSyncStatus.js'

Factory to create new instances of the ToolSyncStatus directive

Return:

*

public UserServiceFactory(): * source

import UserServiceFactory from 'synthesis-mobile/js/base/services/UserService.js'

Return:

*

public UserSessionFactory(): * source

import UserSessionFactory from 'synthesis-mobile/js/base/factories/UserSession.js'

Factory to create instances of the UserSession class

Return:

*

public UserSettingsFactory(): * source

import UserSettingsFactory from 'synthesis-mobile/js/base/services/UserSettings.js'

Factory to create a new UserSettings service

Return:

*

public convertToObject(jsonData: *): * source

import {convertToObject} from 'synthesis-mobile/js/base/Utilities.js'

Convert an unknown jsonData type to an JSON Object

Params:

NameTypeAttributeDescription
jsonData *

Return:

*

public convertToString(jsonData: *): string source

import {convertToString} from 'synthesis-mobile/js/base/Utilities.js'

Convert an unknown jsonData type to an JSON Object

Params:

NameTypeAttributeDescription
jsonData *

Return:

string

public generateUID(): * source

import {generateUID} from 'synthesis-mobile/js/base/Utilities.js'

Returns a unique ID immediately

Return:

*

public getNumberOfProperties(object: *, field: *): * source

import {getNumberOfProperties} from 'synthesis-mobile/js/base/Utilities.js'

Class for utility methods. This class should only be used for simple utility methods. DO NOT use this class to call services or to do tool specific manipulations - these kind of functionality should be written in controllers or services for the tool

Params:

NameTypeAttributeDescription
object *
field *

Return:

*