Java doc for Mobile SDK 12.1.0

forcedotcom · Aug 15, 2024 · cf757db · cf757db
1 parent cf55b51
commit cf757db
Show file tree

Hide file tree

Showing 493 changed files with 2,737 additions and 1,485 deletions.
diff --git a/allclasses-frame.html b/allclasses-frame.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_292) on Mon May 06 16:03:30 PDT 2024 -->
+<!-- Generated by javadoc (1.8.0_292) on Thu Aug 15 13:38:24 PDT 2024 -->
 <title>All Classes</title>
-<meta name="date" content="2024-05-06">
+<meta name="date" content="2024-08-15">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
@@ -83,7 +83,6 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="com/salesforce/androidsdk/smartstore/ui/KeyValueStoreInspectorActivity.html" title="class in com.salesforce.androidsdk.smartstore.ui" target="classFrame">KeyValueStoreInspectorActivity</a></li>
 <li><a href="com/salesforce/androidsdk/config/LoginServerManager.html" title="class in com.salesforce.androidsdk.config" target="classFrame">LoginServerManager</a></li>
 <li><a href="com/salesforce/androidsdk/config/LoginServerManager.LoginServer.html" title="class in com.salesforce.androidsdk.config" target="classFrame">LoginServerManager.LoginServer</a></li>
-<li><a href="com/salesforce/androidsdk/util/LogoutCompleteReceiver.html" title="class in com.salesforce.androidsdk.util" target="classFrame">LogoutCompleteReceiver</a></li>
 <li><a href="com/salesforce/androidsdk/smartstore/store/LongOperation.html" title="class in com.salesforce.androidsdk.smartstore.store" target="classFrame">LongOperation</a></li>
 <li><a href="com/salesforce/androidsdk/smartstore/store/LongOperation.LongOperationType.html" title="enum in com.salesforce.androidsdk.smartstore.store" target="classFrame">LongOperation.LongOperationType</a></li>
 <li><a href="com/salesforce/androidsdk/util/ManagedFilesHelper.html" title="class in com.salesforce.androidsdk.util" target="classFrame">ManagedFilesHelper</a></li>
@@ -95,6 +94,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="com/salesforce/androidsdk/mobilesync/app/MobileSyncSDKManager.html" title="class in com.salesforce.androidsdk.mobilesync.app" target="classFrame">MobileSyncSDKManager</a></li>
 <li><a href="com/salesforce/androidsdk/auth/OAuth2.html" title="class in com.salesforce.androidsdk.auth" target="classFrame">OAuth2</a></li>
 <li><a href="com/salesforce/androidsdk/auth/OAuth2.IdServiceResponse.html" title="class in com.salesforce.androidsdk.auth" target="classFrame">OAuth2.IdServiceResponse</a></li>
+<li><a href="com/salesforce/androidsdk/auth/OAuth2.LogoutReason.html" title="enum in com.salesforce.androidsdk.auth" target="classFrame">OAuth2.LogoutReason</a></li>
 <li><a href="com/salesforce/androidsdk/auth/OAuth2.OAuthFailedException.html" title="class in com.salesforce.androidsdk.auth" target="classFrame">OAuth2.OAuthFailedException</a></li>
 <li><a href="com/salesforce/androidsdk/auth/OAuth2.TokenEndpointResponse.html" title="class in com.salesforce.androidsdk.auth" target="classFrame">OAuth2.TokenEndpointResponse</a></li>
 <li><a href="com/salesforce/androidsdk/auth/OAuth2.TokenErrorResponse.html" title="class in com.salesforce.androidsdk.auth" target="classFrame">OAuth2.TokenErrorResponse</a></li>
@@ -128,6 +128,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="com/salesforce/androidsdk/ui/SalesforceActivityInterface.html" title="interface in com.salesforce.androidsdk.ui" target="classFrame"><span class="interfaceName">SalesforceActivityInterface</span></a></li>
 <li><a href="com/salesforce/androidsdk/analytics/util/SalesforceAnalyticsLogger.html" title="class in com.salesforce.androidsdk.analytics.util" target="classFrame">SalesforceAnalyticsLogger</a></li>
 <li><a href="com/salesforce/androidsdk/analytics/SalesforceAnalyticsManager.html" title="class in com.salesforce.androidsdk.analytics" target="classFrame">SalesforceAnalyticsManager</a></li>
