Type alias InitialiseOptions

InitialiseOptions: {
    credential?: {
        compact?: {
            issuerResolverTtl?: number;
            revocationListTtl?: number;
        };
        compactSemantic?: {
            issuerResolverTtl?: number;
            revocationListTtl?: number;
        };
        webSemantic?: {
            contextValidatorMaxDepth?: number;
            inlineContextAllowAny?: boolean;
            remoteContextUrlAllowAny?: boolean;
            remoteContextUrlAllowList?: readonly string[];
        };
    };
    ecosystem?: {
        url?: string;
    };
    extensions?: readonly (MobileCredentialHolder | EcosystemService)[];
    httpRequestTimeoutMs?: number;
    instanceId?: string;
    userAuthRequiredOnInitialise?: boolean;
}

Options to configure when initialise a wallet

Type declaration

  • Optional credential?: {
        compact?: {
            issuerResolverTtl?: number;
            revocationListTtl?: number;
        };
        compactSemantic?: {
            issuerResolverTtl?: number;
            revocationListTtl?: number;
        };
        webSemantic?: {
            contextValidatorMaxDepth?: number;
            inlineContextAllowAny?: boolean;
            remoteContextUrlAllowAny?: boolean;
            remoteContextUrlAllowList?: readonly string[];
        };
    }

    Configurations for credential operations

    • Optional compact?: {
          issuerResolverTtl?: number;
          revocationListTtl?: number;
      }

      Configurations for compact credential operations

      • Optional issuerResolverTtl?: number

        Duration that an issuer is kept in the cache after it is added or re-added

      • Optional revocationListTtl?: number

        Duration that a revocation list is kept in the cache after it is added or re-added

    • Optional compactSemantic?: {
          issuerResolverTtl?: number;
          revocationListTtl?: number;
      }

      Configurations for compact-semantic credential operations

      • Optional issuerResolverTtl?: number

        Duration that an issuer is kept in the cache after it is added or re-added

      • Optional revocationListTtl?: number

        Duration that a revocation list is kept in the cache after it is added or re-added

    • Optional webSemantic?: {
          contextValidatorMaxDepth?: number;
          inlineContextAllowAny?: boolean;
          remoteContextUrlAllowAny?: boolean;
          remoteContextUrlAllowList?: readonly string[];
      }
      • Optional contextValidatorMaxDepth?: number

        The maximum depth to validate contexts, default is 10

      • Optional inlineContextAllowAny?: boolean

        WARNING: Defaults to false (off). It is highly recommended not to set to true (on) unless explicitly required for specific use cases.

      • Optional remoteContextUrlAllowAny?: boolean

        WARNING: Defaults to false (off). It is highly recommended not to set to true (on) unless explicitly required for specific use cases.

      • Optional remoteContextUrlAllowList?: readonly string[]

        Configure the allowed remote context urls

  • Optional ecosystem?: {
        url?: string;
    }

    Configurations for ecosystem operations

    • Optional url?: string
  • Optional extensions?: readonly (MobileCredentialHolder | EcosystemService)[]

    A list of extension modules to enable additional features.

  • Optional httpRequestTimeoutMs?: number

    The number of milliseconds a request can take before automatically being terminated. The default value is 5000.

  • Optional instanceId?: string

    Specifies the wallet ID to use

  • Optional userAuthRequiredOnInitialise?: boolean

    Whether user authetication (biometric or passcode) is required to unlock the storage. The SDK cannot accept further changes to this option with a particular instance id.

    An MobileCredentialHolderError.UserAuthenticationOnInitChanged error will be returned if this option is changed for an existing wallet.

    Default Value

    true

Settings

Member Visibility

Theme

Generated using TypeDoc