app_group_container_url 0.0.1

Resolve and manage subdirectories in Apple App Group containers on iOS and macOS.

app_group_container_url

Flutter plugin for resolving and managing subdirectories in an Apple App Group container on iOS and macOS.

Supported platforms

iOS and macOS.

Setup

Enable the App Groups capability for the iOS or macOS target in Xcode, then add the group identifier used by your app, such as group.com.yourcompany.yourapp. The identifier passed to this plugin must match that entitlement.

Usage

import 'package:app_group_container_url/app_group_container_url.dart';

final appGroup = AppGroupContainerUrl();
const appGroupID = 'group.com.yourcompany.yourapp';
const subDir = 'shared-cache';

final url = await appGroup.getUrl(appGroupID, subDir);
final path = await appGroup.getPath(appGroupID, subDir);
final deleted = await appGroup.delete(appGroupID, subDir);

API

getUrl(appGroupID, subDir) returns the subdirectory as a file URL string, or null when the App Group container cannot be resolved or subDir is invalid.

getPath(appGroupID, subDir) returns the subdirectory's filesystem path, or null under the same conditions.

delete(appGroupID, subDir) deletes the requested subdirectory and its contents. It returns true when deletion succeeds, including when the subdirectory does not exist, and throws a PlatformException when the deletion fails.

subDir must be non-empty and must resolve within the App Group container. Paths that attempt to escape the container, such as ../other-directory, are rejected.