+<li><a href="com/salesforce/androidsdk/analytics/SalesforceAnalyticsManager.SalesforceAnalyticsPublishingType.html" title="enum in com.salesforce.androidsdk.analytics" target="classFrame">SalesforceAnalyticsManager.SalesforceAnalyticsPublishingType</a></li>
 <li><a href="com/salesforce/androidsdk/ui/SalesforceExpandableListActivity.html" title="class in com.salesforce.androidsdk.ui" target="classFrame">SalesforceExpandableListActivity</a></li>
 <li><a href="com/salesforce/androidsdk/phonegap/util/SalesforceHybridLogger.html" title="class in com.salesforce.androidsdk.phonegap.util" target="classFrame">SalesforceHybridLogger</a></li>
 <li><a href="com/salesforce/androidsdk/phonegap/app/SalesforceHybridSDKManager.html" title="class in com.salesforce.androidsdk.phonegap.app" target="classFrame">SalesforceHybridSDKManager</a></li>

diff --git a/allclasses-noframe.html b/allclasses-noframe.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_292) on Mon May 06 16:03:30 PDT 2024 -->
+<!-- Generated by javadoc (1.8.0_292) on Thu Aug 15 13:38:24 PDT 2024 -->
 <title>All Classes</title>
-<meta name="date" content="2024-05-06">
+<meta name="date" content="2024-08-15">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
@@ -83,7 +83,6 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="com/salesforce/androidsdk/smartstore/ui/KeyValueStoreInspectorActivity.html" title="class in com.salesforce.androidsdk.smartstore.ui">KeyValueStoreInspectorActivity</a></li>
 <li><a href="com/salesforce/androidsdk/config/LoginServerManager.html" title="class in com.salesforce.androidsdk.config">LoginServerManager</a></li>
 <li><a href="com/salesforce/androidsdk/config/LoginServerManager.LoginServer.html" title="class in com.salesforce.androidsdk.config">LoginServerManager.LoginServer</a></li>
-<li><a href="com/salesforce/androidsdk/util/LogoutCompleteReceiver.html" title="class in com.salesforce.androidsdk.util">LogoutCompleteReceiver</a></li>
 <li><a href="com/salesforce/androidsdk/smartstore/store/LongOperation.html" title="class in com.salesforce.androidsdk.smartstore.store">LongOperation</a></li>
 <li><a href="com/salesforce/androidsdk/smartstore/store/LongOperation.LongOperationType.html" title="enum in com.salesforce.androidsdk.smartstore.store">LongOperation.LongOperationType</a></li>
 <li><a href="com/salesforce/androidsdk/util/ManagedFilesHelper.html" title="class in com.salesforce.androidsdk.util">ManagedFilesHelper</a></li>
@@ -95,6 +94,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="com/salesforce/androidsdk/mobilesync/app/MobileSyncSDKManager.html" title="class in com.salesforce.androidsdk.mobilesync.app">MobileSyncSDKManager</a></li>
 <li><a href="com/salesforce/androidsdk/auth/OAuth2.html" title="class in com.salesforce.androidsdk.auth">OAuth2</a></li>
 <li><a href="com/salesforce/androidsdk/auth/OAuth2.IdServiceResponse.html" title="class in com.salesforce.androidsdk.auth">OAuth2.IdServiceResponse</a></li>
+<li><a href="com/salesforce/androidsdk/auth/OAuth2.LogoutReason.html" title="enum in com.salesforce.androidsdk.auth">OAuth2.LogoutReason</a></li>
 <li><a href="com/salesforce/androidsdk/auth/OAuth2.OAuthFailedException.html" title="class in com.salesforce.androidsdk.auth">OAuth2.OAuthFailedException</a></li>
 <li><a href="com/salesforce/androidsdk/auth/OAuth2.TokenEndpointResponse.html" title="class in com.salesforce.androidsdk.auth">OAuth2.TokenEndpointResponse</a></li>
 <li><a href="com/salesforce/androidsdk/auth/OAuth2.TokenErrorResponse.html" title="class in com.salesforce.androidsdk.auth">OAuth2.TokenErrorResponse</a></li>
@@ -128,6 +128,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="com/salesforce/androidsdk/ui/SalesforceActivityInterface.html" title="interface in com.salesforce.androidsdk.ui"><span class="interfaceName">SalesforceActivityInterface</span></a></li>
 <li><a href="com/salesforce/androidsdk/analytics/util/SalesforceAnalyticsLogger.html" title="class in com.salesforce.androidsdk.analytics.util">SalesforceAnalyticsLogger</a></li>
 <li><a href="com/salesforce/androidsdk/analytics/SalesforceAnalyticsManager.html" title="class in com.salesforce.androidsdk.analytics">SalesforceAnalyticsManager</a></li>
