Skip to content

Commit

Permalink
feat(docs): Update all invocation links Unity
Browse files Browse the repository at this point in the history
  • Loading branch information
Sporiff committed Oct 26, 2023
1 parent 79b7e61 commit 887993f
Show file tree
Hide file tree
Showing 23 changed files with 140 additions and 69 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ slug: en/sdk/ios/configuration/deep-links/direct
sidebar-position: 3
---

# Set up direct deep linking

You can configure deep linking in your app after you have set it up in the Adjust dashboard. **Direct deep linking** occurs when a user has your app installed on their device. The link takes the user to a specific page within your app.

To enable deep linking, you need to do the following:
Expand Down
6 changes: 4 additions & 2 deletions src/content/docs/en/sdk/unity/configuration/att.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ slug: en/sdk/unity/configuration/att

import RequestTrackingAuthorization from "@unity-examples/Adjust/requestTrackingAuthorization.mdx"
import AppTrackingAuthorizationStatus from "@unity-examples/Adjust/appTrackingAuthorizationStatus.mdx"
import AppTrackingAuthorizationStatusSig from "@unity-signatures/Adjust/appTrackingAuthorizationStatus.mdx"
import CheckForNewAttStatus from "@unity-examples/Adjust/checkForNewAttStatus.mdx"
import CheckForNewAttStatusSig from "@unity-signatures/Adjust/checkForNewAttStatus.mdx"

If you want to record the device's <Abbr>IDFA (ID for Advertisers)</Abbr>, you must display a prompt to get your user's authorization. To do this, you need to include Apple's <Abbr>ATT (App Tracking Transparency)</Abbr> framework in your app. The Adjust SDK stores the user's authorization status and sends it to Adjust's servers with each request.

