Skip to content

Commit a3a084f

Browse files
author
Iain McGinniss
committed
Activity documentation
Change-Id: I9184b116f8ae2d5bd7763f6db70f3ba07b0ff498
1 parent 4e30b35 commit a3a084f

File tree

3 files changed

+23
-4
lines changed

3 files changed

+23
-4
lines changed

auth/build.gradle

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,9 @@ task checkAllSource(type: Checkstyle) {
4343
classpath = files(project.configurations.compile)
4444
}
4545

46-
javadoc.exclude 'com/firebase/ui/auth/provider/**'
47-
javadoc.exclude 'com/firebase/ui/auth/util/**'
48-
javadoc.exclude 'com/firebase/ui/auth/ui/email/field_validators/**'
46+
javadoc.exclude([
47+
'com/firebase/ui/auth/provider/**',
48+
'com/firebase/ui/auth/ui/ExtraConstants',
49+
'com/firebase/ui/auth/ui/email/field_validators/**',
50+
'com/firebase/ui/auth/util/**',
51+
])

auth/src/main/java/com/firebase/ui/auth/ui/ChooseAccountActivity.java

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,15 @@
3939

4040
import java.util.List;
4141

42+
/**
43+
* Attempts to acquire a credential from Smart Lock for Passwords to sign in
44+
* an existing account. If this succeeds, an attempt is made to sign the user in
45+
* with this credential. If it does not, the
46+
* {@link AuthMethodPickerActivity authentication method picker activity}
47+
* is started, unless only email is supported, in which case the
48+
* {@link com.firebase.ui.auth.ui.email.SignInNoPasswordActivity email sign-in flow}
49+
* is started.
50+
*/
4251
public class ChooseAccountActivity extends ActivityBase {
4352
private static final String TAG = "ChooseAccountActivity";
4453
private static final int RC_CREDENTIALS_READ = 2;

auth/src/main/java/com/firebase/ui/auth/ui/idp/AuthMethodPickerActivity.java

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,14 @@
5454
import java.util.List;
5555

5656
/**
57-
* Presents the list of authentication options for this app to the user.
57+
* Presents the list of authentication options for this app to the user. If an
58+
* identity provider option is selected, a {@link IDPSignInContainerActivity container activity}
59+
* is launched to manage the IDP-specific sign-in flow. If email authentication is chosen,
60+
* the {@link EmailHintContainerActivity root email flow activity} is started.
61+
*
62+
* <p style="text-align: center">
63+
* <img alt="Authentication picker activity rendered with all authentication options and default settings"
64+
* src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAWgAAAKACAMAAACGxBKVAAAAOVBMVEXu7u7Nzs7h4eLFwsMvPp7QAho7WZg+ULQAAAD///8yUpQ2SbNpfLxteG+eqL6Rk5Hrj4zfQ1BERESoYitxAAALMElEQVR42uzdDXuiOBSG4XwoXqEhwP//s3tOAkhrrO7u6G7wuWtLichcfTkeIjN1zAlvYYiAoAkaBP1WMcV0Ieh/4RKLy9f3Ufm4Bnu52BDCs0kT9P2Ys7V45fZt4HTSmFUi6H/YEL67LOGv+e+DdiKsIykEUzaOEn/cFgT9S9LJGYnR70t6TXoXtIZn1ixjiBfj8rfBS1fRxZcuCPpu60hm6QrBxl36Jeld0D6XdVwLOn9Gd4nhcrpI7HKPfkvQd6Wwuewbd/lyDVqCNFvr+Ao+Sr+ORoI+adAn46JzVPRv3E3OpXNr0rugU9SDEncnx0tpIiVoevQTc4SSc/w5FdGT4u5kaLX4d62jtOQlaFrHM2065+xv5yKnyz7oy65orSkRn3K6Ue/7yoVN0L/OPCRBV5tcn3ZBu7gre2nQ0Rg9GZ7kDmckZBuZdTxzQqzPrndB22/9JZpgL3oyPF2cfieZS+IE/Yj98dr6soi8MnyH/jZ5rnX8v+YxREDQBI1/EPQFb0HQBE3QIGiCJmgiIGiCBkETNEGDoAkaBE3QBA2CJmgQNEETNAiaoEHQBE3QIGiCBkETNEGDoAkaBE3QBA2CJmgQNEETNAiaoEHQBE3QIOhjBP2FtzDWeryeNZIztxff5EOCtrrg9rpb+aJB4w2Mw2vZsiDoNzHOGMfHCz+MWRcAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACtcsY1dGs359CYRqN2oTkUNCV9rIomaIImaIImaIImaIImaIImaIIm6NcGbZw1BP3yoO2cTQT92qCnef7/J32AoHPOk379vXu4J8e2Ue+fitD6zwjaraV8t0uPwzD4YId0m1FlrIw6G8IwbENJdpHu7v4zgp4etYxxSHYcbPCVA+GrB0dGNb1hvOY8yi7Shwc95ZZhiztBmNGb0cpi9PqdH8ecmoxdV9Io6xJxklGp4FEqOo0l61zb+r1s6/OmeSEPlAfp/u2yj2MHnQs6FrX61MYhP6l81eiGZPLClrHrih/kJuteRr3Wr4RdytistZ10xK+LURc5aDeMaUifHrQmrV1XE0wSmgSd19ag1xU7OMnNDc7lEEsd54glR6llrfExj+4XOehxMI86yCFah646cSdouVNqVuKzkuD9oMOQBi+fYQt6XILWinZ+iVZCLYtvQaujBz2sT2wbY+3pq3dLLT+saI1L20W4qejSo3+U8s+KDubgQUuTHUb9Ib0UtKueDMdUKnrr0fWgfU7NL0Gna0VLV9EHDqU5p3Vx7dFW/4jx6C9Y/LDoYv18pO1VZxz6Ka1BZhUS5phPhnnWsazIwsn0weUtndapdoi09h6ZjWzTjXUhext1tiIPKwf72C/Bt6THhy/inITj/9SraqOvgsbPeQmu0+Ecs334047PHI2n5QNsPinoHPZzRfhHr6Ya9/yFcS78c/WOoAmaoAmaoAmaoAmaoAmaoAmaoAn6Ltte0LbNiraN/QKcsa3+Rqf1TWk1Z+OcbYpr+LfBAQAAAAAADsPGvinRNhp015xGC7pvLug2S9o3F3TvCZqgCfo/lwiaiiZogiZoejQVTdAETdAE/a96dLzqCfplFd3v/wVvIujXBb3+m3SfUjXoPt+6WLkrViMpozGt95YLytUt07ODBwo6Spy1oKMJwXW9Cbc/emVsGY2xux61tOz/dlNbGa0OHqFHr0H3nTO1oIORSjd91EdIXeb6XupTx7aVfq1/GY2yIwl6uScFm1LKlV0KvFsXPnQ3YzrYVZ4Ah6loqedaj46aV7Kdd7IwLrkuOVnG/KO7fl3po4u9T50svOtcPjrJmViCzotodUt5hNE/xeuKD/JovcsZvy28bO7sUYPWhhqrPVrf0qrXrXopbDlxdlYXps+P7LeVLvg+6LqMyiYuRX1/mVCCTjKh0adG0J04K8fO6Js9Sqb50VHH3LqQoE2tpRwjaJ3Y9fWToYRrooYqCUqQsp4jXoPeVlyU3Rinq6V1xKWWy1s+6ixStpZ7e+tj8Ppc8WWP7ttC0q829GP0aAmoM9UeLe1SK1ECMprRvaC1bp3TxrwFnbagpaL1gMlptZOdyC7j+ma8ubHo2HXh75w5D96jtWNqLT+qaCnQIH05xFrQcWn2vlR0SlrR5by3jm0LCVp61OcFLaNe+2ju0c6Hu0HLhhp2X4I2Kd4E7fQ45B7t5dlhc6ayx9yjfenRPvdoecTtJYLDB63/csXmGYbOOqSqZeKha+usY1mRhZWQfZ+39MbL/EM2zRGXOUqes0RZ5BmG1/a1zFl0zHbrQndpXTzetY60C7rWG8v0N097tWzLVHqb/fbXSe/y7bp5/3M6XMa+zZn7detlf/11P/3hrt7160vkO6+Td1Pq+qHgWscfv0waIxeVuB7N3xlS0QRN0ARN0PRoKpqgCZqg6dEE/bdYgn4P1zWn0Xdy9F1Tv8/Zdb7RoG1zTJt437v3RS1ht/JpeHtBAAAAAADwKzufmzK3evXu3JxGC7q9oBt937v2gm7z7wyn9oKeqGgqmoqmoqloKpqKpqKpaCqaiqaiqWgquvWKnsW0fFLRr6voef/fQv9W6vOTY9vo9PCJIxtO86dU9GTm9T8Jn6bq9VOfj8BcOQpz9cjoqD45wqPL3lOY5zB9SkXLTyufwp3n6oXqKUyz041q99UDPJ9d0Gv1jwp6Oj8d9AEqOkfsSty1oE3QSCTsWS+/T246u8mXY6Vj24o8HXTd6paTkZ0GM61HbjJyz+Rmp3fZ/FdTdtbNP6ii56U35wZSr+i8vUYiG5p1Me/H5rydFv9Z6l96UNnM2pKj0W3kXjctY7LLEP5W6zhEResbspV33bX1Vrr06JxKznJ5ys/fV+R54eYSnrYO7dF5j3PZZgrl6SFjMsHxYf60Hv141qGdZQl6vhu0fJc/zmvQ5hp0OdVeg87vgveRFb2oVbQWZkn594qWcMM5N/xaRZfesgStA9OnVfT8KGhtraZEImXp7gc9BX+2y2ppxEvQ2qNzrteg3ef16McvWCanc4Y863BGz3cy8chry6xjWcmL66c5WwnZTWtMUsMuT010TGYhMgeZ841rHZVePeeJBdc6Xn31zubXNVzreMPVu//suhPXo6lorkdT0VQ0FU1FU9FUNBVNRVPRVDQVTUVT0Xe59oJu9X3vmito3veO9707VNINv+9dUwwAAAAA4K/27ljZQRAIo/ACjbdYmNn3f9iLUSNVMil+B8fzTYqUeiQEKBIAAAAAAAAAAAAAAAAAAAAAAAAAAAAA+OIPl7AFlyA0oQkNQhOa0CQgNKFBaEITGoQm9GeeXHnJ4R6E7h2K5aS74Lb9FH8TPsjxx/7TtKFbjyAMnS15hPeHGbpHWUo9XhZzhvZsJZaUdJ33Wckty0IPTWLO0JEsrRcmG9HN/ExQHxu62N5BNqKtnO+rxTND98n5GGOqEe3mYwN/ZOicy/uakiz0eNuqlcfcocPyed+qEd0I/foizH7liH7q1HEs7ZQjehlXGu2pX4b7ZkW66hj2D2G6NeT0odcS6/whG9FxbgiTakDfI/S2Z9HtDKN/ZvqtR8smO7hqub5NuwXfpmrhWUfsf1eadAd4NzlUeu3Z6qITrdZ2v3NSDv4JTWgQmtCEJgGhCQ1CE5rQIDSh8bN/7xna+k/jxQQAAAAASUVORK5CYII=">
5865
*/
5966
public class AuthMethodPickerActivity
6067
extends IDPBaseActivity

0 commit comments

Comments
 (0)