Package com.adjust.sdk
Class AdjustInstance
java.lang.Object
com.adjust.sdk.AdjustInstance
Class used to forward instructions to SDK which user gives as part of Adjust class interface.
- Since:
- 12th April 2014
-
Nested Class Summary
Nested Classes -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddSessionCallbackParameter(String key, String value)Called to add global callback parameter that will be sent with each session and event.voidaddSessionPartnerParameter(String key, String value)Called to add global partner parameter that will be sent with each session and event.voidappWillOpenUrl(android.net.Uri url)Called to process deep link.voidappWillOpenUrl(android.net.Uri url, android.content.Context context)Called to process deep link.voiddisableThirdPartySharing(android.content.Context context)Called to disable the third party sharing.voidgdprForgetMe(android.content.Context context)Called to forget the user in accordance with GDPR law.getAdid()Called to get value of unique Adjust device identifier.Called to get user's current attribution value.Called to get native SDK version string.booleanGet information if SDK is enabled or not.voidonCreate(AdjustConfig adjustConfig)Called upon SDK initialisation.voidonPause()Called upon each Activity's onPause() method call.voidonResume()Called upon each Activity's onResume() method call.voidCalled to remove global callback parameter from session and event packages.voidCalled to remove global partner parameter from session and event packages.voidCalled to remove all added global callback parameters.voidCalled to remove all added global partner parameters.voidCalled if SDK initialisation was delayed and you would like to stop waiting for timer.voidsendPreinstallReferrer(String referrer, android.content.Context context)Called to process preinstall payload information sent with SYSTEM_INSTALLER_REFERRER intent.voidsendReferrer(String rawReferrer, android.content.Context context)Called to process referrer information sent with INSTALL_REFERRER intent.voidsetEnabled(boolean enabled)Called to disable/enable SDK.voidsetOfflineMode(boolean enabled)Called to set SDK to offline or online mode.voidsetPushToken(String token)Called to set user's push notifications token.voidsetPushToken(String token, android.content.Context context)Called to set user's push notifications token.voidsetTestOptions(AdjustTestOptions testOptions)Used for testing purposes only.voidteardown()Called to teardown SDK state.voidtrackAdRevenue(AdjustAdRevenue adjustAdRevenue)Track ad revenue from a source providervoidtrackAdRevenue(String source, org.json.JSONObject adRevenueJson)Track ad revenue from a source providervoidtrackEvent(AdjustEvent event)Called to track event.voidtrackMeasurementConsent(boolean consentMeasurement)voidtrackPlayStoreSubscription(AdjustPlayStoreSubscription subscription)Track subscription from Google Play.voidtrackThirdPartySharing(AdjustThirdPartySharing adjustThirdPartySharing)
-
Constructor Details
-
AdjustInstance
public AdjustInstance()
-
-
Method Details
-
onCreate
Called upon SDK initialisation.- Parameters:
adjustConfig- AdjustConfig object used for SDK initialisation
-
trackEvent
Called to track event.- Parameters:
event- AdjustEvent object to be tracked
-
onResume
public void onResume()Called upon each Activity's onResume() method call. -
onPause
public void onPause()Called upon each Activity's onPause() method call. -
setEnabled
public void setEnabled(boolean enabled)Called to disable/enable SDK.- Parameters:
enabled- boolean indicating whether SDK should be enabled or disabled
-
isEnabled
public boolean isEnabled()Get information if SDK is enabled or not.- Returns:
- boolean indicating whether SDK is enabled or not
-
appWillOpenUrl
public void appWillOpenUrl(android.net.Uri url)Called to process deep link.- Parameters:
url- Deep link URL to process
-
appWillOpenUrl
public void appWillOpenUrl(android.net.Uri url, android.content.Context context)Called to process deep link.- Parameters:
url- Deep link URL to processcontext- Application context
-
sendReferrer
Called to process referrer information sent with INSTALL_REFERRER intent.- Parameters:
rawReferrer- Raw referrer contentcontext- Application context
-
sendPreinstallReferrer
Called to process preinstall payload information sent with SYSTEM_INSTALLER_REFERRER intent.- Parameters:
referrer- Preinstall referrer contentcontext- Application context
-
setOfflineMode
public void setOfflineMode(boolean enabled)Called to set SDK to offline or online mode.- Parameters:
enabled- boolean indicating should SDK be in offline mode (true) or not (false)
-
sendFirstPackages
public void sendFirstPackages()Called if SDK initialisation was delayed and you would like to stop waiting for timer. -
addSessionCallbackParameter
Called to add global callback parameter that will be sent with each session and event.- Parameters:
key- Global callback parameter keyvalue- Global callback parameter value
-
addSessionPartnerParameter
Called to add global partner parameter that will be sent with each session and event.- Parameters:
key- Global partner parameter keyvalue- Global partner parameter value
-
removeSessionCallbackParameter
Called to remove global callback parameter from session and event packages.- Parameters:
key- Global callback parameter key
-
removeSessionPartnerParameter
Called to remove global partner parameter from session and event packages.- Parameters:
key- Global partner parameter key
-
resetSessionCallbackParameters
public void resetSessionCallbackParameters()Called to remove all added global callback parameters. -
resetSessionPartnerParameters
public void resetSessionPartnerParameters()Called to remove all added global partner parameters. -
teardown
public void teardown()Called to teardown SDK state. Used only for Adjust tests, shouldn't be used in client apps. -
setPushToken
Called to set user's push notifications token.- Parameters:
token- Push notifications token
-
setPushToken
Called to set user's push notifications token.- Parameters:
token- Push notifications tokencontext- Application context
-
gdprForgetMe
public void gdprForgetMe(android.content.Context context)Called to forget the user in accordance with GDPR law.- Parameters:
context- Application context
-
disableThirdPartySharing
public void disableThirdPartySharing(android.content.Context context)Called to disable the third party sharing.- Parameters:
context- Application context
-
trackThirdPartySharing
-
trackMeasurementConsent
public void trackMeasurementConsent(boolean consentMeasurement) -
trackAdRevenue
Track ad revenue from a source provider- Parameters:
source- Source of ad revenue information, see AdjustConfig.AD_REVENUE_* for some possible sourcesadRevenueJson- JsonObject content of the ad revenue information
-
trackAdRevenue
Track ad revenue from a source provider- Parameters:
adjustAdRevenue- Adjust ad revenue information like source, revenue, currency etc
-
trackPlayStoreSubscription
Track subscription from Google Play.- Parameters:
subscription- AdjustPlayStoreSubscription object to be tracked
-
getAdid
Called to get value of unique Adjust device identifier.- Returns:
- Unique Adjust device indetifier
-
getAttribution
Called to get user's current attribution value.- Returns:
- AdjustAttribution object with current attribution value
-
getSdkVersion
Called to get native SDK version string.- Returns:
- Native SDK version string.
-
setTestOptions
Used for testing purposes only. Do NOT use this method.- Parameters:
testOptions- Adjust integration tests options
-