App (REST Client 0.25.28 API)

java.lang.Object
- org.sagebionetworks.bridge.rest.model.App

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2023-07-13T01:30:51.265Z")
public class App
extends Object

An app with its many configuration options.

Constructor Summary

Constructors
Constructor and Description

App()

Constructors
Constructor and Description
`App()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`App`	`accountLimit(Integer accountLimit)`
`App`	`addAndroidAppLinksItem(AndroidAppLink androidAppLinksItem)`
`App`	`addAppleAppLinksItem(AppleAppLink appleAppLinksItem)`
`App`	`addDataGroupsItem(String dataGroupsItem)`
`App`	`addFitBitScopesItem(String fitBitScopesItem)`
`App`	`addTaskIdentifiersItem(String taskIdentifiersItem)`
`App`	`addUploadMetadataFieldDefinitionsItem(UploadFieldDefinition uploadMetadataFieldDefinitionsItem)`
`App`	`addUserProfileAttributesItem(String userProfileAttributesItem)`
`App`	`androidAppLinks(List<AndroidAppLink> androidAppLinks)`
`App`	`appIdExcludedInExport(Boolean appIdExcludedInExport)`
`App`	`appleAppLinks(List<AppleAppLink> appleAppLinks)`
`App`	`automaticCustomEvents(Map<String,String> automaticCustomEvents)`
`App`	`autoVerificationEmailSuppressed(Boolean autoVerificationEmailSuppressed)`
`App`	`autoVerificationPhoneSuppressed(Boolean autoVerificationPhoneSuppressed)`
`App`	`consentNotificationEmail(String consentNotificationEmail)`
`App`	`consentNotificationEmailVerified(Boolean consentNotificationEmailVerified)`
`App`	`customEvents(Map<String,ActivityEventUpdateType> customEvents)`
`App`	`dataGroups(List<String> dataGroups)`
`App`	`defaultTemplates(Map<String,String> defaultTemplates)`
`App`	`disableExport(Boolean disableExport)`
`App`	`emailSignInEnabled(Boolean emailSignInEnabled)`
`App`	`emailVerificationEnabled(Boolean emailVerificationEnabled)`
`boolean`	`equals(Object o)`
`App`	`exporter3Configuration(Exporter3Configuration exporter3Configuration)`
`App`	`exporter3Enabled(Boolean exporter3Enabled)`
`App`	`externalIdRequiredOnSignup(Boolean externalIdRequiredOnSignup)`
`App`	`fitBitScopes(List<String> fitBitScopes)`
`Integer`	`getAccountLimit()` Can only be set by an administrator. If not zero, sets an upper-bound limit on the number of accounts that can be created for this app.
`List<AndroidAppLink>`	`getAndroidAppLinks()` The entries this app contributes to the `/.well-known/assetlinks.json` file to enable app links for Android apps that use this app as the data store.
`List<AppleAppLink>`	`getAppleAppLinks()` The entries this app contributes to the `/.well-known/apple-app-site-association` file to enable universal links for iOS apps that use this app as the data store.
`Map<String,String>`	`getAutomaticCustomEvents()` Custom events that should be generated for participant upon enrollment.
`String`	`getConsentNotificationEmail()` Copies of all consent agreements and withdrawals will be emailed to this address.
`Map<String,ActivityEventUpdateType>`	`getCustomEvents()` Define one or more custom activity events that the client can send to the server, which can be used for scheduling.
`List<String>`	`getDataGroups()` An enumerated list of unique strings that can be assigned to user accounts.
`Map<String,String>`	`getDefaultTemplates()` A map between a type of template, and the template revision that should be used as a default if matching templates to a user is ambiguous.
`Exporter3Configuration`	`getExporter3Configuration()` Configuration required for Exporter 3.0.
`List<String>`	`getFitBitScopes()` List of FitBit scopes that are configured for this app.
`String`	`getIdentifier()` A user selected identifier that is unique relative to all other Bridge studies (lower-case letters and dashes only).
`Map<String,String>`	`getInstallLinks()` This can be either to an app store (URLs mapped to the keys \"iOS\" or \"Android\"), or an intermediate web page that will route to a final app or appstore (URLs mapped to the key \"Universal\").
`Integer`	`getMinAgeOfConsent()` The minimum required age for participants in the app.
`Map<String,Integer>`	`getMinSupportedAppVersions()` Minimum supported app versions (older versions will be blocked), keyed by the name of the operating system (we expect either \"Android\" or \"iPhone OS\" in the User-Agent header of all requests sent to the server).
`String`	`getName()` A label for the app.
`Map<String,OAuthProvider>`	`getOAuthProviders()` The metadata to contact OAuth providers for the Authorization Code Grant Flow.
`PasswordPolicy`	`getPasswordPolicy()` Settings that will govern what is accepted as a valid password when users sign up for the app.
`Map<String,String>`	`getPushNotificationARNs()` A map between operating system names, and the platform ARN necessary to register a device to receive mobile push notifications.
`String`	`getShortName()` A very short label (10 characters or less) for SMS messages and any other highly constrainted contexts.
`String`	`getSponsorName()` The name of the institution or organization that is conducting the app.
`String`	`getSupportEmail()` The email address that will be given to study participants and other end users to contact for support requests.
`Long`	`getSynapseDataAccessTeamId()` Synapse team ID that is granted read access to exported health data records.
`String`	`getSynapseProjectId()` The Synapse project to export health data records to.
`List<String>`	`getTaskIdentifiers()` An enumerated list of unique strings that can be used to identify tasks when creating schedules.
`String`	`getTechnicalEmail()` The email address for a technical contact who can coordinate with the Bridge Server team on technical issues (client or server).
`String`	`getType()` App
`List<UploadFieldDefinition>`	`getUploadMetadataFieldDefinitions()` Metadata fields can be configured for any app.
`UploadValidationStrictness`	`getUploadValidationStrictness()` Get uploadValidationStrictness
`List<String>`	`getUserProfileAttributes()` Custom attributes that can be added to the StudyParticipant object (as members of the attributes property).
`Long`	`getVersion()` A version number used for optimistic locking of the object these keys represent; this value must be passed back to the server on updates.
`int`	`hashCode()`
`App`	`healthCodeExportEnabled(Boolean healthCodeExportEnabled)`
`App`	`identifier(String identifier)`
`App`	`installLinks(Map<String,String> installLinks)`
`Boolean`	`isActive()` Get active
`Boolean`	`isAppIdExcludedInExport()` True if the Bridge Exporter should include the appId prefix in the \"originalTable\" field in the appVersion (now \"Health Data Summary\") table in Synapse.
`Boolean`	`isAutoVerificationEmailSuppressed()` True if the automatic email verification email on sign-up should be suppressed.
`Boolean`	`isAutoVerificationPhoneSuppressed()` Can only be set by an administrator. Should the system send a confirmation SMS message on sign up if phone verification is enabled?
`Boolean`	`isConsentNotificationEmailVerified()` True if the consent notification email is verified.
`Boolean`	`isDisableExport()` If set this field to true, Bridge Exporter will not export this app at all during exporting.
`Boolean`	`isEmailSignInEnabled()` Can only be set by an administrator. If enabled, the user will be able to trigger an email with an URL that can be used to sign into the server, in lieu of a normal sign in process.
`Boolean`	`isEmailVerificationEnabled()` Can only be set by an administrator. Should users be asked to validate that they control the email addresses they use to sign up for the app? True by default.
`Boolean`	`isExporter3Enabled()` True if Exporter 3.0 is enabled for this app.
`Boolean`	`isExternalIdRequiredOnSignup()` Can only be set by an administrator. Should the external ID be required on sign up? If this is true and external ID validation is enabled, this app can support lab codes (where the username and password are auto-generated from the external ID and the user only needs to enter a code).
`Boolean`	`isHealthCodeExportEnabled()` Can only be set by an administrator. Should user health codes be exported as part of the participant roster? This identifies users in the public data set; this can only be set to true for certain studies where users expect to be identified by researchers.
`Boolean`	`isParticipantIpLockingEnabled()` True if sessions for unprivileged participant accounts should be locked to an IP address.
`Boolean`	`isPhoneSignInEnabled()` Can only be set by an administrator. If enabled, the user will be able to trigger an SMS message which contains a token that can be used to sign in to the server, in lieu of a normal sign in process.
`Boolean`	`isReauthenticationEnabled()` Can only be set by an administrator. Enable or disable the ability to issue a reauthentication token in a session, and call the reauthentication APIs to issue a new session.
`Boolean`	`isStrictUploadValidationEnabled()` True if uploads in this app should fail on strict validation errors.
`Boolean`	`isUsesCustomExportSchedule()` **Note: Bridge engineers will normally set this value when setting up data export.
`Boolean`	`isVerifyChannelOnSignInEnabled()` Can only be changed by an administrator. Should the the credential that is submitted during sign-in be verified? This is always true (with the exception of legacy studies) and should not be changed.
`App`	`minAgeOfConsent(Integer minAgeOfConsent)`
`App`	`minSupportedAppVersions(Map<String,Integer> minSupportedAppVersions)`
`App`	`name(String name)`
`App`	`oAuthProviders(Map<String,OAuthProvider> oAuthProviders)`
`App`	`participantIpLockingEnabled(Boolean participantIpLockingEnabled)`
`App`	`passwordPolicy(PasswordPolicy passwordPolicy)`
`App`	`phoneSignInEnabled(Boolean phoneSignInEnabled)`
`App`	`pushNotificationARNs(Map<String,String> pushNotificationARNs)`
`App`	`putAutomaticCustomEventsItem(String key, String automaticCustomEventsItem)`
`App`	`putCustomEventsItem(String key, ActivityEventUpdateType customEventsItem)`
`App`	`putDefaultTemplatesItem(String key, String defaultTemplatesItem)`
`App`	`putInstallLinksItem(String key, String installLinksItem)`
`App`	`putMinSupportedAppVersionsItem(String key, Integer minSupportedAppVersionsItem)`
`App`	`putOAuthProvidersItem(String key, OAuthProvider oAuthProvidersItem)`
`App`	`putPushNotificationARNsItem(String key, String pushNotificationARNsItem)`
`App`	`reauthenticationEnabled(Boolean reauthenticationEnabled)`
`void`	`setAccountLimit(Integer accountLimit)`
`void`	`setAndroidAppLinks(List<AndroidAppLink> androidAppLinks)`
`void`	`setAppIdExcludedInExport(Boolean appIdExcludedInExport)`
`void`	`setAppleAppLinks(List<AppleAppLink> appleAppLinks)`
`void`	`setAutomaticCustomEvents(Map<String,String> automaticCustomEvents)`
`void`	`setAutoVerificationEmailSuppressed(Boolean autoVerificationEmailSuppressed)`
`void`	`setAutoVerificationPhoneSuppressed(Boolean autoVerificationPhoneSuppressed)`
`void`	`setConsentNotificationEmail(String consentNotificationEmail)`
`void`	`setConsentNotificationEmailVerified(Boolean consentNotificationEmailVerified)`
`void`	`setCustomEvents(Map<String,ActivityEventUpdateType> customEvents)`
`void`	`setDataGroups(List<String> dataGroups)`
`void`	`setDefaultTemplates(Map<String,String> defaultTemplates)`
`void`	`setDisableExport(Boolean disableExport)`
`void`	`setEmailSignInEnabled(Boolean emailSignInEnabled)`
`void`	`setEmailVerificationEnabled(Boolean emailVerificationEnabled)`
`void`	`setExporter3Configuration(Exporter3Configuration exporter3Configuration)`
`void`	`setExporter3Enabled(Boolean exporter3Enabled)`
`void`	`setExternalIdRequiredOnSignup(Boolean externalIdRequiredOnSignup)`
`void`	`setFitBitScopes(List<String> fitBitScopes)`
`void`	`setHealthCodeExportEnabled(Boolean healthCodeExportEnabled)`
`void`	`setIdentifier(String identifier)`
`void`	`setInstallLinks(Map<String,String> installLinks)`
`void`	`setMinAgeOfConsent(Integer minAgeOfConsent)`
`void`	`setMinSupportedAppVersions(Map<String,Integer> minSupportedAppVersions)`
`void`	`setName(String name)`
`void`	`setOAuthProviders(Map<String,OAuthProvider> oAuthProviders)`
`void`	`setParticipantIpLockingEnabled(Boolean participantIpLockingEnabled)`
`void`	`setPasswordPolicy(PasswordPolicy passwordPolicy)`
`void`	`setPhoneSignInEnabled(Boolean phoneSignInEnabled)`
`void`	`setPushNotificationARNs(Map<String,String> pushNotificationARNs)`
`void`	`setReauthenticationEnabled(Boolean reauthenticationEnabled)`
`void`	`setShortName(String shortName)`
`void`	`setSponsorName(String sponsorName)`
`void`	`setStrictUploadValidationEnabled(Boolean strictUploadValidationEnabled)`
`void`	`setSupportEmail(String supportEmail)`
`void`	`setSynapseDataAccessTeamId(Long synapseDataAccessTeamId)`
`void`	`setSynapseProjectId(String synapseProjectId)`
`void`	`setTaskIdentifiers(List<String> taskIdentifiers)`
`void`	`setTechnicalEmail(String technicalEmail)`
`void`	`setUploadMetadataFieldDefinitions(List<UploadFieldDefinition> uploadMetadataFieldDefinitions)`
`void`	`setUploadValidationStrictness(UploadValidationStrictness uploadValidationStrictness)`
`void`	`setUserProfileAttributes(List<String> userProfileAttributes)`
`void`	`setUsesCustomExportSchedule(Boolean usesCustomExportSchedule)`
`void`	`setVerifyChannelOnSignInEnabled(Boolean verifyChannelOnSignInEnabled)`
`void`	`setVersion(Long version)`
`App`	`shortName(String shortName)`
`App`	`sponsorName(String sponsorName)`
`App`	`strictUploadValidationEnabled(Boolean strictUploadValidationEnabled)`
`App`	`supportEmail(String supportEmail)`
`App`	`synapseDataAccessTeamId(Long synapseDataAccessTeamId)`
`App`	`synapseProjectId(String synapseProjectId)`
`App`	`taskIdentifiers(List<String> taskIdentifiers)`
`App`	`technicalEmail(String technicalEmail)`
`String`	`toString()`
`App`	`uploadMetadataFieldDefinitions(List<UploadFieldDefinition> uploadMetadataFieldDefinitions)`
`App`	`uploadValidationStrictness(UploadValidationStrictness uploadValidationStrictness)`
`App`	`userProfileAttributes(List<String> userProfileAttributes)`
`App`	`usesCustomExportSchedule(Boolean usesCustomExportSchedule)`
`App`	`verifyChannelOnSignInEnabled(Boolean verifyChannelOnSignInEnabled)`
`App`	`version(Long version)`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - App
```
public App()
```
- Method Detail
  - name
```
public App name(String name)
```
  - getName
```
public String getName()
```
    A label for the app. This will be shown to users in emails and other contexts.
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
  - shortName
```
public App shortName(String shortName)
```
  - getShortName
```
public String getShortName()
```
    A very short label (10 characters or less) for SMS messages and any other highly constrainted contexts.
    
    Returns:
    
    shortName
  - setShortName
```
public void setShortName(String shortName)
```
  - customEvents
```
public App customEvents(Map<String,ActivityEventUpdateType> customEvents)
```
  - putCustomEventsItem
```
public App putCustomEventsItem(String key,
                               ActivityEventUpdateType customEventsItem)
