Type Alias _NewFormsApp

_NewFormsApp: {
    cachingStrategies?: {
        app?: CacheStrategy;
        singleForm?: CacheStrategy;
    };
    description?: string;
    enableAppUserSignup: boolean;
    enableSamlIdentityProviderLogout?: boolean;
    formsAppEnvironmentId: number;
    googleMapsIntegrationKeyId?: string;
    groups?: {
        name: string;
        notificationEmailAddresses: string[];
    }[];
    hasSamlIdentityProvider: boolean;
    hostname: string;
    isClientLoggingEnabled: boolean;
    isInheritingEnvironmentNotificationEmailAddresses?: boolean;
    name: string;
    notificationEmailAddresses: string[];
    oAuthClientId?: string | null;
    organisationId: string;
    pwaSettings: FormsAppPWASettings;
    recaptchaIntegrationDomainId?: string;
    userSessionValidityInHours?: number;
    userTokensValidityInMinutes?: number;
    welcomeEmail?: {
        body?: string;
        subject?: string;
    };
}

Type declaration

  • OptionalcachingStrategies?: {
        app?: CacheStrategy;
        singleForm?: CacheStrategy;
    }

    Caching strategies for the Forms App

  • Optionaldescription?: string
  • enableAppUserSignup: boolean
  • OptionalenableSamlIdentityProviderLogout?: boolean
  • formsAppEnvironmentId: number

    The exact forms app environment identifier the forms app is associated with

  • OptionalgoogleMapsIntegrationKeyId?: string

    The id of the Google Maps integration key to be used for Google Maps elements.

  • Optionalgroups?: {
        name: string;
        notificationEmailAddresses: string[];
    }[]

    List of groups users can be assigned too and email addresses to be notified via

  • hasSamlIdentityProvider: boolean

    True when using a SAML identity provider

  • hostname: string
  • isClientLoggingEnabled: boolean
  • OptionalisInheritingEnvironmentNotificationEmailAddresses?: boolean

    The email addresses set in notificationEmailAddresses will override the email addresses set at the environment level. Set this flag to true to include the environment level email addresses as well as the email addresses set in notificationEmailAddresses.

  • name: string

    Name of the forms app

  • notificationEmailAddresses: string[]

    Array of emails addresses to be notified when an error occurs in processing submission events

  • OptionaloAuthClientId?: string | null

    The identifier of the OAuth Client for the forms app

  • organisationId: string

    The exact organisation identifier the forms app is associated with

  • pwaSettings: FormsAppPWASettings

    Forms App progressive web app setting

  • OptionalrecaptchaIntegrationDomainId?: string

    The id of the recaptcha integration to be used

  • OptionaluserSessionValidityInHours?: number

    The number of hours a user's session will last before they have to log in again. These tokens will get revoked when logging out. Defaults to 30 days.

  • OptionaluserTokensValidityInMinutes?: number

    The number of minutes a user's token for communicating with servers will last. These tokens do not get revoked when logging out so a shorter time period is desireable. Defaults to 1 hour.

  • OptionalwelcomeEmail?: {
        body?: string;
        subject?: string;
    }

    Forms App custom welcome email properties

    • Optionalbody?: string

      A mustache template to use when sending welcome emails to new app users.

    • Optionalsubject?: string

      The subject to use when sending welcome emails to new app users

Settings

Member Visibility