+<li><a href="com/salesforce/androidsdk/analytics/SalesforceAnalyticsManager.SalesforceAnalyticsPublishingType.html" title="enum in com.salesforce.androidsdk.analytics">SalesforceAnalyticsManager.SalesforceAnalyticsPublishingType</a></li>
 <li><a href="com/salesforce/androidsdk/ui/SalesforceExpandableListActivity.html" title="class in com.salesforce.androidsdk.ui">SalesforceExpandableListActivity</a></li>
 <li><a href="com/salesforce/androidsdk/phonegap/util/SalesforceHybridLogger.html" title="class in com.salesforce.androidsdk.phonegap.util">SalesforceHybridLogger</a></li>
 <li><a href="com/salesforce/androidsdk/phonegap/app/SalesforceHybridSDKManager.html" title="class in com.salesforce.androidsdk.phonegap.app">SalesforceHybridSDKManager</a></li>

diff --git a/com/salesforce/androidsdk/accounts/UserAccount.html b/com/salesforce/androidsdk/accounts/UserAccount.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_292) on Mon May 06 16:03:28 PDT 2024 -->
+<!-- Generated by javadoc (1.8.0_292) on Thu Aug 15 13:38:21 PDT 2024 -->
 <title>UserAccount</title>
-<meta name="date" content="2024-05-06">
+<meta name="date" content="2024-08-15">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>

diff --git a/com/salesforce/androidsdk/accounts/UserAccountBuilder.html b/com/salesforce/androidsdk/accounts/UserAccountBuilder.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_292) on Mon May 06 16:03:28 PDT 2024 -->
+<!-- Generated by javadoc (1.8.0_292) on Thu Aug 15 13:38:21 PDT 2024 -->
 <title>UserAccountBuilder</title>
-<meta name="date" content="2024-05-06">
+<meta name="date" content="2024-08-15">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>

diff --git a/com/salesforce/androidsdk/accounts/UserAccountManager.html b/com/salesforce/androidsdk/accounts/UserAccountManager.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_292) on Mon May 06 16:03:28 PDT 2024 -->
+<!-- Generated by javadoc (1.8.0_292) on Thu Aug 15 13:38:21 PDT 2024 -->
 <title>UserAccountManager</title>
-<meta name="date" content="2024-05-06">
+<meta name="date" content="2024-08-15">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>
@@ -18,7 +18,7 @@
     catch(err) {
     }
 //-->
-var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":9,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10};
+var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":9,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10};
 var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
@@ -309,46 +309,63 @@ <h3>Method Summary</h3>
 </tr>
 <tr id="i16" class="altColor">
 <td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/salesforce/androidsdk/accounts/UserAccountManager.html#signoutCurrentUser-Activity-boolean-com.salesforce.androidsdk.auth.OAuth2.LogoutReason-">signoutCurrentUser</a></span>(Activity&nbsp;frontActivity,
+                  boolean&nbsp;showLoginPage,
+                  <a href="../../../../com/salesforce/androidsdk/auth/OAuth2.LogoutReason.html" title="enum in com.salesforce.androidsdk.auth">OAuth2.LogoutReason</a>&nbsp;reason)</code>
+<div class="block">Logs the current user out.</div>
+</td>
+</tr>
+<tr id="i17" class="rowColor">
+<td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/salesforce/androidsdk/accounts/UserAccountManager.html#signoutUser-com.salesforce.androidsdk.accounts.UserAccount-Activity-">signoutUser</a></span>(<a href="../../../../com/salesforce/androidsdk/accounts/UserAccount.html" title="class in com.salesforce.androidsdk.accounts">UserAccount</a>&nbsp;userAccount,
            Activity&nbsp;frontActivity)</code>
 <div class="block">Logs the specified user out.</div>
 </td>
 </tr>
-<tr id="i17" class="rowColor">
+<tr id="i18" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/salesforce/androidsdk/accounts/UserAccountManager.html#signoutUser-com.salesforce.androidsdk.accounts.UserAccount-Activity-boolean-">signoutUser</a></span>(<a href="../../../../com/salesforce/androidsdk/accounts/UserAccount.html" title="class in com.salesforce.androidsdk.accounts">UserAccount</a>&nbsp;userAccount,
            Activity&nbsp;frontActivity,
            boolean&nbsp;showLoginPage)</code>
 <div class="block">Logs the specified user out.</div>
 </td>
 </tr>
-<tr id="i18" class="altColor">
+<tr id="i19" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/salesforce/androidsdk/accounts/UserAccountManager.html#signoutUser-com.salesforce.androidsdk.accounts.UserAccount-Activity-boolean-com.salesforce.androidsdk.auth.OAuth2.LogoutReason-">signoutUser</a></span>(<a href="../../../../com/salesforce/androidsdk/accounts/UserAccount.html" title="class in com.salesforce.androidsdk.accounts">UserAccount</a>&nbsp;userAccount,
+           Activity&nbsp;frontActivity,
+           boolean&nbsp;showLoginPage,
+           <a href="../../../../com/salesforce/androidsdk/auth/OAuth2.LogoutReason.html" title="enum in com.salesforce.androidsdk.auth">OAuth2.LogoutReason</a>&nbsp;reason)</code>
+<div class="block">Logs the specified user out.</div>
+</td>
+</tr>
+<tr id="i20" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/salesforce/androidsdk/accounts/UserAccountManager.html#storeCurrentUserInfo-java.lang.String-java.lang.String-">storeCurrentUserInfo</a></span>(java.lang.String&nbsp;userId,
                     java.lang.String&nbsp;orgId)</code>
 <div class="block">Stores the current active user's user ID and org ID in a shared preference file.</div>
 </td>
 </tr>
