References

summary
public	C Client Client is a static class that is used for setting system wide information about connection, device, and general SDK settings.
public	C Clinical6 Client to the Clinical6 instance
public	V advertisementService: AdvertisementService
public	V agreementService: AgreementService
public	V analyticsService: AnalyticsService
public	V appMenuService: AppMenuService
public	V callbackService: CallbackService
public	V client: Client
public	V consultationService: ConsultationService
public	V contentService: ContentService
public	V deviceService: DeviceService
public	V discussService: DiscussService
public	V eDiaryService: EDiaryService
public	V eventService: EventService
public	V flowService: FlowService
public	V importService: ImportService
public	V jsonApiService: JsonApiService
public	V languageService: LanguageService
public	V locationService: LocationService
public	V messageService: MessageService
public	V mobileUserService: UserService
public	V platformMenuService: PlatformMenuService
public	V projectContentService: ProjectContentService
public	V relatedUserService: RelatedUserService
public	V roleService: RoleService
public	V ruleService: RuleService
public	V statusService: StatusService
public	V systemService: SystemService
public	V temporaryIdService: TemporaryIdService
public	V userService: UserService

helpers

summary
public	C Advertisement this class was deprecated. Helper class representing advertisement. Typically use {@link AdvertisementService#get}
public	C AnalyticsMetric Helper class representing a user AnalyticsMetric.
public	C CustomClass Helper class representing Custom Class.
public	C Device Helper class representing a device.
public	C Helper The base class for helper classes
public	C Image Helper class representing an image object.
public	C Insight Helper class representing a tracker object.
public	C Language Helper class representing a Language.
public	C Location Helper class representing a location object.
public	C Message this class was deprecated. Helper class representing message. In-app conversations consist of one or more messages.
public	C Notification Helper class representing a user Notification.
public	C ProjectContent The ProjectContent class wraps custom API endpoints in a simple and quick set of objects / methods.
public	C Query Helper class representing a Query object that can be passed on to the findDynamicContent method
public	C Section Helper class representing a Section.
public	C Setting Helper class representing an setting.
public	C Status Helper class representing an status.
public	C Storage Helper class representing a Section.
public	C Timezone Helper class representing a user Timezone.
public	C VuforiaTarget this class was deprecated. Helper class representing VuforiaTarget.

helpers/agreement

summary
public	C Agreement Helper class representing Agreement.
public	C AgreementSignature Helper class representing AgreementSignature.
public	C AgreementTemplate Helper class representing AgreementTemplate.
public	C AgreementTemplateField Helper class representing AgreementTemplateField.
public	C PaperTemplate Helper class representing PaperTemplate.

helpers/callback

summary
public	C Callback Helper class representing Callback.
public	C CallbackCondition Helper class representing CallbackCondition.

helpers/cohort

summary
public	C Cohort Helper class representing a cohort.
public	C CohortAssignment Helper class representing an cohortAssignment.

summary
public	C ApproverAssignment Helper class representing an consent approver assignment.
public	C ApproverGroup Helper class representing an approver group.
public	C ApproverGroupAssignment Helper class representing an consent approver group assignment.
public	C AvailableStrategy Helper class representing a Consent Available Strategy.
public	C ConsentAdditionalSigner Helper class representing an additional signer for a consent form.
public	C ConsentApprover Helper class representing approvers that have been created.
public	C ConsentForm Helper class representing a Consent Form.
public	C ConsentFormVersion Helper class representing a Consent Form Version.
public	C ConsentGrant Helper class representing a Consent Grant.
public	C ConsentStrategy Helper class representing a Consent Strategy.

helpers/consult

summary
public	C Consultation Helper class representing a Consultation.
public	C ConsultationParticipant Helper class representing a ConsultationParticipant.

helpers/content

summary
public	C Content Helper class representing Content.
public	C ContentAttribute Helper class representing an eDiary Entry Group.
public	C ContentType Helper class representing a Content Type.

helpers/discuss

summary
public	C Comment Helper class representing a Comment.
public	C Thread Helper class representing a Thread.

helpers/ediary

summary
public	C Entry Helper class representing an eDiary Entry.
public	C EntryGroup Helper class representing an eDiary Entry Group.
public	C EntryTemplate Helper class representing an eDiary Entry Template.

helpers/esignaccount

summary
public	C SignAccount Helper class representing a Consent Strategy.

helpers/filter

summary
public	C Filter Helper class representing a filter.
public	C FilterGroup Helper class representing a filter group.

helpers/flow

summary
public	C Flow A flow is a collection of steps representing a screen or card created by the Clinical6 platform.
public	C FlowAnswer A flow is a collection of steps representing a screen or card created by the Clinical6 platform.
public	C FlowContainer Helper class representing FlowContainer
public	C FlowData Helper class representing Flow Data (Captured Value).
public	C FlowDataGroup Helper class representing a Flow Data Group (Captured Value Group).
public	C FlowInput Helper class representing a flow input object.
public	C FlowKeyValue Helper class representing Flow Data (Flow Process Value).
public	C FlowStep Helper class representing a flow step object.

helpers/gamification

summary
public	C AwardedBadge Helper class representing an badge.
public	C Badge Helper class representing an badge.

helpers/identifier

summary
public	C TemporaryId Helper class representing a Temporary Identifier.

helpers/import

summary
public	C BulkImport Helper class representing an bulkImport.
public	C CsvExampleFile Helper class representing a csv example file.
public	C GenericFile Helper class representing a generic file.
public	C JobStatus Helper class representing a job status.

summary
public	C AppMenu Helper class representing app menu.
public	C PlatformMenu Helper class representing an platformMenu.
public	C PredefinedScreen Helper class representing PredefinedScreen

helpers/reminder

summary
public	C Event Helper class representing a event.
public	C Rule Helper class representing a rule.
public	C Schedule Helper class representing a schedule.

helpers/sso

summary
public	C SsoOption Helper class representing an SSO Option.

helpers/trial

summary
public	C Site Helper class representing an site.
public	C SiteContact Helper class representing a supported site contact.
public	C SiteLanguage Helper class representing a supported site language.
public	C SiteMember Helper class representing an siteMember.

helpers/user

summary
public	C AllowedAction Helper class representing a Permission AllowedAction.
public	C Invitation Helper class representing an eDiary Entry Group.
public	C InvitationStatus Helper class representing an eDiary Entry Group.
public	C Permission Helper class representing a Role Permission.
public	C Profile Helper class representing a user profile.
public	C RelatedUser Helper class representing a RelatedUser.
public	C Role Helper class representing a user role.
public	C Session Helper class representing a user User.
public	C User Helper class representing a user User.

helpers/version

summary
public	C Version Helper class representing an Audit Version.

models

summary
public	C AdvertisementModel this class was deprecated. Model representing a advertisement.
public	C AnalyticsMetricModel Model representing an analytics metric.
public	C CustomClassModel Model representing Dynamic CustomClass.
public	C DeviceModel Model representing a device.
public	C ImageModel Model representing a image.
public	C InsightModel Model representing a tracker object.
public	C LanguageModel Model representing a language.
public	C LocationModel Model representing a location object.
public	C MessageModel this class was deprecated. Model representing message. In-app conversations consist of one or more messages.
public	C NotificationModel Model representing a notification.
public	C SectionModel Model representing section.
public	C SettingModel Model representing a Setting.
public	C StatusModel Model representing a status.
public	C TimezoneModel Model representing a timezone.
public	C VuforiaTargetModel this class was deprecated. Model representing a Vuforia Target.

models/agreement

summary
public	C AgreementModel Model representing an Agreement.
public	C AgreementSignatureModel Model representing an Agreement Signature.
public	C AgreementTemplateModel Model representing an Agreement Template.
public	C AgreementTemplateFieldModel Model representing a Agreement Template Field.
public	C PaperTemplate Model representing a Paper Template.

models/callback

summary
public	C CallbackModel Model representing a callback.
public	C CallbackConditionModel Model representing a callback condition.

models/cohort

summary
public	C CohortModel Model representing a cohort.
public	C CohortAssignmentModel Model representing a cohort assignment.

summary
public	C ApproverAssignmentModel Model representing a Consent Approver Assignment.
public	C ApproverGroupModel Model representing a consent approver group.
public	C ApproverGroupAssignmentModel Model representing a Consent Approver Group Assignment.
public	C AvailableStrategyModel Model representing a consent available strategy.
public	C ConsentAdditionalSignerModel Model representing a additional signers
public	C ConsentApproverModel Model representing a consent approver.
public	C ConsentFormModel Model representing a consent form.
public	C ConsentFormVersionModel Model representing a consent form version.
public	C ConsentGrantModel Model representing a consent grant.
public	C ConsentStrategyModel Model representing a consent strategy.

models/consult

summary
public	C ConsultationModel Model representing a video consultation.
public	C ConsultationParticipantModel Model representing a video session.

models/content

summary
public	C ContentModel Model representing Dynamic Content.
public	C ContentAttributeModel Model representing a Content Attribute Model.
public	C ContentTypeModel Model representing an Content Type.

models/discuss

summary
public	C CommentModel Model representing a comment.
public	C ThreadModel Model representing a thread.

models/ediary

summary
public	C EntryModel Model representing an EDiary Entry.
public	C EntryGroupModel Model representing an EDiary Entry Group.
public	C EntryTemplateModel Model representing an EDiary Entry Group Template.

models/esignaccount

summary
public	C SignAccountModel Model representing an eSignature account.

models/filter

summary
public	C FilterModel Model representing a filter.
public	C FilterGroupModel Model representing a filter group.

models/flow

summary
public	C FlowModel Model representing a flow process (flow template).
public	C FlowContainerModel Model representing a flow container.
public	C FlowDataModel Model representing an Flow Data (data_collection__captured_values).
public	C FlowDataGroup Model representing an Flow Data Group (data_collection__captured_value_groups).
public	C FlowInputModel Model representing a flow input in a flow process.
public	C FlowKeyValueModel This is only used as an alias to simplify the saving of flow information.
public	C FlowStepModel Model representing a step in a flow process.

models/gamification

summary
public	C AwardedBadgeModel Model representing a awarded_badge.
public	C BadgeModel Model representing a badge.

models/identifier

summary
public	C TemporaryIdModel Model representing a temporary identifier.

models/import

summary
public	C BulkImportModel Model representing a bulk import.
public	C CsvExampleFileModel Model representing a csv example file.
public	C GenericFileModel Model representing a generic file.
public	C JobStatusModel Model representing a job status.

summary
public	C AppMenuModel Model representing app menu.
public	C PlatformMenuModel Model representing a platform menu.
public	C PredefinedScreenModel Model representing a predefined screen.

models/reminder

summary
public	C EventModel Model representing an Event.
public	C RuleModel Model representing an Rule.
public	C ScheduleModel Model representing an Schedule.

models/sso

summary
public	C SsoOptionModel Model representing an SSO Option.

models/trial

summary
public	C SiteModel Model representing a site.
public	C SiteContactModel Model representing a site contact.
public	C SiteLanguageModel Model representing a supported site language.
public	C SiteMemberModel Model representing a site member.

models/user

summary
public	C AllowedActionModel Model representing a Role AllowedAction.
public	C InvitationModel Model representing a User Invitation Model.
public	C InvitationStatusModel Model representing a User Invitation Model.
public	C PermissionModel Model representing a Role Permission.
public	C ProfileModel Model representing a user profile.
public	C RelatedUserModel Model representing a relatedUser.
public	C RoleModel Model representing a user role.
public	C SessionModel Model representing a session.
public	C UserModel Model representing a user.

models/version

summary
public	C VersionModel Model representing an audit version.

services

summary
public	C AbstractService An abstract class to setup various methods, attributes, and getters/setters.
public	C AdvertisementService this class was deprecated. Service handling Advertisements (images).
public	C AgreementService Service handling System Utility calls.
public	C AnalyticsService Service handling Analytics calls with specific endpoints.
public	C AppMenuService Service handling AppMenu calls with specific endpoints.
public	C CallbackService Service handling Callback calls with specific endpoints.
public	C ConsultationService Service handling Consultation calls with specific endpoints.
public	C ContentService Service handling Content calls with specific endpoints.
public	C DeviceService Service handling Device calls with specific endpoints.
public	C DiscussService Service handling comment calls with specific endpoints.
public	C EDiaryService Service handling EDiary (Entries, Groups, and Templates) calls with specific endpoints.
public	C EventService Service handling Event calls with specific endpoints.
public	C FlowService Service handling Flow process calls with specific endpoints.
public	C ImportService Service handling Import calls with specific endpoints.
public	C JsonApiService An abstract class to handle generic get, insert, update, delete json api calls.
public	C LanguageService Service handling Language calls with specific endpoints.
public	C LocationService Service handling Location calls.
public	C MessageService this class was deprecated. Service handling Message calls.
public	C PlatformMenuService Service handling PlatformMenu calls with specific endpoints.
public	C ProjectContentService Service that includes generic functions to pull, update, and create data.
public	C RelatedUserService Service handling RelatedUser calls with specific endpoints.
public	C RoleService Service handling UserRole calls with specific endpoints.
public	C RuleService Service handling Rule calls with specific endpoints.
public	C StatusService Service handling Status calls.
public	C SystemService Service handling System Utility calls.
public	C TemporaryIdService Service handling TemporaryId calls with specific endpoints.
public	C UserService Service handling User calls with specific endpoints.

utilities

summary
public	C Clinical6Error Clinical6Error is a class that extends Error so that it can easily translate information from internal SDK errors and platform errors
public	C StorageUtility Storage will store and retrieve data.
public	C LocalStorageUtility Storage will store and retrieve data.
public	F arrayToObject(_array: Array, options: Object): Object Convert the Array to an object
public	F union(arr1: Array, arr2: Array, eqFn: Function<Boolean>): * http://stackoverflow.com/a/13319168 arr1 and arr2 are arrays of any length; eqFn is a function which can compare two items and return true if they're equal and false otherwise
public	F unique(arr: Array, eqFn: Function<Boolean>): * Returns an array with unique values given the Eq Function
public	F aggregate(baseClass: Class, mixins: Class[]): * Support for mixin-style inheritance by extending from expressions yielding function objects.
public	F fieldsToCamel(obj: Object): Object Updates field names from the current case to snake case
public	F fieldsToSnake(obj: Object): Object Updates field names from the current case to snake case
public	F toJsonApiStub(obj: ):
public	F evaluate(a: Any, operator: String, b: Any): Boolean Evaluate where a operator b
public	F camelToSnake(key: String): String Convert string from camel to snake case
public	F isEmail(email: String): Boolean Determines if the string is an email address.
public	F kebabToCamel(key: String): String Convert string from kebab to camel case
public	F kebabToSnake(key: String): String Convert string from kebab to snake case
public	F objectToURI(obj: Any, prefix: String): * Converts object to a URI to be used with Clinical6
public	F snakeToCamel(key: String): String Convert string from snake to camel case
public	F stringToCamel(key: String): String Convert string from any to camel case
public	F stringToSnake(key: String): String Convert string from any to snake case
public	F flattenJsonApi(json: Object): Object Flattens the json api format to a normal format
public	F getJsonApiType(json: Object): String Returns the type if the format is json api type.
public	F isJsonApiFormat(json: Object): Boolean Returns if the format is json api type.
public	F hasAttribute(p: Object, attributeName: String, msg: String): String If the parameter does not have the attribute, a message is returned
public	F hasToken(msg: String): String If there is no token, a message is returned.
public	F isA(p: any, type: String, msg: String): String If the parameter is not of primitive type 'type', a message is returned.
public	F isDate(date: any, msg: String): String If the value is not a date, a message is returned.
public	F isRequired(p: any, msg: String): String If the required item does not exist, a message is returned.
public	F isValid(booleanStatement: Boolean, msg: String): String If the boolean statement is false, return a message, otherwise return an empty string
public	F validate(module: String, results: ...Object) Loops through each validation item and throws an error if something fails (a message exists)
public	V operators: Object

utilities/factories

summary
public	C HelperFactory Factory to convert responses to classes (deserialization)
public	C ServiceFactory Factory to convert responses to services
public	V helperFactory: HelperFactory
public	V serviceFactory: ServiceFactory