```
  - getCustomEvents
```
public Map<String,ActivityEventUpdateType> getCustomEvents()
```
    Define one or more custom activity events that the client can send to the server, which can be used for scheduling. The key in this map is the eventId, and the value is an enumerated type of update behavior that is allowed for this specific key.
    
    Returns:
    
    customEvents
  - setCustomEvents
```
public void setCustomEvents(Map<String,ActivityEventUpdateType> customEvents)
```
  - automaticCustomEvents
```
public App automaticCustomEvents(Map<String,String> automaticCustomEvents)
```
  - putAutomaticCustomEventsItem
```
public App putAutomaticCustomEventsItem(String key,
                                        String automaticCustomEventsItem)
```
  - getAutomaticCustomEvents
```
public Map<String,String> getAutomaticCustomEvents()
```
    Custom events that should be generated for participant upon enrollment. The key in this map is the eventId, and the value is the offset after the enrollment event (eg, \"P1D\" for one day after enrollment, \"P-2W\" for 2 weeks before enrollment). Note that this API will automatically pre-pend \"custom:\" in front of the event key when generating the eventId (eg, eventId \"studyBurstStart\" becomes event ID \"custom:studyBurstStart\").
    
    Returns:
    
    automaticCustomEvents
  - setAutomaticCustomEvents
```
public void setAutomaticCustomEvents(Map<String,String> automaticCustomEvents)
```
  - autoVerificationEmailSuppressed
```
public App autoVerificationEmailSuppressed(Boolean autoVerificationEmailSuppressed)
```
  - isAutoVerificationEmailSuppressed
```
public Boolean isAutoVerificationEmailSuppressed()
```
    True if the automatic email verification email on sign-up should be suppressed. False if the email should be sent on sign-up. This is generally used in conjunction with email sign-in, where sending a separate email verification email would be redundant.
    
    Returns:
    
    autoVerificationEmailSuppressed
  - setAutoVerificationEmailSuppressed
```
public void setAutoVerificationEmailSuppressed(Boolean autoVerificationEmailSuppressed)
```
  - consentNotificationEmailVerified
```
public App consentNotificationEmailVerified(Boolean consentNotificationEmailVerified)
```
  - isConsentNotificationEmailVerified
```
public Boolean isConsentNotificationEmailVerified()
```
    True if the consent notification email is verified. False if not.
    
    Returns:
    
    consentNotificationEmailVerified
  - setConsentNotificationEmailVerified
```
public void setConsentNotificationEmailVerified(Boolean consentNotificationEmailVerified)
```
  - exporter3Configuration
```
public App exporter3Configuration(Exporter3Configuration exporter3Configuration)
```
  - getExporter3Configuration
```
public Exporter3Configuration getExporter3Configuration()
```
    Configuration required for Exporter 3.0.
    
    Returns:
    
    exporter3Configuration
  - setExporter3Configuration
```
public void setExporter3Configuration(Exporter3Configuration exporter3Configuration)
```
  - exporter3Enabled
```
public App exporter3Enabled(Boolean exporter3Enabled)
```
  - isExporter3Enabled
```
public Boolean isExporter3Enabled()
```
    True if Exporter 3.0 is enabled for this app. Note that enabling Exporter 3.0 does not disable Exporter 2.0.
    
    Returns:
    
    exporter3Enabled
  - setExporter3Enabled
```
public void setExporter3Enabled(Boolean exporter3Enabled)
```
  - fitBitScopes
```
public App fitBitScopes(List<String> fitBitScopes)
```
  - addFitBitScopesItem
```
public App addFitBitScopesItem(String fitBitScopesItem)
```
  - getFitBitScopes
```
public List<String> getFitBitScopes()
```
    List of FitBit scopes that are configured for this app.
    
    Returns:
    
    fitBitScopes
  - setFitBitScopes
```
public void setFitBitScopes(List<String> fitBitScopes)
```
  - installLinks
```
public App installLinks(Map<String,String> installLinks)
```
  - putInstallLinksItem
```
public App putInstallLinksItem(String key,
                               String installLinksItem)