-<tr id="i19" class="rowColor">
+<tr id="i21" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/salesforce/androidsdk/accounts/UserAccountManager.html#switchToNewUser--">switchToNewUser</a></span>()</code>
 <div class="block">Kicks off the login flow to switch to a new user.</div>
 </td>
 </tr>
-<tr id="i20" class="altColor">
+<tr id="i22" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/salesforce/androidsdk/accounts/UserAccountManager.html#switchToNewUser-java.lang.String-java.lang.String-">switchToNewUser</a></span>(java.lang.String&nbsp;jwt,
                java.lang.String&nbsp;url)</code>
 <div class="block">Kicks off the login flow to switch to a new user with jwt.</div>
 </td>
 </tr>
-<tr id="i21" class="rowColor">
+<tr id="i23" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/salesforce/androidsdk/accounts/UserAccountManager.html#switchToUser-com.salesforce.androidsdk.accounts.UserAccount-">switchToUser</a></span>(<a href="../../../../com/salesforce/androidsdk/accounts/UserAccount.html" title="class in com.salesforce.androidsdk.accounts">UserAccount</a>&nbsp;user)</code>
 <div class="block">Switches to the specified user account.</div>
 </td>
 </tr>
-<tr id="i22" class="altColor">
+<tr id="i24" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/salesforce/androidsdk/accounts/UserAccountManager.html#switchToUser-com.salesforce.androidsdk.accounts.UserAccount-int-Bundle-">switchToUser</a></span>(<a href="../../../../com/salesforce/androidsdk/accounts/UserAccount.html" title="class in com.salesforce.androidsdk.accounts">UserAccount</a>&nbsp;user,
             int&nbsp;userSwitchType,
@@ -743,6 +760,24 @@ <h4>signoutCurrentUser</h4>
 </dl>
 </li>
 </ul>
+<a name="signoutCurrentUser-Activity-boolean-com.salesforce.androidsdk.auth.OAuth2.LogoutReason-">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>signoutCurrentUser</h4>
+<pre>public&nbsp;void&nbsp;signoutCurrentUser(Activity&nbsp;frontActivity,
+                               boolean&nbsp;showLoginPage,
+                               <a href="../../../../com/salesforce/androidsdk/auth/OAuth2.LogoutReason.html" title="enum in com.salesforce.androidsdk.auth">OAuth2.LogoutReason</a>&nbsp;reason)</pre>
+<div class="block">Logs the current user out.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>frontActivity</code> - Front activity.</dd>
+<dd><code>showLoginPage</code> - True - if the login page should be shown, False - otherwise.</dd>
+<dd><code>reason</code> - The reason for the logout.</dd>
+</dl>
+</li>
+</ul>
 <a name="signoutUser-com.salesforce.androidsdk.accounts.UserAccount-Activity-">
 <!--   -->
 </a>
@@ -779,6 +814,27 @@ <h4>signoutUser</h4>
 </dl>
 </li>
 </ul>
+<a name="signoutUser-com.salesforce.androidsdk.accounts.UserAccount-Activity-boolean-com.salesforce.androidsdk.auth.OAuth2.LogoutReason-">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>signoutUser</h4>
+<pre>public&nbsp;void&nbsp;signoutUser(<a href="../../../../com/salesforce/androidsdk/accounts/UserAccount.html" title="class in com.salesforce.androidsdk.accounts">UserAccount</a>&nbsp;userAccount,
+                        Activity&nbsp;frontActivity,
+                        boolean&nbsp;showLoginPage,
+                        <a href="../../../../com/salesforce/androidsdk/auth/OAuth2.LogoutReason.html" title="enum in com.salesforce.androidsdk.auth">OAuth2.LogoutReason</a>&nbsp;reason)</pre>
+<div class="block">Logs the specified user out. If the user specified is not the current
+ user, push notification un-registration will not take place.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>userAccount</code> - User account.</dd>
+<dd><code>frontActivity</code> - Front activity.</dd>
+<dd><code>showLoginPage</code> - True - if the login page should be shown, False - otherwise.</dd>
+<dd><code>reason</code> - The reason for the logout.</dd>
+</dl>
+</li>
+</ul>
 <a name="buildUserAccount-Account-">
 <!--   -->
 </a>