Skip to content

Commit 505a37c

Browse files
committed
Update javadoc for cognito auth's identity provider identifier
1 parent daea3f6 commit 505a37c

File tree

1 file changed

+6
-5
lines changed
  • aws-android-sdk-cognitoauth/src/main/java/com/amazonaws/mobileconnectors/cognitoauth

1 file changed

+6
-5
lines changed

aws-android-sdk-cognitoauth/src/main/java/com/amazonaws/mobileconnectors/cognitoauth/Auth.java

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ public final class Auth {
5555
private final String identityProvider;
5656

5757
/**
58-
* Idp indentifier for provider mapping
58+
* Identity provider (idp) identifier, works as an alias to the real idp
5959
*/
6060
private final String idpIdentifier;
6161

@@ -376,7 +376,7 @@ public Builder setAuthHandler(final AuthHandler mUserHandler) {
376376
* <p>
377377
* Optional. Set identity provider for social sign in.
378378
* </p>
379-
* @param mIdentityProvider Required: Scopes as a {@link Set<String>}.
379+
* @param mIdentityProvider Optional: Will change the hosted UI behavior to go directly to the specified social provider
380380
* @return A reference to this builder.
381381
*/
382382
@SuppressWarnings("checkstyle:hiddenfield")
@@ -386,11 +386,12 @@ public Builder setIdentityProvider(final String mIdentityProvider) {
386386
}
387387

388388
/**
389-
* Sets the idp identifier. This will change the hosted UI behavior to go directly to the corresponding provider
389+
* Sets the identity provider (idp) identifier. This will change the hosted UI behavior to go directly to the corresponding provider
390+
* Used by the developer to map to a identity provider name without exposing the provider name.
390391
* <p>
391392
* Optional. Set idp identifier for provider mapping.
392393
* </p>
393-
* @param mIdpIdentifier Required: Scopes as a {@link Set<String>}.
394+
* @param mIdpIdentifier Optional: Will change the hosted UI behavior to go directly to the corresponding provider
394395
* @return A reference to this builder.
395396
*/
396397
@SuppressWarnings("checkstyle:hiddenfield")
@@ -552,7 +553,7 @@ public String getIdentityProvider() {
552553
}
553554

554555
/**
555-
* @return Identity Provider set for this {@link Auth} instance.
556+
* @return Identity Provider identifier set for this {@link Auth} instance.
556557
*/
557558
public String getIdpIdentifier() {
558559
return idpIdentifier;

0 commit comments

Comments
 (0)