Java doc for Mobile SDK 12.2.0

forcedotcom · Oct 28, 2024 · 2878802 · 2878802
1 parent 07d82f9
commit 2878802
Show file tree

Hide file tree

Showing 491 changed files with 1,849 additions and 2,656 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 Thu Aug 29 10:43:07 PDT 2024 -->
+<!-- Generated by javadoc (1.8.0_292) on Mon Oct 28 11:49:12 PDT 2024 -->
 <title>All Classes</title>
-<meta name="date" content="2024-08-29">
+<meta name="date" content="2024-10-28">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
@@ -181,7 +181,6 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="com/salesforce/androidsdk/util/UriFragmentParser.html" title="class in com.salesforce.androidsdk.util" target="classFrame">UriFragmentParser</a></li>
 <li><a href="com/salesforce/androidsdk/accounts/UserAccount.html" title="class in com.salesforce.androidsdk.accounts" target="classFrame">UserAccount</a></li>
 <li><a href="com/salesforce/androidsdk/ui/UserAccountAdapter.html" title="class in com.salesforce.androidsdk.ui" target="classFrame">UserAccountAdapter</a></li>
-<li><a href="com/salesforce/androidsdk/accounts/UserAccountBuilder.html" title="class in com.salesforce.androidsdk.accounts" target="classFrame">UserAccountBuilder</a></li>
 <li><a href="com/salesforce/androidsdk/accounts/UserAccountManager.html" title="class in com.salesforce.androidsdk.accounts" target="classFrame">UserAccountManager</a></li>
 <li><a href="com/salesforce/androidsdk/util/UserSwitchReceiver.html" title="class in com.salesforce.androidsdk.util" target="classFrame">UserSwitchReceiver</a></li>
 <li><a href="com/salesforce/androidsdk/analytics/util/WatchableStream.html" title="interface in com.salesforce.androidsdk.analytics.util" target="classFrame"><span class="interfaceName">WatchableStream</span></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 Thu Aug 29 10:43:07 PDT 2024 -->
+<!-- Generated by javadoc (1.8.0_292) on Mon Oct 28 11:49:12 PDT 2024 -->
 <title>All Classes</title>
-<meta name="date" content="2024-08-29">
+<meta name="date" content="2024-10-28">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
@@ -181,7 +181,6 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="com/salesforce/androidsdk/util/UriFragmentParser.html" title="class in com.salesforce.androidsdk.util">UriFragmentParser</a></li>
 <li><a href="com/salesforce/androidsdk/accounts/UserAccount.html" title="class in com.salesforce.androidsdk.accounts">UserAccount</a></li>
 <li><a href="com/salesforce/androidsdk/ui/UserAccountAdapter.html" title="class in com.salesforce.androidsdk.ui">UserAccountAdapter</a></li>
-<li><a href="com/salesforce/androidsdk/accounts/UserAccountBuilder.html" title="class in com.salesforce.androidsdk.accounts">UserAccountBuilder</a></li>
 <li><a href="com/salesforce/androidsdk/accounts/UserAccountManager.html" title="class in com.salesforce.androidsdk.accounts">UserAccountManager</a></li>
 <li><a href="com/salesforce/androidsdk/util/UserSwitchReceiver.html" title="class in com.salesforce.androidsdk.util">UserSwitchReceiver</a></li>
 <li><a href="com/salesforce/androidsdk/analytics/util/WatchableStream.html" title="interface in com.salesforce.androidsdk.analytics.util"><span class="interfaceName">WatchableStream</span></a></li>

diff --git a/com/salesforce/androidsdk/accounts/UserAccount.html b/com/salesforce/androidsdk/accounts/UserAccount.html
diff --git a/com/salesforce/androidsdk/accounts/UserAccountBuilder.html b/com/salesforce/androidsdk/accounts/UserAccountBuilder.html
diff --git a/com/salesforce/androidsdk/accounts/UserAccountManager.html b/com/salesforce/androidsdk/accounts/UserAccountManager.html
diff --git a/com/salesforce/androidsdk/accounts/class-use/UserAccount.html b/com/salesforce/androidsdk/accounts/class-use/UserAccount.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_292) on Thu Aug 29 10:43:07 PDT 2024 -->
+<!-- Generated by javadoc (1.8.0_292) on Mon Oct 28 11:49:12 PDT 2024 -->
 <title>Uses of Class com.salesforce.androidsdk.accounts.UserAccount</title>