```
  - getInstallLinks
```
public Map<String,String> getInstallLinks()
```
    This can be either to an app store (URLs mapped to the keys \"iOS\" or \"Android\"), or an intermediate web page that will route to a final app or appstore (URLs mapped to the key \"Universal\"). iOS and Android take precedence over the Universal URL.
    
    Returns:
    
    installLinks
  - setInstallLinks
```
public void setInstallLinks(Map<String,String> installLinks)
```
  - participantIpLockingEnabled
```
public App participantIpLockingEnabled(Boolean participantIpLockingEnabled)
```
  - isParticipantIpLockingEnabled
```
public Boolean isParticipantIpLockingEnabled()
```
    True if sessions for unprivileged participant accounts should be locked to an IP address. (Privileged account sessions are _always_ locked to an IP address.)
    
    Returns:
    
    participantIpLockingEnabled
  - setParticipantIpLockingEnabled
```
public void setParticipantIpLockingEnabled(Boolean participantIpLockingEnabled)
```
  - sponsorName
```
public App sponsorName(String sponsorName)
```
  - getSponsorName
```
public String getSponsorName()
```
    The name of the institution or organization that is conducting the app.
    
    Returns:
    
    sponsorName
  - setSponsorName
```
public void setSponsorName(String sponsorName)
```
  - supportEmail
```
public App supportEmail(String supportEmail)
```
  - getSupportEmail
```
public String getSupportEmail()
```
    The email address that will be given to study participants and other end users to contact for support requests. This can be a comma-separated list of email addresses. Email will be sent via this email address.
    
    Returns:
    
    supportEmail
  - setSupportEmail
```
public void setSupportEmail(String supportEmail)
```
  - technicalEmail
```
public App technicalEmail(String technicalEmail)
```
  - getTechnicalEmail
```
public String getTechnicalEmail()
```
    The email address for a technical contact who can coordinate with the Bridge Server team on technical issues (client or server). This can be a comma-separated list of email addresses.
    
    Returns:
    
    technicalEmail
  - setTechnicalEmail
```
public void setTechnicalEmail(String technicalEmail)
```
  - uploadMetadataFieldDefinitions
```
public App uploadMetadataFieldDefinitions(List<UploadFieldDefinition> uploadMetadataFieldDefinitions)
```
  - addUploadMetadataFieldDefinitionsItem
```
public App addUploadMetadataFieldDefinitionsItem(UploadFieldDefinition uploadMetadataFieldDefinitionsItem)
```
  - getUploadMetadataFieldDefinitions
```
public List<UploadFieldDefinition> getUploadMetadataFieldDefinitions()
```
    Metadata fields can be configured for any app. This metadata will be implicitly added to every schema and automatically added to every Synapse table. All metadata field definitions are implicitly optional. The \"required\" field in metadata field definitions is ignored.
    
    Returns:
    
    uploadMetadataFieldDefinitions
  - setUploadMetadataFieldDefinitions
```
public void setUploadMetadataFieldDefinitions(List<UploadFieldDefinition> uploadMetadataFieldDefinitions)
```
  - uploadValidationStrictness
```
public App uploadValidationStrictness(UploadValidationStrictness uploadValidationStrictness)
```
  - getUploadValidationStrictness
```
public UploadValidationStrictness getUploadValidationStrictness()
```
    Get uploadValidationStrictness
    
    Returns:
    
    uploadValidationStrictness
  - setUploadValidationStrictness
```
public void setUploadValidationStrictness(UploadValidationStrictness uploadValidationStrictness)
```
  - consentNotificationEmail
```
public App consentNotificationEmail(String consentNotificationEmail)
```
  - getConsentNotificationEmail
```
public String getConsentNotificationEmail()
```
    Copies of all consent agreements and withdrawals will be emailed to this address. This can be a comma-separated list of email addresses.
    
    Returns:
    
    consentNotificationEmail
  - setConsentNotificationEmail
```
public void setConsentNotificationEmail(String consentNotificationEmail)
```
  - identifier
```
public App identifier(String identifier)
```
  - getIdentifier
```
public String getIdentifier()
```
    A user selected identifier that is unique relative to all other Bridge studies (lower-case letters and dashes only). The identifier serves as a \"domain\" that scopes accounts to that app, and is usually created by combining an institution and app tag or acronym. For example, if you work at the University of Washington and your app is on Asthma in Children, your identifier might be `uw-child-asthma`. Participants will not see this identifier.
    
    Returns:
    
    identifier
  - setIdentifier
```
public void setIdentifier(String identifier)
```
  - version
```
public App version(Long version)
```
  - getVersion
```
public Long getVersion()
```
    A version number used for optimistic locking of the object these keys represent; this value must be passed back to the server on updates. If the version doesn't match the version in the database, an error will be returned (409 Conflict) and the app will not be saved.
    
    Returns:
    
    version
  - setVersion
```
public void setVersion(Long version)
```
  - minAgeOfConsent
```
public App minAgeOfConsent(Integer minAgeOfConsent)
```
  - getMinAgeOfConsent
```
public Integer getMinAgeOfConsent()
```
    The minimum required age for participants in the app. If the user reports they are younger than this age, they will not be allowed to consent to the research.
    
    Returns:
    
    minAgeOfConsent
  - setMinAgeOfConsent
```
public void setMinAgeOfConsent(Integer minAgeOfConsent)
```
  - appIdExcludedInExport
```
public App appIdExcludedInExport(Boolean appIdExcludedInExport)
```
  - isAppIdExcludedInExport
```
public Boolean isAppIdExcludedInExport()
```
    True if the Bridge Exporter should include the appId prefix in the \"originalTable\" field in the appVersion (now \"Health Data Summary\") table in Synapse. This is false for legacy studies for backwards compatibility, but is true for all new studies being created. This can only be changed by a Bridge admin. Care should be taken before changing this setting, as it may partition the data in Synapse.
    
    Returns:
    
    appIdExcludedInExport
  - setAppIdExcludedInExport
```
public void setAppIdExcludedInExport(Boolean appIdExcludedInExport)
```
  - synapseDataAccessTeamId
```
public App synapseDataAccessTeamId(Long synapseDataAccessTeamId)
```
  - getSynapseDataAccessTeamId
```
public Long getSynapseDataAccessTeamId()
```
    Synapse team ID that is granted read access to exported health data records.
    
    Returns:
    
    synapseDataAccessTeamId
  - setSynapseDataAccessTeamId
```
public void setSynapseDataAccessTeamId(Long synapseDataAccessTeamId)
```
  - synapseProjectId
```
public App synapseProjectId(String synapseProjectId)
```
  - getSynapseProjectId
```
public String getSynapseProjectId()
```
    The Synapse project to export health data records to.
    
    Returns:
    
    synapseProjectId
  - setSynapseProjectId
```
public void setSynapseProjectId(String synapseProjectId)
```
  - usesCustomExportSchedule
```
public App usesCustomExportSchedule(Boolean usesCustomExportSchedule)
```
  - isUsesCustomExportSchedule
```
public Boolean isUsesCustomExportSchedule()
```
    **Note: Bridge engineers will normally set this value when setting up data export. You should probably leave this setting as is.** By default, all studies are exported using the default nightly schedule. Some studies may need custom schedules for hourly or on-demand exports. To prevent this app from being exported twice (once by the custom schedule, once by the default schedule), you should set this attribute to true.
    
    Returns:
    
    usesCustomExportSchedule
  - setUsesCustomExportSchedule
```
public void setUsesCustomExportSchedule(Boolean usesCustomExportSchedule)
```
  - userProfileAttributes
```
public App userProfileAttributes(List<String> userProfileAttributes)
```
  - addUserProfileAttributesItem
```
public App addUserProfileAttributesItem(String userProfileAttributesItem)
```
  - getUserProfileAttributes
```
public List<String> getUserProfileAttributes()
```
    Custom attributes that can be added to the StudyParticipant object (as members of the attributes property). For example, if you wished to collect a telephone number for participants and had permission to do so, you could add the \"telephone\" attribute. The map of a user's profile attributes can be personally identifying health information; it will be stored encrypted and in a separate data store from the participant's health data.
    
    Returns:
    
    userProfileAttributes
  - setUserProfileAttributes
```
public void setUserProfileAttributes(List<String> userProfileAttributes)
```
  - taskIdentifiers
```
public App taskIdentifiers(List<String> taskIdentifiers)
```
  - addTaskIdentifiersItem
```
public App addTaskIdentifiersItem(String taskIdentifiersItem)
```
  - getTaskIdentifiers
```
public List<String> getTaskIdentifiers()
```
    An enumerated list of **unique** strings that can be used to identify tasks when creating schedules. These mostly serve to prevent typos when designing schedules, which would prevent client scheduling from working. There's no hard limit on the string content (e.g. \"Tapping Test\" is fine as a task identifier, as long as it uniquely identifies a task known to the application).
    
    Returns:
    
    taskIdentifiers
  - setTaskIdentifiers
```
public void setTaskIdentifiers(List<String> taskIdentifiers)
```
  - dataGroups
```
public App dataGroups(List<String> dataGroups)
```
  - addDataGroupsItem
```
public App addDataGroupsItem(String dataGroupsItem)
```
  - getDataGroups
```
public List<String> getDataGroups()
```
    An enumerated list of **unique** strings that can be assigned to user accounts. This is a list of the \"tags\" that can be assigned to a given user. The specific data groups that *are* assigned to a user will be exported with a participant's health data to Synapse. This can be used to identify test users or specific cohorts in the app, but it should not include sensitive health information about participants. Strings must contain only letters, numbers, underscore or dash, and cannot (as a comma-separated list) exceed the character limit of 100 characters so they can be exported to Synapse.
    
    Returns:
    
    dataGroups
  - setDataGroups
```
public void setDataGroups(List<String> dataGroups)
```
  - passwordPolicy
```
public App passwordPolicy(PasswordPolicy passwordPolicy)
```
  - getPasswordPolicy
```
public PasswordPolicy getPasswordPolicy()
```
    Settings that will govern what is accepted as a valid password when users sign up for the app. If not included, the password policy will default to requiring 8 characters, including lower and upper-case letters, at least one number and at least one symbol.
    
    Returns:
    
    passwordPolicy
  - setPasswordPolicy
```
public void setPasswordPolicy(PasswordPolicy passwordPolicy)
```
  - isActive
```
public Boolean isActive()
```
    Get active
    
    Returns:
    
    active
  - strictUploadValidationEnabled
```
public App strictUploadValidationEnabled(Boolean strictUploadValidationEnabled)
```
  - isStrictUploadValidationEnabled
```
public Boolean isStrictUploadValidationEnabled()
```
    True if uploads in this app should fail on strict validation errors.
    
    Returns:
    
    strictUploadValidationEnabled
  - setStrictUploadValidationEnabled
```
public void setStrictUploadValidationEnabled(Boolean strictUploadValidationEnabled)
```
  - healthCodeExportEnabled
```
public App healthCodeExportEnabled(Boolean healthCodeExportEnabled)
```
  - isHealthCodeExportEnabled
```
public Boolean isHealthCodeExportEnabled()
```
    **Can only be set by an administrator.** Should user health codes be exported as part of the participant roster? This identifies users in the public data set; this can only be set to true for certain studies where users expect to be identified by researchers.
    
    Returns:
    
    healthCodeExportEnabled
  - setHealthCodeExportEnabled
```
public void setHealthCodeExportEnabled(Boolean healthCodeExportEnabled)
```
  - emailVerificationEnabled
```
public App emailVerificationEnabled(Boolean emailVerificationEnabled)
```
  - isEmailVerificationEnabled
```
public Boolean isEmailVerificationEnabled()
```
    **Can only be set by an administrator.** Should users be asked to validate that they control the email addresses they use to sign up for the app? True by default. (Using an email address to send a sign in link will also verify it.)
    
    Returns:
    
    emailVerificationEnabled
  - setEmailVerificationEnabled
```
public void setEmailVerificationEnabled(Boolean emailVerificationEnabled)
```
  - autoVerificationPhoneSuppressed
```
public App autoVerificationPhoneSuppressed(Boolean autoVerificationPhoneSuppressed)
```
  - isAutoVerificationPhoneSuppressed
```
public Boolean isAutoVerificationPhoneSuppressed()
```
    **Can only be set by an administrator.** Should the system send a confirmation SMS message on sign up if phone verification is enabled?
    
    Returns:
    
    autoVerificationPhoneSuppressed
  - setAutoVerificationPhoneSuppressed
```
public void setAutoVerificationPhoneSuppressed(Boolean autoVerificationPhoneSuppressed)
```
  - emailSignInEnabled
```
public App emailSignInEnabled(Boolean emailSignInEnabled)
```
  - isEmailSignInEnabled
```
public Boolean isEmailSignInEnabled()
```
    **Can only be set by an administrator.** If enabled, the user will be able to trigger an email with an URL that can be used to sign into the server, in lieu of a normal sign in process.
    
    Returns:
    
    emailSignInEnabled
  - setEmailSignInEnabled
```
public void setEmailSignInEnabled(Boolean emailSignInEnabled)
```
  - phoneSignInEnabled
```
public App phoneSignInEnabled(Boolean phoneSignInEnabled)
```
  - isPhoneSignInEnabled
```
public Boolean isPhoneSignInEnabled()
```
    **Can only be set by an administrator.** If enabled, the user will be able to trigger an SMS message which contains a token that can be used to sign in to the server, in lieu of a normal sign in process.
    
    Returns:
    
    phoneSignInEnabled
  - setPhoneSignInEnabled
```
public void setPhoneSignInEnabled(Boolean phoneSignInEnabled)
```
  - reauthenticationEnabled
```
public App reauthenticationEnabled(Boolean reauthenticationEnabled)
```
  - isReauthenticationEnabled
```
public Boolean isReauthenticationEnabled()
```
    **Can only be set by an administrator.** Enable or disable the ability to issue a reauthentication token in a session, and call the reauthentication APIs to issue a new session.
    
    Returns:
    
    reauthenticationEnabled
  - setReauthenticationEnabled
```
public void setReauthenticationEnabled(Boolean reauthenticationEnabled)
```
  - externalIdRequiredOnSignup
```
public App externalIdRequiredOnSignup(Boolean externalIdRequiredOnSignup)
```
  - isExternalIdRequiredOnSignup
```
public Boolean isExternalIdRequiredOnSignup()
```
    **Can only be set by an administrator.** Should the external ID be required on sign up? If this is true and external ID validation is enabled, this app can support lab codes (where the username and password are auto-generated from the external ID and the user only needs to enter a code).
    
    Returns:
    
    externalIdRequiredOnSignup
  - setExternalIdRequiredOnSignup
```
public void setExternalIdRequiredOnSignup(Boolean externalIdRequiredOnSignup)
```
  - verifyChannelOnSignInEnabled
```
public App verifyChannelOnSignInEnabled(Boolean verifyChannelOnSignInEnabled)
```
  - isVerifyChannelOnSignInEnabled
```
public Boolean isVerifyChannelOnSignInEnabled()
```
    **Can only be changed by an administrator.** Should the the credential that is submitted during sign-in be verified? This is always true (with the exception of legacy studies) and should not be changed.
    
    Returns:
    
    verifyChannelOnSignInEnabled
  - setVerifyChannelOnSignInEnabled
```
public void setVerifyChannelOnSignInEnabled(Boolean verifyChannelOnSignInEnabled)
```
  - accountLimit
```
public App accountLimit(Integer accountLimit)
```
  - getAccountLimit
```
public Integer getAccountLimit()
```
    **Can only be set by an administrator.** If not zero, sets an upper-bound limit on the number of accounts that can be created for this app. Once this number is reached, no more sign ups or user creation can occur.
    
    Returns:
    
    accountLimit
  - setAccountLimit
```
public void setAccountLimit(Integer accountLimit)
```
  - disableExport
```
public App disableExport(Boolean disableExport)
```
  - isDisableExport
```
public Boolean isDisableExport()
```
    If set this field to true, Bridge Exporter will not export this app at all during exporting.
    
    Returns:
    
    disableExport
  - setDisableExport
```
public void setDisableExport(Boolean disableExport)
```
  - minSupportedAppVersions
```
public App minSupportedAppVersions(Map<String,Integer> minSupportedAppVersions)
```
  - putMinSupportedAppVersionsItem
```
public App putMinSupportedAppVersionsItem(String key,
                                          Integer minSupportedAppVersionsItem)