Expand Down Expand Up @@ -76,7 +78,7 @@ Adjust.requestTrackingAuthorizationWithCompletionHandler((status) =>

## Get current authorization status

You can retrieve a user's current authorization status at any time. Call the [`appTrackingAuthorizationStatus` method](#ios-apptrackingauthorizationstatus-invocation) to return the authorization status code as an **integer**.
You can retrieve a user's current authorization status at any time. Call the <Tooltip>`appTrackingAuthorizationStatus` method || <AppTrackingAuthorizationStatusSig /></Tooltip> to return the authorization status code as an **integer**.

<AppTrackingAuthorizationStatus />

Expand All @@ -95,6 +97,6 @@ Adjust.addSessionPartnerParameter("status", authorizationStatus);

## Check for authorization status changes

If you use a custom ATT prompt, you need to inform the Adjust SDK of changes to the user's authorization status. Call the [`checkForNewAttStatus` method](#ios-checkfornewattstatus-invocation) to send the authorization status to Adjust's servers.
If you use a custom ATT prompt, you need to inform the Adjust SDK of changes to the user's authorization status. Call the <Tooltip>`checkForNewAttStatus` method || <CheckForNewAttStatusSig /></Tooltip> to send the authorization status to Adjust's servers.

<CheckForNewAttStatus />
3 changes: 2 additions & 1 deletion src/content/docs/en/sdk/unity/configuration/background.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,11 @@ slug: en/sdk/unity/configuration/background
---

import SetSendInBackground from "@unity-examples/AdjustConfig/sendInBackground.mdx"
import SetSendInBackgroundSig from "@unity-signatures/AdjustConfig/sendInBackground.mdx"

By default, the Adjust SDK pauses the sending of requests when your app is running in the background. You can configure the SDK to send requests in the background by enabling the background recording feature.

Your config object contains a boolean `sendInBackground` property that controls this behavior. You can set this property by calling the [`setSendInBackground` method](#ios-setsendinbackground-invocation) on your config instance with a boolean value.
Your config object contains a boolean `sendInBackground` property that controls this behavior. You can set this property by calling the <Tooltip>`setSendInBackground` method || <SetSendInBackgroundSig /></Tooltip> on your config instance with a boolean value.

<Callout type="important">

Expand Down
6 changes: 4 additions & 2 deletions src/content/docs/en/sdk/unity/configuration/deep-links.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ slug: en/sdk/unity/configuration/deep-links
---

import SetLinkMeEnabled from "@unity-examples/AdjustConfig/setLinkMeEnabled.mdx"
import SetLinkMeEnabledSig from "@unity-signatures/AdjustConfig/setLinkMeEnabled.mdx"
import SetLaunchDeferredDeeplink from "@unity-examples/AdjustConfig/setLaunchDeferredDeeplink.mdx"
import SetLaunchDeferredDeeplinkSig from "@unity-signatures/AdjustConfig/setLaunchDeferredDeeplink.mdx"

Deep links are <Abbr>URIs (Uniform Resource Identifiers)</Abbr> that direct users to a specific page in your app without any additional navigation. You can use them throughout your marketing funnel to improve user acquisition, engagement, and retention.

Expand Down Expand Up @@ -64,7 +66,7 @@ Android devices use a unique URI scheme to handle deep links. To set up deep lin

### Disable deferred deep linking

The SDK opens deferred deep links by default. You can configure this by passing a **boolean** argument to the [`setLaunchDeferredDeeplink` method](#unity-setlaunchdeferreddeeplink-invocation).
The SDK opens deferred deep links by default. You can configure this by passing a **boolean** argument to the <Tooltip>`setLaunchDeferredDeeplink` method || <SetLaunchDeferredDeeplinkSig /></Tooltip>.

<SetLaunchDeferredDeeplink />

Expand Down Expand Up @@ -113,6 +115,6 @@ The Adjust SDK checks the pasteboard when a user opens the app for the first tim

When a user clicks on a LinkMe URL they have the option to copy the link information to their system pasteboard. You can use the Adjust SDK to read the system pasteboard for deep link information. If deep link information is present, the SDK forwards the user to the correct page in your app.

To enable pasteboard checking in your app, pass a true value to the [`setLinkMeEnabled` method](#unity-setlinkmeenabled-invocation) on your config object:
To enable pasteboard checking in your app, pass a true value to the <Tooltip>`setLinkMeEnabled` method || <SetLinkMeEnabledSig /></Tooltip> on your config object:

<SetLinkMeEnabled />
6 changes: 4 additions & 2 deletions src/content/docs/en/sdk/unity/configuration/delay.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ slug: en/sdk/unity/configuration/delay
---

import SetOfflineMode from "@unity-examples/Adjust/setOfflineMode.mdx"
import SetOfflineModeSig from "@unity-signatures/Adjust/setOfflineMode.mdx"
import SetEventBufferingEnabled from "@unity-examples/AdjustConfig/setEventBufferingEnabled.mdx"
import SetEventBufferingEnabledSig from "@unity-signatures/AdjustConfig/setEventBufferingEnabled.mdx"

<Callout type="important">

Expand All @@ -15,14 +17,14 @@ The offline mode setting isn't remembered between sessions. Offline mode is disa

The Adjust SDK sends event and session data to Adjust's servers in real time. You can pause the sending of information by putting the SDK in offline mode. In offline mode the SDK stores all data in a local file on the device. The SDK sends this information to Adjust's servers when you disable offline mode.

Your config object contains a boolean `isOffline` property that controls this behavior. You can update this property at any time by calling the [`setOfflineMode` method](#ios-setofflinemode-invocation) with a boolean argument. The SDK sends all saved information to Adjust's servers when you deactivate offline mode.
Your config object contains a boolean `isOffline` property that controls this behavior. You can update this property at any time by calling the <Tooltip>`setOfflineMode` method || <SetOfflineModeSig /></Tooltip> with a boolean argument. The SDK sends all saved information to Adjust's servers when you deactivate offline mode.

<SetOfflineMode />

## Event buffering

The Adjust SDK sends event information as soon as a user triggers an event in your app. You can send event information on a schedule by enabling event buffering. Event buffering stores events in a local buffer on the device and sends all requests once per minute.

Your config object contains a boolean `eventBufferingEnabled` property that controls this behavior. You can set this property by calling the [`setEventBufferingEnabled` method](#ios-seteventbufferingenabled-invocation) on your config object with a boolean argument.
Your config object contains a boolean `eventBufferingEnabled` property that controls this behavior. You can set this property by calling the <Tooltip>`setEventBufferingEnabled` method || <SetEventBufferingEnabledSig /></Tooltip> on your config object with a boolean argument.

<SetEventBufferingEnabled />
6 changes: 4 additions & 2 deletions src/content/docs/en/sdk/unity/configuration/disable.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@ slug: en/sdk/unity/configuration/disable
---

import SetEnabled from "@unity-examples/Adjust/setEnabled.mdx"
import SetEnabledSig from "@unity-signatures/Adjust/setEnabled.mdx"
import IsEnabled from "@unity-examples/Adjust/isEnabled.mdx"
import IsEnabledSig from "@unity-signatures/Adjust/isEnabled.mdx"

The Adjust SDK runs by default when your app is open. You can disable and re-enable the Adjust SDK to pause and resume recording. When you disable the Adjust SDK, it doesn't send any data to Adjust's servers.

You can enable or disable the SDK at any time by calling the [`setEnabled` method](#ios-setenabled-invocation) with a boolean argument.
You can enable or disable the SDK at any time by calling the <Tooltip>`setEnabled` method || <SetEnabledSig /></Tooltip> with a boolean argument.

<Callout type="important">

Expand All @@ -21,7 +23,7 @@ You can only call this method after the first session. This setting persists bet

## Check enabled status

You can check if the Adjust SDK is enabled at any time by calling the [`isEnabled` method](#ios-isenabled-invocation). This method returns a boolean value.
You can check if the Adjust SDK is enabled at any time by calling the <Tooltip>`isEnabled` method || <IsEnabledSig /></Tooltip>. This method returns a boolean value.

<IsEnabled />

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ slug: en/sdk/unity/configuration/external-device-id
---

import SetExternalDeviceId from "@unity-examples/AdjustConfig/setExternalDeviceId.mdx"
import SetExternalDeviceIdSig from "@unity-signatures/AdjustConfig/setExternalDeviceId.mdx"

An external device identifier is a custom value that you can assign to a device or user. They help you recognize users across sessions and platforms. They can also help you deduplicate installs by user so that a user isn't counted as duplicate new installs. Contact your Adjust representative to get started with external device IDs.

Expand All @@ -16,7 +17,7 @@ See the [External device identifiers article](https://help.adjust.com/en/article

</Callout>

Your config object contains a **string** `externalDeviceId` property that you can use to store your external device ID. You can set property calling the [`setExternalDeviceId` method](#ios-setexternaldeviceid-invocation) with your ID as an argument.
Your config object contains a **string** `externalDeviceId` property that you can use to store your external device ID. You can set property calling the <Tooltip>`setExternalDeviceId` method || <SetExternalDeviceIdSig /></Tooltip> with your ID as an argument.

<Callout type="important">

Expand Down
6 changes: 4 additions & 2 deletions src/content/docs/en/sdk/unity/configuration/log-level.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ slug: en/sdk/unity/configuration/log-level
---

import SetLogLevel from "@unity-examples/AdjustConfig/setLogLevel.mdx";
import SetLogLevelSig from "@unity-signatures/AdjustConfig/setLogLevel.mdx";
import SetLogDelegate from "@unity-examples/AdjustConfig/setLogDelegate.mdx";
import SetLogDelegateSig from "@unity-signatures/AdjustConfig/setLogDelegate.mdx";

The Adjust SDK provides configurable log levels to return different amounts of information. The following log levels are available:

Expand All @@ -23,7 +25,7 @@ The Adjust SDK provides configurable log levels to return different amounts of i

</Table>

You can set your log level by calling the [`setLogLevel` method](#ios-setloglevel-invocation) on your `AdjustConfig` instance.
You can set your log level by calling the <Tooltip>`setLogLevel` method || <SetLogLevelSig /></Tooltip> on your `AdjustConfig` instance.

<SetLogLevel />

Expand All @@ -43,7 +45,7 @@ Adjust.start(adjustConfig);

If your target is Windows-based and you want to see the compiled logs from the SDK in **Production** mode, redirect the log output to your app while testing it in **Sandbox** mode.

To register a log delegate, call the [`setLogDelegate` method](#unity-setlogdelegate-invocation) on your `AdjustConfig` instance.
To register a log delegate, call the <Tooltip>`setLogDelegate` method || <SetLogDelegateSig /></Tooltip> on your `AdjustConfig` instance.

<Callout type="important">

Expand Down
9 changes: 6 additions & 3 deletions src/content/docs/en/sdk/unity/configuration/preinstalled.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,15 @@ slug: en/sdk/unity/configuration/preinstalled
---

import SetPreinstallTrackingEnabled from "@unity-examples/AdjustConfig/setPreinstallTrackingEnabled.mdx"
import SetPreinstallTrackingEnabledSig from "@unity-signatures/AdjustConfig/setPreinstallTrackingEnabled.mdx"
import SetPreinstallFilePath from "@unity-examples/AdjustConfig/setPreinstallFilePath.mdx"
import SetPreinstallFilePathSig from "@unity-signatures/AdjustConfig/setPreinstallFilePath.mdx"
import SetDefaultTracker from "@unity-examples/AdjustConfig/setDefaultTracker.mdx"
import SetDefaultTrackerSig from "@unity-signatures/AdjustConfig/setDefaultTracker.mdx"

You can use the Adjust SDK to record activity from apps that came preinstalled on a user's device. This enables you to send information from users who didn't download your app from a campaign.

Your config object contains a **boolean** `preinstallTrackingEnabled` property that controls this feature. To enable preinstall measurement, call the [`setPreinstallTrackingEnabled` method](#unity-setpreinstalltrackingenabled-invocation) with a `true` argument.
Your config object contains a **boolean** `preinstallTrackingEnabled` property that controls this feature. To enable preinstall measurement, call the <Tooltip>`setPreinstallTrackingEnabled` method || <SetPreinstallTrackingEnabledSig /></Tooltip> with a `true` argument.

<SetPreinstallTrackingEnabled />

Expand Down Expand Up @@ -64,7 +67,7 @@ To set up the receiver, add the following to your `AndroidManifest.xml` file.

Save attribution information for your preinstalled app in a world-readable directory. The SDK reads the information from this file at install to attribute the user. The system encryption protocol protects app data.

Pass the file path at which your preinstall information can be found to the [`setPreinstallFilePath` method](#unity-setpreinstallfilepath-invocation) to give the Adjust SDK access to the information.
Pass the file path at which your preinstall information can be found to the <Tooltip>`setPreinstallFilePath` method || <SetPreinstallFilePathSig /></Tooltip> to give the Adjust SDK access to the information.

<SetPreinstallFilePath />

Expand All @@ -78,7 +81,7 @@ Configuring a default campaign enables you to attribute all preinstalls to a pre
https://app.adjust.com/{token}
```

2. Copy this token and pass it to the [`setDefaultTracker` method](#ios-setdefaulttracker-invocation) in your app delegate file.
2. Copy this token and pass it to the <Tooltip>`setDefaultTracker` method || <SetDefaultTrackerSig /></Tooltip> in your app delegate file.

<SetDefaultTracker />

Expand Down
Loading

0 comments on commit 887993f

Please sign in to comment.