-<meta name="date" content="2024-08-29">
+<meta name="date" content="2024-10-28">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 </head>
@@ -132,29 +132,23 @@ <h3>Uses of <a href="../../../../../com/salesforce/androidsdk/accounts/UserAccou
 <tbody>
 <tr class="altColor">
 <td class="colFirst"><code><a href="../../../../../com/salesforce/androidsdk/accounts/UserAccount.html" title="class in com.salesforce.androidsdk.accounts">UserAccount</a></code></td>
-<td class="colLast"><span class="typeNameLabel">UserAccountBuilder.</span><code><span class="memberNameLink"><a href="../../../../../com/salesforce/androidsdk/accounts/UserAccountBuilder.html#build--">build</a></span>()</code>
-<div class="block">Builds and returns a UserAccount object.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code><a href="../../../../../com/salesforce/androidsdk/accounts/UserAccount.html" title="class in com.salesforce.androidsdk.accounts">UserAccount</a></code></td>
 <td class="colLast"><span class="typeNameLabel">UserAccountManager.</span><code><span class="memberNameLink"><a href="../../../../../com/salesforce/androidsdk/accounts/UserAccountManager.html#buildUserAccount-Account-">buildUserAccount</a></span>(Account&nbsp;account)</code>
 <div class="block">Builds a UserAccount object from the saved account.</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code><a href="../../../../../com/salesforce/androidsdk/accounts/UserAccount.html" title="class in com.salesforce.androidsdk.accounts">UserAccount</a></code></td>
 <td class="colLast"><span class="typeNameLabel">UserAccountManager.</span><code><span class="memberNameLink"><a href="../../../../../com/salesforce/androidsdk/accounts/UserAccountManager.html#getCachedCurrentUser--">getCachedCurrentUser</a></span>()</code>
 <div class="block">Returns a cached value of the current user.</div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code><a href="../../../../../com/salesforce/androidsdk/accounts/UserAccount.html" title="class in com.salesforce.androidsdk.accounts">UserAccount</a></code></td>
 <td class="colLast"><span class="typeNameLabel">UserAccountManager.</span><code><span class="memberNameLink"><a href="../../../../../com/salesforce/androidsdk/accounts/UserAccountManager.html#getCurrentUser--">getCurrentUser</a></span>()</code>
 <div class="block">Returns the current user logged in.</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code><a href="../../../../../com/salesforce/androidsdk/accounts/UserAccount.html" title="class in com.salesforce.androidsdk.accounts">UserAccount</a></code></td>
 <td class="colLast"><span class="typeNameLabel">UserAccountManager.</span><code><span class="memberNameLink"><a href="../../../../../com/salesforce/androidsdk/accounts/UserAccountManager.html#getUserFromOrgAndUserId-java.lang.String-java.lang.String-">getUserFromOrgAndUserId</a></span>(java.lang.String&nbsp;orgId,
                        java.lang.String&nbsp;userId)</code>
@@ -192,34 +186,40 @@ <h3>Uses of <a href="../../../../../com/salesforce/androidsdk/accounts/UserAccou
 </td>
 </tr>
 <tr class="rowColor">
