Squid.getInstance constructor

Implementation

factory Squid.getInstance({
  /// The application ID that is used to identify the application in Squid.
  /// The ID can be found in the Squid Cloud Console.
  required AppId appId,

  /// The application API key, using the API key can be used to bypass security
  /// rules and other restrictions. The API key can be found in the
  /// Squid Cloud Console.
  required SupportedSquidRegion region,

  /// The region that the application is running in. This is used to determine
  /// the URL of the Squid Cloud API.
  ApiKey? apiKey,

  /// The environment ID to work with, if not specified the default
  /// environment (prod) will be used.
  EnvironmentId? environmentId,

  ///The user ID of the developer that runs the environment locally.
  SquidDeveloperId? squidDeveloperId,

  /// A function that can be used to wrap messages coming from Squid to the
  /// application. This is useful for different frameworks that need to wrap
  /// messages in order to detect changes (like Angular).
  MessageNotificationWrapper? messageNotificationWrapper,

  /// A list of API endpoints that can be used for overriding the default API
  /// endpoints for the different integrations. This is useful for APIs that
  /// have multiple base urls hosted in different regions.
  Map<IntegrationId, String>? apiServerUrlOverrideMapping,
}) {
  final options = SquidOptions(
      appId: appId,
      region: region,
      apiKey: apiKey,
      environmentId: environmentId,
      squidDeveloperId: squidDeveloperId,
      messageNotificationWrapper: messageNotificationWrapper,
      apiServerUrlOverrideMapping: apiServerUrlOverrideMapping);
  if (_instances.containsKey(options)) {
    return _instances[options]!;
  }
  final instance = Squid(options);
  _instances[options] = instance;
  return instance;
}