Skip to content

Minor API doc update #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 25, 2019
Merged

Minor API doc update #22

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8db241f
Minor API doc update
hiranya911 Jan 24, 2019
85ff411
Doc update
hiranya911 Jan 24, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions FirebaseAdmin/FirebaseAdmin/Auth/FirebaseAuth.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,19 +240,19 @@ public async Task<FirebaseToken> VerifyIdTokenAsync(
}

/// <summary>
/// Sets the specified custom claims on an existing user account. A null claims value
/// removes any claims currently set on the user account. The claims should serialize into
/// Sets the specified custom claims on an existing user account. A null claims value
/// removes any claims currently set on the user account. The claims must serialize into
/// a valid JSON string. The serialized claims must not be larger than 1000 characters.
/// </summary>
/// <exception cref="ArgumentException">If <paramref name="uid"/> is null, empty or longer
/// than 128 characters. Or, if the serialized <paramref name="claims"/> is larger than 1000
/// than 128 characters. Or, if the serialized <paramref name="claims"/> is larger than 1000
/// characters.</exception>
/// <param name="uid">The user ID string for the custom claims will be set. Must not be null
/// <param name="uid">The user ID string for the custom claims will be set. Must not be null
/// or longer than 128 characters.
/// </param>
/// <param name="claims">The claims to be stored on the user account, and made
/// available to Firebase security rules. These must be serializable to JSON, and after
/// serialization it should not be larger than 1000 characters.</param>
/// available to Firebase security rules. These must be serializable to JSON, and the
/// serialized claims should not be larger than 1000 characters.</param>
public async Task SetCustomUserClaimsAsync(string uid, IReadOnlyDictionary<string, object> claims)
{
lock (_lock)
Expand Down