+<td class="colFirst"><code>Bundle</code></td>
+<td class="colLast"><span class="typeNameLabel">UserAccountManager.</span><code><span class="memberNameLink"><a href="../../../../../com/salesforce/androidsdk/accounts/UserAccountManager.html#createAccount-com.salesforce.androidsdk.accounts.UserAccount-">createAccount</a></span>(<a href="../../../../../com/salesforce/androidsdk/accounts/UserAccount.html" title="class in com.salesforce.androidsdk.accounts">UserAccount</a>&nbsp;userAccount)</code>
+<div class="block">Create AccountManager Account from the given UserAccount</div>
+</td>
+</tr>
+<tr class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><span class="typeNameLabel">UserAccountManager.</span><code><span class="memberNameLink"><a href="../../../../../com/salesforce/androidsdk/accounts/UserAccountManager.html#doesUserAccountExist-com.salesforce.androidsdk.accounts.UserAccount-">doesUserAccountExist</a></span>(<a href="../../../../../com/salesforce/androidsdk/accounts/UserAccount.html" title="class in com.salesforce.androidsdk.accounts">UserAccount</a>&nbsp;account)</code>
 <div class="block">Returns whether the specified user account exists or not.</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><span class="typeNameLabel">UserAccountManager.</span><code><span class="memberNameLink"><a href="../../../../../com/salesforce/androidsdk/accounts/UserAccountManager.html#refreshToken-com.salesforce.androidsdk.accounts.UserAccount-">refreshToken</a></span>(<a href="../../../../../com/salesforce/androidsdk/accounts/UserAccount.html" title="class in com.salesforce.androidsdk.accounts">UserAccount</a>&nbsp;userAccount)</code>
 <div class="block">Attempts to refresh the access token for this user by making an API call
  to the "/token" endpoint.</div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><span class="typeNameLabel">UserAccountManager.</span><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 class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><span class="typeNameLabel">UserAccountManager.</span><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 class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><span class="typeNameLabel">UserAccountManager.</span><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,
@@ -228,20 +228,27 @@ <h3>Uses of <a href="../../../../../com/salesforce/androidsdk/accounts/UserAccou
 <div class="block">Logs the specified user out.</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><span class="typeNameLabel">UserAccountManager.</span><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 class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><span class="typeNameLabel">UserAccountManager.</span><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,
             Bundle&nbsp;extras)</code>
 <div class="block">Switches to the specified user account.</div>
 </td>
 </tr>
+<tr class="rowColor">
+<td class="colFirst"><code>Bundle</code></td>
+<td class="colLast"><span class="typeNameLabel">UserAccountManager.</span><code><span class="memberNameLink"><a href="../../../../../com/salesforce/androidsdk/accounts/UserAccountManager.html#updateAccount-Account-com.salesforce.androidsdk.accounts.UserAccount-">updateAccount</a></span>(Account&nbsp;account,
+             <a href="../../../../../com/salesforce/androidsdk/accounts/UserAccount.html" title="class in com.salesforce.androidsdk.accounts">UserAccount</a>&nbsp;userAccount)</code>
+<div class="block">Update AccountManager Account for the given UserAccount</div>
+</td>
+</tr>
 </tbody>
 </table>
 </li>
@@ -379,6 +386,12 @@ <h3>Uses of <a href="../../../../../com/salesforce/androidsdk/accounts/UserAccou
 </td>
 </tr>
 <tr class="rowColor">
+<td class="colFirst"><code>Bundle</code></td>
+<td class="colLast"><span class="typeNameLabel">ClientManager.</span><code><span class="memberNameLink"><a href="../../../../../com/salesforce/androidsdk/rest/ClientManager.html#createNewAccount-com.salesforce.androidsdk.accounts.UserAccount-">createNewAccount</a></span>(<a href="../../../../../com/salesforce/androidsdk/accounts/UserAccount.html" title="class in com.salesforce.androidsdk.accounts">UserAccount</a>&nbsp;userAccount)</code>
+<div class="block">Creates a new account and returns the parameters as a Bundle.</div>
+</td>
+</tr>
+<tr class="altColor">
 <td class="colFirst"><code><a href="../../../../../com/salesforce/androidsdk/rest/RestClient.html" title="class in com.salesforce.androidsdk.rest">RestClient</a></code></td>
 <td class="colLast"><span class="typeNameLabel">ClientManager.</span><code><span class="memberNameLink"><a href="../../../../../com/salesforce/androidsdk/rest/ClientManager.html#peekRestClient-com.salesforce.androidsdk.accounts.UserAccount-">peekRestClient</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">Method to create RestClient synchronously.</div>