Skip to content

Commit 297ae88

Browse files
authored
fix(unity) clarify offline default value (#5510)
1 parent 76ba84a commit 297ae88

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

src/platforms/common/configuration/options.mdx

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -536,15 +536,35 @@ Configures a separate proxy for outgoing HTTPS requests. This value might not be
536536

537537
</ConfigKey>
538538

539-
<ConfigKey name="cache-directory-path" supported={["dotnet", "android"]}>
539+
<ConfigKey name="cache-directory-path" supported={["dotnet", "android", "unity"]}>
540540

541541
Specifies a local directory used for caching payloads. When this option is enabled (that is, when the directory is set), the Sentry SDK will persist envelopes locally before sending to Sentry. This configuration option is particularly useful if you expect your application to run in environments where internet connectivity is limited.
542542

543+
</ConfigKey>
544+
545+
<PlatformSection supported={["android"]}>
546+
547+
Default: set to `android.content.Context.getCacheDir()/sentry`.
548+
549+
</PlatformSection>
550+
551+
<PlatformSection supported={["dotnet"]} notSupported={["dotnet.xamarin", "dotnet.maui", "unity"]}>
552+
543553
Default: not set (caching is disabled).
544554

545-
Client SDKs built on top of the Sentry SDK for .NET, such Xamarin and Unity, have this feature enabled by default. For example in Unity, the default value is `Application.persistentDataPath`. You can disable offline caching by setting it to `null`.
555+
</PlatformSection>
556+
557+
<PlatformSection supported={["unity"]}>
546558

547-
</ConfigKey>
559+
The default value is `Application.persistentDataPath`. You can disable offline caching by setting it to `null`.
560+
561+
</PlatformSection>
562+
563+
<PlatformSection supported={["dotnet.xamarin", "dotnet.maui"]}>
564+
565+
The default value is `Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData));`
566+
567+
</PlatformSection>
548568

549569
<ConfigKey name="init-cache-flush-timeout" supported={["dotnet"]}>
550570

0 commit comments

Comments
 (0)