```
  - getMinSupportedAppVersions
```
public Map<String,Integer> getMinSupportedAppVersions()
```
    Minimum supported app versions (older versions will be blocked), keyed by the name of the operating system (we expect either \"Android\" or \"iPhone OS\" in the User-Agent header of all requests sent to the server). Example: `{\"iPhone OS\":14,\"Android\":10}`
    
    Returns:
    
    minSupportedAppVersions
  - setMinSupportedAppVersions
```
public void setMinSupportedAppVersions(Map<String,Integer> minSupportedAppVersions)
```
  - oAuthProviders
```
public App oAuthProviders(Map<String,OAuthProvider> oAuthProviders)
```
  - putOAuthProvidersItem
```
public App putOAuthProvidersItem(String key,
                                 OAuthProvider oAuthProvidersItem)
```
  - getOAuthProviders
```
public Map<String,OAuthProvider> getOAuthProviders()
```
    The metadata to contact OAuth providers for the Authorization Code Grant Flow.
    
    Returns:
    
    oAuthProviders
  - setOAuthProviders
```
public void setOAuthProviders(Map<String,OAuthProvider> oAuthProviders)
```
  - pushNotificationARNs
```
public App pushNotificationARNs(Map<String,String> pushNotificationARNs)
```
  - putPushNotificationARNsItem
```
public App putPushNotificationARNsItem(String key,
                                       String pushNotificationARNsItem)
```
  - getPushNotificationARNs
```
public Map<String,String> getPushNotificationARNs()
```
    A map between operating system names, and the platform ARN necessary to register a device to receive mobile push notifications. The operating system names are currently \"Android\" and \"iPhone OS\". The ARN (Amazon Resource Name) is the name of the Application/platform ARN defined in SNS (currently this must be done by a Bridge administrator).
    
    Returns:
    
    pushNotificationARNs
  - setPushNotificationARNs
```
public void setPushNotificationARNs(Map<String,String> pushNotificationARNs)
```
  - appleAppLinks
```
public App appleAppLinks(List<AppleAppLink> appleAppLinks)
```
  - addAppleAppLinksItem
```
public App addAppleAppLinksItem(AppleAppLink appleAppLinksItem)
```
  - getAppleAppLinks
```
public List<AppleAppLink> getAppleAppLinks()
```
    The entries this app contributes to the `/.well-known/apple-app-site-association` file to enable universal links for iOS apps that use this app as the data store.
    
    Returns:
    
    appleAppLinks
  - setAppleAppLinks
```
public void setAppleAppLinks(List<AppleAppLink> appleAppLinks)
```
  - androidAppLinks
```
public App androidAppLinks(List<AndroidAppLink> androidAppLinks)
```
  - addAndroidAppLinksItem
```
public App addAndroidAppLinksItem(AndroidAppLink androidAppLinksItem)
```
  - getAndroidAppLinks
```
public List<AndroidAppLink> getAndroidAppLinks()
```
    The entries this app contributes to the `/.well-known/assetlinks.json` file to enable app links for Android apps that use this app as the data store.
    
    Returns:
    
    androidAppLinks
  - setAndroidAppLinks
```
public void setAndroidAppLinks(List<AndroidAppLink> androidAppLinks)
```
  - defaultTemplates
```
public App defaultTemplates(Map<String,String> defaultTemplates)
```
  - putDefaultTemplatesItem
```
public App putDefaultTemplatesItem(String key,
                                   String defaultTemplatesItem)
```
  - getDefaultTemplates
```
public Map<String,String> getDefaultTemplates()
```
    A map between a type of template, and the template revision that should be used as a default if matching templates to a user is ambiguous.
    
    Returns:
    
    defaultTemplates
  - setDefaultTemplates
```
public void setDefaultTemplates(Map<String,String> defaultTemplates)
```
  - getType
```
public String getType()
```
    App
    
    Returns:
    
    type
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class App

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

App

Method Detail

name

getName

setName

shortName

getShortName

setShortName

customEvents

putCustomEventsItem

getCustomEvents

setCustomEvents

automaticCustomEvents

putAutomaticCustomEventsItem

getAutomaticCustomEvents

setAutomaticCustomEvents

autoVerificationEmailSuppressed

isAutoVerificationEmailSuppressed

setAutoVerificationEmailSuppressed

consentNotificationEmailVerified

isConsentNotificationEmailVerified

setConsentNotificationEmailVerified

exporter3Configuration

getExporter3Configuration

setExporter3Configuration

exporter3Enabled

isExporter3Enabled

setExporter3Enabled

fitBitScopes

addFitBitScopesItem

getFitBitScopes

setFitBitScopes

installLinks

putInstallLinksItem

getInstallLinks

setInstallLinks

participantIpLockingEnabled

isParticipantIpLockingEnabled

setParticipantIpLockingEnabled

sponsorName

getSponsorName

setSponsorName

supportEmail

getSupportEmail

setSupportEmail

technicalEmail

getTechnicalEmail

setTechnicalEmail

uploadMetadataFieldDefinitions

addUploadMetadataFieldDefinitionsItem

getUploadMetadataFieldDefinitions

setUploadMetadataFieldDefinitions

uploadValidationStrictness

getUploadValidationStrictness

setUploadValidationStrictness

consentNotificationEmail

getConsentNotificationEmail

setConsentNotificationEmail

identifier

getIdentifier

setIdentifier

version

getVersion

setVersion

minAgeOfConsent

getMinAgeOfConsent

setMinAgeOfConsent

appIdExcludedInExport

isAppIdExcludedInExport

setAppIdExcludedInExport

synapseDataAccessTeamId

getSynapseDataAccessTeamId

setSynapseDataAccessTeamId

synapseProjectId

getSynapseProjectId