| Server IP : 103.6.199.200 / Your IP : 3.133.152.189 Web Server : Microsoft-IIS/10.0 System : Windows NT EMPUSA 10.0 build 20348 (Windows Server 2016) i586 User : EMPUSA$ ( 0) PHP Version : 7.4.33 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : OFF | Perl : OFF | Python : OFF | Sudo : OFF | Pkexec : OFF Directory : C:/Domains/jivisol1/build/ReconProcessGUI/ |
Upload File : |
<?xml version="1.0"?>
<doc>
<assembly>
<name>FirebaseAdmin</name>
</assembly>
<members>
<member name="T:FirebaseAdmin.AppOptions">
<summary>
Configurable options that can be specified when creating a <see cref="T:FirebaseAdmin.FirebaseApp"/>.
See <a href="https://firebase.google.com/docs/admin/setup#initialize_the_sdk">
Initialize the SDK</a> for code samples and detailed documentation.
</summary>
</member>
<member name="M:FirebaseAdmin.AppOptions.#ctor">
<summary>
Initializes a new instance of the <see cref="T:FirebaseAdmin.AppOptions"/> class.
</summary>
</member>
<member name="P:FirebaseAdmin.AppOptions.Credential">
<summary>
Gets or sets the <see cref="T:Google.Apis.Auth.OAuth2.GoogleCredential"/> used to authorize an app. All service
calls made by the app will be authorized using this.
</summary>
</member>
<member name="P:FirebaseAdmin.AppOptions.ProjectId">
<summary>
Gets or sets the Google Cloud Platform project ID that should be associated with an
app.
</summary>
</member>
<member name="P:FirebaseAdmin.AppOptions.ServiceAccountId">
<summary>
Gets or sets the unique ID of the service account that should be associated with an
app.
<para>This is used to <a href="https://firebase.google.com/docs/auth/admin/create-custom-tokens">
create custom auth tokens</a> when service account credentials are not available. The
service account ID can be found in the <c>client_email</c> field of the service account
JSON.</para>
</summary>
</member>
<member name="P:FirebaseAdmin.AppOptions.HttpClientFactory">
<summary>
Gets or sets the HttpClientFactory to use when making Firebase requests.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.AbstractFirebaseAuth">
<summary>
Exposes Firebase Auth operations that are available in both tenant-aware and tenant-unaware
contexts.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.CreateCustomTokenAsync(System.String)">
<summary>
Creates a Firebase custom token for the given user ID. This token can then be sent
back to a client application to be used with the
<a href="https://firebase.google.com/docs/auth/admin/create-custom-tokens#sign_in_using_custom_tokens_on_clients">
signInWithCustomToken</a> authentication API.
<para>
This method attempts to generate a token using:
<list type="number">
<item>
<description>the private key of <see cref="T:FirebaseAdmin.FirebaseApp"/>'s service account
credentials, if provided at initialization.</description>
</item>
<item>
<description>the IAM service if a service accound ID was specified via
<see cref="T:FirebaseAdmin.AppOptions"/></description>
</item>
<item>
<description>the local metadata server if the code is deployed in a GCP-managed
environment.</description>
</item>
</list>
</para>
</summary>
<returns>A task that completes with a Firebase custom token.</returns>
<exception cref="T:System.ArgumentException">If <paramref name="uid"/> is null, empty or longer
than 128 characters.</exception>
<exception cref="T:System.InvalidOperationException">If no service account can be discovered
from either the <see cref="T:FirebaseAdmin.AppOptions"/> or the deployment environment.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If an error occurs while creating a custom
token.</exception>
<param name="uid">The UID to store in the token. This identifies the user to other
Firebase services (Realtime Database, Firebase Auth, etc.). Must not be longer than
128 characters.</param>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.CreateCustomTokenAsync(System.String,System.Threading.CancellationToken)">
<summary>
Creates a Firebase custom token for the given user ID. This token can then be sent
back to a client application to be used with the
<a href="https://firebase.google.com/docs/auth/admin/create-custom-tokens#sign_in_using_custom_tokens_on_clients">
signInWithCustomToken</a> authentication API.
<para>
This method attempts to generate a token using:
<list type="number">
<item>
<description>the private key of <see cref="T:FirebaseAdmin.FirebaseApp"/>'s service account
credentials, if provided at initialization.</description>
</item>
<item>
<description>the IAM service if a service accound ID was specified via
<see cref="T:FirebaseAdmin.AppOptions"/></description>
</item>
<item>
<description>the local metadata server if the code is deployed in a GCP-managed
environment.</description>
</item>
</list>
</para>
</summary>
<returns>A task that completes with a Firebase custom token.</returns>
<exception cref="T:System.ArgumentException">If <paramref name="uid"/> is null, empty or longer
than 128 characters.</exception>
<exception cref="T:System.InvalidOperationException">If no service account can be discovered
from either the <see cref="T:FirebaseAdmin.AppOptions"/> or the deployment environment.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If an error occurs while creating a custom
token.</exception>
<param name="uid">The UID to store in the token. This identifies the user to other
Firebase services (Realtime Database, Firebase Auth, etc.). Must not be longer than
128 characters.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.CreateCustomTokenAsync(System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
<summary>
Creates a Firebase custom token for the given user ID containing the specified
additional claims. This token can then be sent back to a client application to be used
with the
<a href="https://firebase.google.com/docs/auth/admin/create-custom-tokens#sign_in_using_custom_tokens_on_clients">
signInWithCustomToken</a> authentication API.
<para>This method uses the same mechanisms as
<see cref="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.CreateCustomTokenAsync(System.String)"/> to sign custom tokens.</para>
</summary>
<returns>A task that completes with a Firebase custom token.</returns>
<exception cref="T:System.ArgumentException">If <paramref name="uid"/> is null, empty or longer
than 128 characters. Or, if <paramref name="developerClaims"/> contains any standard
JWT claims.</exception>
<exception cref="T:System.InvalidOperationException">If no service account can be discovered
from either the <see cref="T:FirebaseAdmin.AppOptions"/> or the deployment environment.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If an error occurs while creating a custom
token.</exception>
<param name="uid">The UID to store in the token. This identifies the user to other
Firebase services (Realtime Database, Firebase Auth, etc.). Must not be longer than
128 characters.</param>
<param name="developerClaims">Additional claims to be stored in the token, and made
available to Firebase security rules. These must be serializable to JSON, and must not
contain any standard JWT claims.</param>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.CreateCustomTokenAsync(System.String,System.Collections.Generic.IDictionary{System.String,System.Object},System.Threading.CancellationToken)">
<summary>
Creates a Firebase custom token for the given user ID containing the specified
additional claims. This token can then be sent back to a client application to be used
with the
<a href="https://firebase.google.com/docs/auth/admin/create-custom-tokens#sign_in_using_custom_tokens_on_clients">
signInWithCustomToken</a> authentication API.
<para>This method uses the same mechanisms as
<see cref="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.CreateCustomTokenAsync(System.String)"/> to sign custom tokens.</para>
</summary>
<returns>A task that completes with a Firebase custom token.</returns>
<exception cref="T:System.ArgumentException">If <paramref name="uid"/> is null, empty or longer
than 128 characters. Or, if <paramref name="developerClaims"/> contains any standard
JWT claims.</exception>
<exception cref="T:System.InvalidOperationException">If no service account can be discovered
from either the <see cref="T:FirebaseAdmin.AppOptions"/> or the deployment environment.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If an error occurs while creating a custom
token.</exception>
<param name="uid">The UID to store in the token. This identifies the user to other
Firebase services (Realtime Database, Firebase Auth, etc.). Must not be longer than
128 characters.</param>
<param name="developerClaims">Additional claims to be stored in the token, and made
available to Firebase security rules. These must be serializable to JSON, and must not
contain any standard JWT claims.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.VerifyIdTokenAsync(System.String)">
<summary>
Parses and verifies a Firebase ID token.
<para>A Firebase client app can identify itself to a trusted backend server by sending
its Firebase ID Token (accessible via the <c>getIdToken()</c> API in the Firebase
client SDK) with its requests. The backend server can then use this method
to verify that the token is valid. This method ensures that the token is correctly
signed, has not expired, and it was issued against the Firebase project associated with
this <c>FirebaseAuth</c> instance.</para>
<para>See <a href="https://firebase.google.com/docs/auth/admin/verify-id-tokens">Verify
ID Tokens</a> for code samples and detailed documentation.</para>
</summary>
<returns>A task that completes with a <see cref="T:FirebaseAdmin.Auth.FirebaseToken"/> representing
the verified and decoded ID token.</returns>
<exception cref="T:System.ArgumentException">If ID token argument is null or empty.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If the ID token fails to verify.</exception>
<param name="idToken">A Firebase ID token string to parse and verify.</param>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.VerifyIdTokenAsync(System.String,System.Threading.CancellationToken)">
<summary>
Parses and verifies a Firebase ID token.
<para>A Firebase client app can identify itself to a trusted backend server by sending
its Firebase ID Token (accessible via the <c>getIdToken()</c> API in the Firebase
client SDK) with its requests. The backend server can then use this method
to verify that the token is valid. This method ensures that the token is correctly
signed, has not expired, and it was issued against the Firebase project associated with
this <c>FirebaseAuth</c> instance.</para>
<para>See <a href="https://firebase.google.com/docs/auth/admin/verify-id-tokens">Verify
ID Tokens</a> for code samples and detailed documentation.</para>
</summary>
<returns>A task that completes with a <see cref="T:FirebaseAdmin.Auth.FirebaseToken"/> representing
the verified and decoded ID token.</returns>
<exception cref="T:System.ArgumentException">If ID token argument is null or empty.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If the ID token fails to verify.</exception>
<param name="idToken">A Firebase ID token string to parse and verify.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.VerifyIdTokenAsync(System.String,System.Boolean)">
<summary>
Parses and verifies a Firebase ID token.
<para>A Firebase client app can identify itself to a trusted backend server by sending
its Firebase ID Token (accessible via the <c>getIdToken()</c> API in the Firebase
client SDK) with its requests. The backend server can then use this method
to verify that the token is valid. This method ensures that the token is correctly
signed, has not expired, and it was issued against the Firebase project associated with
this <c>FirebaseAuth</c> instance.</para>
<para>If <c>checkRevoked</c> is set to true, this method performs an additional check
to see if the ID token has been revoked since it was issued. This requires making an
additional remote API call.</para>
<para>See <a href="https://firebase.google.com/docs/auth/admin/verify-id-tokens">Verify
ID Tokens</a> for code samples and detailed documentation.</para>
</summary>
<returns>A task that completes with a <see cref="T:FirebaseAdmin.Auth.FirebaseToken"/> representing
the verified and decoded ID token.</returns>
<exception cref="T:System.ArgumentException">If ID token argument is null or empty.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If the ID token fails to verify.</exception>
<param name="idToken">A Firebase ID token string to parse and verify.</param>
<param name="checkRevoked">A boolean indicating whether to check if the tokens were revoked.</param>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.VerifyIdTokenAsync(System.String,System.Boolean,System.Threading.CancellationToken)">
<summary>
Parses and verifies a Firebase ID token.
<para>A Firebase client app can identify itself to a trusted backend server by sending
its Firebase ID Token (accessible via the <c>getIdToken()</c> API in the Firebase
client SDK) with its requests. The backend server can then use this method
to verify that the token is valid. This method ensures that the token is correctly
signed, has not expired, and it was issued against the Firebase project associated with
this <c>FirebaseAuth</c> instance.</para>
<para>If <c>checkRevoked</c> is set to true, this method performs an additional check
to see if the ID token has been revoked since it was issued. This requires making an
additional remote API call.</para>
<para>See <a href="https://firebase.google.com/docs/auth/admin/verify-id-tokens">Verify
ID Tokens</a> for code samples and detailed documentation.</para>
</summary>
<returns>A task that completes with a <see cref="T:FirebaseAdmin.Auth.FirebaseToken"/> representing
the verified and decoded ID token.</returns>
<exception cref="T:System.ArgumentException">If ID token argument is null or empty.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If the ID token fails to verify.</exception>
<param name="idToken">A Firebase ID token string to parse and verify.</param>
<param name="checkRevoked">A boolean indicating whether to check if the tokens were revoked.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.CreateUserAsync(FirebaseAdmin.Auth.UserRecordArgs)">
<summary>
Creates a new user account with the attributes contained in the specified <see cref="T:FirebaseAdmin.Auth.UserRecordArgs"/>.
</summary>
<param name="args">Attributes to add to the new user account.</param>
<returns>A task that completes with a <see cref="T:FirebaseAdmin.Auth.UserRecord"/> representing
the newly created user account.</returns>
<exception cref="T:System.ArgumentNullException">If <paramref name="args"/> is null.</exception>
<exception cref="T:System.ArgumentException">If any of the values in <paramref name="args"/> are invalid.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If an error occurs while creating the user account.</exception>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.CreateUserAsync(FirebaseAdmin.Auth.UserRecordArgs,System.Threading.CancellationToken)">
<summary>
Creates a new user account with the attributes contained in the specified <see cref="T:FirebaseAdmin.Auth.UserRecordArgs"/>.
</summary>
<param name="args">Attributes to add to the new user account.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
<returns>A task that completes with a <see cref="T:FirebaseAdmin.Auth.UserRecord"/> representing
the newly created user account.</returns>
<exception cref="T:System.ArgumentNullException">If <paramref name="args"/> is null.</exception>
<exception cref="T:System.ArgumentException">If any of the values in <paramref name="args"/> are invalid.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If an error occurs while creating the user account.</exception>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.GetUserAsync(System.String)">
<summary>
Gets a <see cref="T:FirebaseAdmin.Auth.UserRecord"/> object containing information about the user who's
user ID was specified in <paramref name="uid"/>.
</summary>
<param name="uid">The user ID for the user who's data is to be retrieved.</param>
<returns>A task that completes with a <see cref="T:FirebaseAdmin.Auth.UserRecord"/> representing
a user with the specified user ID.</returns>
<exception cref="T:System.ArgumentException">If user ID argument is null or empty.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If a user cannot be found with the specified user ID.</exception>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.GetUserAsync(System.String,System.Threading.CancellationToken)">
<summary>
Gets a <see cref="T:FirebaseAdmin.Auth.UserRecord"/> object containing information about the user who's
user ID was specified in <paramref name="uid"/>.
</summary>
<param name="uid">The user ID for the user who's data is to be retrieved.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
<returns>A task that completes with a <see cref="T:FirebaseAdmin.Auth.UserRecord"/> representing
a user with the specified user ID.</returns>
<exception cref="T:System.ArgumentException">If user ID argument is null or empty.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If a user cannot be found with the specified user ID.</exception>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.GetUserByEmailAsync(System.String)">
<summary>
Gets a <see cref="T:FirebaseAdmin.Auth.UserRecord"/> object containing information about the user identified by
<paramref name="email"/>.
</summary>
<param name="email">The email of the user who's data is to be retrieved.</param>
<returns>A task that completes with a <see cref="T:FirebaseAdmin.Auth.UserRecord"/> representing
a user with the specified email.</returns>
<exception cref="T:System.ArgumentException">If the email argument is null or empty.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If a user cannot be found with the specified email.</exception>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.GetUserByEmailAsync(System.String,System.Threading.CancellationToken)">
<summary>
Gets a <see cref="T:FirebaseAdmin.Auth.UserRecord"/> object containing information about the user identified by
<paramref name="email"/>.
</summary>
<param name="email">The email of the user who's data is to be retrieved.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
<returns>A task that completes with a <see cref="T:FirebaseAdmin.Auth.UserRecord"/> representing
a user with the specified email.</returns>
<exception cref="T:System.ArgumentException">If the email argument is null or empty.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If a user cannot be found with the specified email.</exception>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.GetUserByPhoneNumberAsync(System.String)">
<summary>
Gets a <see cref="T:FirebaseAdmin.Auth.UserRecord"/> object containing information about the user identified by
<paramref name="phoneNumber"/>.
</summary>
<param name="phoneNumber">The phone number of the user who's data is to be retrieved.</param>
<returns>A task that completes with a <see cref="T:FirebaseAdmin.Auth.UserRecord"/> representing
a user with the specified phone number.</returns>
<exception cref="T:System.ArgumentException">If the phone number argument is null or empty.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If a user cannot be found with the specified phone number.</exception>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.GetUserByPhoneNumberAsync(System.String,System.Threading.CancellationToken)">
<summary>
Gets a <see cref="T:FirebaseAdmin.Auth.UserRecord"/> object containing information about the user identified by
<paramref name="phoneNumber"/>.
</summary>
<param name="phoneNumber">The phone number of the user who's data is to be retrieved.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
<returns>A task that completes with a <see cref="T:FirebaseAdmin.Auth.UserRecord"/> representing
a user with the specified phone number.</returns>
<exception cref="T:System.ArgumentException">If the phone number argument is null or empty.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If a user cannot be found with the specified phone number.</exception>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.GetUsersAsync(System.Collections.Generic.IReadOnlyCollection{FirebaseAdmin.Auth.UserIdentifier})">
<summary>
Gets the user data corresponding to the specified identifiers.
<para>
There are no ordering guarantees; in particular, the nth entry in the users result list
is not guaranteed to correspond to the nth entry in the input parameters list.
</para>
<para>
A maximum of 100 identifiers may be supplied. If more than 100 identifiers are specified,
this method throws an <c>ArgumentException</c>.
</para>
</summary>
<param name="identifiers">The identifiers used to indicate which user records should be
returned. Must have 100 entries or fewer.</param>
<returns>A task that resolves to the corresponding user records.</returns>
<exception cref="T:System.ArgumentException">If any of the identifiers are invalid or if more
than 100 identifiers are specified.</exception>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.GetUsersAsync(System.Collections.Generic.IReadOnlyCollection{FirebaseAdmin.Auth.UserIdentifier},System.Threading.CancellationToken)">
<summary>
Gets the user data corresponding to the specified identifiers.
<para>
There are no ordering guarantees; in particular, the nth entry in the users result list
is not guaranteed to correspond to the nth entry in the input parameters list.
</para>
<para>
A maximum of 100 identifiers may be supplied. If more than 100 identifiers are specified,
this method throws an <c>ArgumentException</c>.
</para>
</summary>
<param name="identifiers">The identifiers used to indicate which user records should be
returned. Must have 100 entries or fewer.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
<returns>A task that resolves to the corresponding user records.</returns>
<exception cref="T:System.ArgumentException">If any of the identifiers are invalid or if more
than 100 identifiers are specified.</exception>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.UpdateUserAsync(FirebaseAdmin.Auth.UserRecordArgs)">
<summary>
Updates an existing user account with the attributes contained in the specified <see cref="T:FirebaseAdmin.Auth.UserRecordArgs"/>.
The <see cref="P:FirebaseAdmin.Auth.UserRecordArgs.Uid"/> property must be specified.
</summary>
<param name="args">The attributes to update.</param>
<returns>A task that completes with a <see cref="T:FirebaseAdmin.Auth.UserRecord"/> representing
the updated user account.</returns>
<exception cref="T:System.ArgumentNullException">If <paramref name="args"/> is null.</exception>
<exception cref="T:System.ArgumentException">If any of the values in <paramref name="args"/> are invalid.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If an error occurs while updating the user account.</exception>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.UpdateUserAsync(FirebaseAdmin.Auth.UserRecordArgs,System.Threading.CancellationToken)">
<summary>
Updates an existing user account with the attributes contained in the specified <see cref="T:FirebaseAdmin.Auth.UserRecordArgs"/>.
The <see cref="P:FirebaseAdmin.Auth.UserRecordArgs.Uid"/> property must be specified.
</summary>
<param name="args">The attributes to update.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
<returns>A task that completes with a <see cref="T:FirebaseAdmin.Auth.UserRecord"/> representing
the updated user account.</returns>
<exception cref="T:System.ArgumentNullException">If <paramref name="args"/> is null.</exception>
<exception cref="T:System.ArgumentException">If any of the values in <paramref name="args"/> are invalid.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If an error occurs while updating the user account.</exception>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.RevokeRefreshTokensAsync(System.String)">
<summary>
Revokes all refresh tokens for the specified user.
<para>Updates the user's <c>tokensValidAfterTimestamp</c> to the current UTC time expressed in
seconds since the epoch and truncated to 1 second accuracy. It is important that
the server on which this is called has its clock set correctly and synchronized.</para>
<para>While this will revoke all sessions for a specified user and disable any new ID tokens
for existing sessions from getting minted, existing ID tokens may remain active until
their natural expiration (one hour).</para>
</summary>
<param name="uid">A user ID string.</param>
<returns>A task that completes when the user's refresh tokens have been revoked.</returns>
<exception cref="T:System.ArgumentException">If the user ID argument is null or empty.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If an error occurs while revoking the tokens.</exception>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.RevokeRefreshTokensAsync(System.String,System.Threading.CancellationToken)">
<summary>
Revokes all refresh tokens for the specified user.
<para>Updates the user's <c>tokensValidAfterTimestamp</c> to the current UTC time expressed in
seconds since the epoch and truncated to 1 second accuracy. It is important that
the server on which this is called has its clock set correctly and synchronized.</para>
<para>While this will revoke all sessions for a specified user and disable any new ID tokens
for existing sessions from getting minted, existing ID tokens may remain active until
their natural expiration (one hour).</para>
</summary>
<param name="uid">A user ID string.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
<returns>A task that completes when the user's refresh tokens have been revoked.</returns>
<exception cref="T:System.ArgumentException">If the user ID argument is null or empty.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If an error occurs while revoking the tokens.</exception>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.DeleteUserAsync(System.String)">
<summary>
Deletes the user identified by the specified <paramref name="uid"/>.
</summary>
<param name="uid">A user ID string.</param>
<returns>A task that completes when the user account has been deleted.</returns>
<exception cref="T:System.ArgumentException">If the user ID argument is null or empty.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If an error occurs while deleting the user.</exception>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.DeleteUserAsync(System.String,System.Threading.CancellationToken)">
<summary>
Deletes the user identified by the specified <paramref name="uid"/>.
</summary>
<param name="uid">A user ID string.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
<returns>A task that completes when the user account has been deleted.</returns>
<exception cref="T:System.ArgumentException">If the user ID argument is null or empty.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If an error occurs while deleting the user.</exception>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.DeleteUsersAsync(System.Collections.Generic.IReadOnlyList{System.String})">
<summary>
Deletes the users specified by the given identifiers.
<para>
Deleting a non-existing user won't generate an error. (i.e. this method is idempotent.)
Non-existing users will be considered to be successfully deleted, and will therefore be
counted in the `DeleteUserResult.SuccessCount` value.
</para>
<para>
A maximum of 1000 identifiers may be supplied. If more than 1000 identifiers are
specified, this method throws an <c>ArgumentException</c>.
</para>
<para>
This API is currently rate limited at the server to 1 QPS. If you exceed this, you may
get a quota exceeded error. Therefore, if you want to delete more than 1000 users, you
may need to add a delay to ensure you don't go over this limit.
</para>
</summary>
<param name="uids">The uids of the users to be deleted. Must have 1000 or fewer entries.
</param>
<returns>A task that resolves to the total number of successful/failed
deletions, as well as the array of errors that correspond to the failed deletions.
</returns>
<exception cref="T:System.ArgumentException">If any of the identifiers are invalid or if more
than 1000 identifiers are specified.</exception>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.DeleteUsersAsync(System.Collections.Generic.IReadOnlyList{System.String},System.Threading.CancellationToken)">
<summary>
Deletes the users specified by the given identifiers.
<para>
Deleting a non-existing user won't generate an error. (i.e. this method is idempotent.)
Non-existing users will be considered to be successfully deleted, and will therefore be
counted in the `DeleteUserResult.SuccessCount` value.
</para>
<para>
A maximum of 1000 identifiers may be supplied. If more than 1000 identifiers are
specified, this method throws an <c>ArgumentException</c>.
</para>
<para>
This API is currently rate limited at the server to 1 QPS. If you exceed this, you may
get a quota exceeded error. Therefore, if you want to delete more than 1000 users, you
may need to add a delay to ensure you don't go over this limit.
</para>
</summary>
<param name="uids">The uids of the users to be deleted. Must have 1000 or fewer entries.
</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
<returns>A task that resolves to the total number of successful/failed
deletions, as well as the array of errors that correspond to the failed deletions.
</returns>
<exception cref="T:System.ArgumentException">If any of the identifiers are invalid or if more
than 1000 identifiers are specified.</exception>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.ImportUsersAsync(System.Collections.Generic.IEnumerable{FirebaseAdmin.Auth.ImportUserRecordArgs})">
<summary>
Imports the provided list of users into Firebase Auth. You can import a maximum of
1000 users at a time. This operation is optimized for bulk imports and does not
check identifier uniqueness, which could result in duplications.
<para><a cref="T:FirebaseAdmin.Auth.UserImportOptions">UserImportOptions</a> is required to import users with
passwords. See <a cref="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.ImportUsersAsync(System.Collections.Generic.IEnumerable{FirebaseAdmin.Auth.ImportUserRecordArgs},FirebaseAdmin.Auth.UserImportOptions,System.Threading.CancellationToken)">
FirebaseAuth.ImportUsersAsync</a>.</para>
</summary>
<param name="users"> A non-empty list of users to be imported. Length
must not exceed 1000.</param>
<returns> A <a cref="T:FirebaseAdmin.Auth.UserImportResult">UserImportResult</a> instance.</returns>
<exception cref="T:System.ArgumentException">If the users list is null, empty or has more than
1000 elements. Or if at least one user specifies a password, with no hashing algorithm
set.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If an error occurs while importing users.</exception>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.ImportUsersAsync(System.Collections.Generic.IEnumerable{FirebaseAdmin.Auth.ImportUserRecordArgs},System.Threading.CancellationToken)">
<summary>
Imports the provided list of users into Firebase Auth. You can import a maximum of
1000 users at a time. This operation is optimized for bulk imports and does not
check identifier uniqueness, which could result in duplications.
<para><a cref="T:FirebaseAdmin.Auth.UserImportOptions">UserImportOptions</a> is required to import users with
passwords. See <a cref="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.ImportUsersAsync(System.Collections.Generic.IEnumerable{FirebaseAdmin.Auth.ImportUserRecordArgs},FirebaseAdmin.Auth.UserImportOptions,System.Threading.CancellationToken)">
FirebaseAuth.ImportUsersAsync</a>.</para>
</summary>
<param name="users"> A non-empty list of users to be imported. Length
must not exceed 1000.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
<returns> A <a cref="T:FirebaseAdmin.Auth.UserImportResult">UserImportResult</a> instance.</returns>
<exception cref="T:System.ArgumentException">If the users list is null, empty or has more than
1000 elements. Or if at least one user specifies a password, with no hashing algorithm
set.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If an error occurs while importing users.</exception>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.ImportUsersAsync(System.Collections.Generic.IEnumerable{FirebaseAdmin.Auth.ImportUserRecordArgs},FirebaseAdmin.Auth.UserImportOptions)">
<summary>
Imports the provided list of users into Firebase Auth. You can import a maximum of
1000 users at a time. This operation is optimized for bulk imports and does not
check identifier uniqueness, which could result in duplications.</summary>
<param name="users"> A non-empty list of users to be imported.
Length must not exceed 1000.</param>
<param name="options"> A <a cref="T:FirebaseAdmin.Auth.UserImportOptions">UserImportOptions</a> instance or
null. Required when importing users with passwords.</param>
<returns> A <a cref="T:FirebaseAdmin.Auth.UserImportResult">UserImportResult</a> instance.</returns>
<exception cref="T:System.ArgumentException">If the users list is null, empty or has more than
1000 elements. Or if at least one user specifies a password, with no hashing algorithm
set.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If an error occurs while importing users.</exception>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.ImportUsersAsync(System.Collections.Generic.IEnumerable{FirebaseAdmin.Auth.ImportUserRecordArgs},FirebaseAdmin.Auth.UserImportOptions,System.Threading.CancellationToken)">
<summary>
Imports the provided list of users into Firebase Auth. You can import a maximum of
1000 users at a time. This operation is optimized for bulk imports and does not
check identifier uniqueness, which could result in duplications.</summary>
<param name="users"> A non-empty list of users to be imported.
Length must not exceed 1000.</param>
<param name="options"> A <a cref="T:FirebaseAdmin.Auth.UserImportOptions">UserImportOptions</a> instance or
null. Required when importing users with passwords.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
<returns> A <a cref="T:FirebaseAdmin.Auth.UserImportResult">UserImportResult</a> instance.</returns>
<exception cref="T:System.ArgumentException">If the users list is null, empty or has more than
1000 elements. Or if at least one user specifies a password, with no hashing algorithm
set.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If an error occurs while importing users.</exception>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.SetCustomUserClaimsAsync(System.String,System.Collections.Generic.IReadOnlyDictionary{System.String,System.Object})">
<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 must serialize into
a valid JSON string. The serialized claims must not be larger than 1000 characters.
</summary>
<returns>A task that completes when the claims have been set.</returns>
<exception cref="T:System.ArgumentException">If <paramref name="uid"/> is null, empty or longer
than 128 characters. Or, if the serialized <paramref name="claims"/> is larger than 1000
characters.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">
If an error occurs while setting custom claims. </exception>
<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 the
serialized claims should not be larger than 1000 characters.</param>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.SetCustomUserClaimsAsync(System.String,System.Collections.Generic.IReadOnlyDictionary{System.String,System.Object},System.Threading.CancellationToken)">
<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
a valid JSON string. The serialized claims must not be larger than 1000 characters.
</summary>
<returns>A task that completes when the claims have been set.</returns>
<exception cref="T:System.ArgumentException">If <paramref name="uid"/> is null, empty or longer
than 128 characters. Or, if the serialized <paramref name="claims"/> is larger than 1000
characters.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">
If an error occurs while setting custom claims. </exception>
<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>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.ListUsersAsync(FirebaseAdmin.Auth.ListUsersOptions)">
<summary>
Gets an async enumerable to iterate or page through users starting from the specified
page token. If the page token is null or unspecified, iteration starts from the first
page. See <a href="https://googleapis.github.io/google-cloud-dotnet/docs/guides/page-streaming.html">
Page Streaming</a> for more details on how to use this API.
</summary>
<param name="options">The options to control the starting point and page size. Pass null
to list from the beginning with default settings.</param>
<returns>A <see cref="T:Google.Api.Gax.PagedAsyncEnumerable`2"/> instance.</returns>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.GenerateEmailVerificationLinkAsync(System.String)">
<summary>
Generates the out-of-band email action link for email verification flows for the specified
email address.
</summary>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If an error occurs while generating the link.</exception>
<param name="email">The email of the user to be verified.</param>
<returns>A task that completes with the email verification link.</returns>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.GenerateEmailVerificationLinkAsync(System.String,FirebaseAdmin.Auth.ActionCodeSettings)">
<summary>
Generates the out-of-band email action link for email verification flows for the specified
email address.
</summary>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If an error occurs while generating the link.</exception>
<param name="email">The email of the user to be verifed.</param>
<param name="settings">The action code settings object that defines whether
the link is to be handled by a mobile app and the additional state information to be
passed in the deep link.</param>
<returns>A task that completes with the email verification link.</returns>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.GenerateEmailVerificationLinkAsync(System.String,FirebaseAdmin.Auth.ActionCodeSettings,System.Threading.CancellationToken)">
<summary>
Generates the out-of-band email action link for email verification flows for the specified
email address.
</summary>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If an error occurs while generating the link.</exception>
<param name="email">The email of the user to be verified.</param>
<param name="settings">The action code settings object that defines whether
the link is to be handled by a mobile app and the additional state information to be
passed in the deep link.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
<returns>A task that completes with the email verification reset link.</returns>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.GeneratePasswordResetLinkAsync(System.String)">
<summary>
Generates the out-of-band email action link for password reset flows for the specified
email address.
</summary>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If an error occurs while setting custom claims.</exception>
<param name="email">The email of the user whose password is to be reset.</param>
<returns>A task that completes with the password reset link.</returns>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.GeneratePasswordResetLinkAsync(System.String,FirebaseAdmin.Auth.ActionCodeSettings)">
<summary>
Generates the out-of-band email action link for password reset flows for the specified
email address.
</summary>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If an error occurs while setting custom claims.</exception>
<param name="email">The email of the user whose password is to be reset.</param>
<param name="settings">The action code settings object that defines whether
the link is to be handled by a mobile app and the additional state information to be
passed in the deep link.</param>
<returns>A task that completes with the password reset link.</returns>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.GeneratePasswordResetLinkAsync(System.String,FirebaseAdmin.Auth.ActionCodeSettings,System.Threading.CancellationToken)">
<summary>
Generates the out-of-band email action link for password reset flows for the specified
email address.
</summary>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If an error occurs while setting custom claims.</exception>
<param name="email">The email of the user whose password is to be reset.</param>
<param name="settings">The action code settings object that defines whether
the link is to be handled by a mobile app and the additional state information to be
passed in the deep link.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
<returns>A task that completes with the password reset link.</returns>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.GenerateSignInWithEmailLinkAsync(System.String,FirebaseAdmin.Auth.ActionCodeSettings)">
<summary>
Generates the out-of-band email action link for email link sign-in flows for the
specified email address.
</summary>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If an error occurs while generating the link.</exception>
<param name="email">The email of the user signing in.</param>
<param name="settings">The action code settings object that defines whether
the link is to be handled by a mobile app and the additional state information to be
passed in the deep link.</param>
<returns>A task that completes with the email sign in link.</returns>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.GenerateSignInWithEmailLinkAsync(System.String,FirebaseAdmin.Auth.ActionCodeSettings,System.Threading.CancellationToken)">
<summary>
Generates the out-of-band email action link for email link sign-in flows for the
specified email address.
</summary>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If an error occurs while generating the link.</exception>
<param name="email">The email of the user signing in.</param>
<param name="settings">The action code settings object that defines whether
the link is to be handled by a mobile app and the additional state information to be
passed in the deep link.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
<returns>A task that completes with the email sign in link.</returns>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.GetOidcProviderConfigAsync(System.String)">
<summary>
Looks up an OIDC auth provider configuration by the provided ID.
</summary>
<returns>A task that completes with a <see cref="T:FirebaseAdmin.Auth.Providers.OidcProviderConfig"/>.</returns>
<exception cref="T:System.ArgumentException">If the provider ID is null, empty or does not
contain the <c>oidc.</c> prefix.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If the specified provider config does not
exist.</exception>
<param name="providerId">The ID of the OIDC provider config to return.</param>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.GetOidcProviderConfigAsync(System.String,System.Threading.CancellationToken)">
<summary>
Looks up an OIDC auth provider configuration by the provided ID.
</summary>
<returns>A task that completes with a <see cref="T:FirebaseAdmin.Auth.Providers.OidcProviderConfig"/>.</returns>
<exception cref="T:System.ArgumentException">If the provider ID is null, empty or does not
contain the <c>oidc.</c> prefix.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If the specified provider config does not
exist.</exception>
<param name="providerId">The ID of the OIDC provider config to return.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.GetSamlProviderConfigAsync(System.String)">
<summary>
Looks up a SAML auth provider configuration by the provided ID.
</summary>
<returns>A task that completes with a <see cref="T:FirebaseAdmin.Auth.Providers.SamlProviderConfig"/>.</returns>
<exception cref="T:System.ArgumentException">If the provider ID is null, empty or does not
contain the <c>saml.</c> prefix.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If the specified provider config does not
exist.</exception>
<param name="providerId">The ID of the SAML provider config to return.</param>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.GetSamlProviderConfigAsync(System.String,System.Threading.CancellationToken)">
<summary>
Looks up a SAML auth provider configuration by the provided ID.
</summary>
<returns>A task that completes with a <see cref="T:FirebaseAdmin.Auth.Providers.SamlProviderConfig"/>.</returns>
<exception cref="T:System.ArgumentException">If the provider ID is null, empty or does not
contain the <c>saml.</c> prefix.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If the specified provider config does not
exist.</exception>
<param name="providerId">The ID of the SAML provider config to return.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.CreateProviderConfigAsync``1(FirebaseAdmin.Auth.Providers.AuthProviderConfigArgs{``0})">
<summary>
Creates a new auth provider configuration.
</summary>
<returns>A task that completes with an <see cref="T:FirebaseAdmin.Auth.Providers.AuthProviderConfig"/>.</returns>
<exception cref="T:System.ArgumentException">If <paramref name="args"/> is null or
invalid.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If an unexpected error occurs while creating
the provider configuration.</exception>
<param name="args">Arguments that describe the new provider configuration.</param>
<typeparam name="T">Type of <see cref="T:FirebaseAdmin.Auth.Providers.AuthProviderConfig"/> to create.</typeparam>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.CreateProviderConfigAsync``1(FirebaseAdmin.Auth.Providers.AuthProviderConfigArgs{``0},System.Threading.CancellationToken)">
<summary>
Creates a new auth provider configuration.
</summary>
<returns>A task that completes with an <see cref="T:FirebaseAdmin.Auth.Providers.AuthProviderConfig"/>.</returns>
<exception cref="T:System.ArgumentException">If <paramref name="args"/> is null or
invalid.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If an unexpected error occurs while creating
the provider configuration.</exception>
<param name="args">Arguments that describe the new provider configuration.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
<typeparam name="T">Type of <see cref="T:FirebaseAdmin.Auth.Providers.AuthProviderConfig"/> to create.</typeparam>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.UpdateProviderConfigAsync``1(FirebaseAdmin.Auth.Providers.AuthProviderConfigArgs{``0})">
<summary>
Updates an existing auth provider configuration.
</summary>
<returns>A task that completes with the updated <see cref="T:FirebaseAdmin.Auth.Providers.AuthProviderConfig"/>.
</returns>
<exception cref="T:System.ArgumentException">If <paramref name="args"/> is null or
invalid.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If the specified provider config does not
exist or if an unexpected error occurs while performing the update.</exception>
<param name="args">Properties to be updated in the provider configuration.</param>
<typeparam name="T">Type of <see cref="T:FirebaseAdmin.Auth.Providers.AuthProviderConfig"/> to update.</typeparam>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.UpdateProviderConfigAsync``1(FirebaseAdmin.Auth.Providers.AuthProviderConfigArgs{``0},System.Threading.CancellationToken)">
<summary>
Updates an existing auth provider configuration.
</summary>
<returns>A task that completes with the updated <see cref="T:FirebaseAdmin.Auth.Providers.AuthProviderConfig"/>.
</returns>
<exception cref="T:System.ArgumentException">If <paramref name="args"/> is null or
invalid.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If the specified provider config does not
exist or if an unexpected error occurs while performing the update.</exception>
<param name="args">Properties to be updated in the provider configuration.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
<typeparam name="T">Type of <see cref="T:FirebaseAdmin.Auth.Providers.AuthProviderConfig"/> to update.</typeparam>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.DeleteProviderConfigAsync(System.String)">
<summary>
Deletes the specified auth provider configuration.
</summary>
<returns>A task that completes when the provider configuration is deleted.</returns>
<exception cref="T:System.ArgumentException">If the provider ID is null, empty or does not
contain either the <c>oidc.</c> or <c>saml.</c> prefix.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If the specified provider config does not
exist.</exception>
<param name="providerId">ID of the provider configuration to delete.</param>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.DeleteProviderConfigAsync(System.String,System.Threading.CancellationToken)">
<summary>
Deletes the specified auth provider configuration.
</summary>
<returns>A task that completes when the provider configuration is deleted.</returns>
<exception cref="T:System.ArgumentException">If the provider ID is null, empty or does not
contain either the <c>oidc.</c> or <c>saml.</c> prefix.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If the specified provider config does not
exist.</exception>
<param name="providerId">ID of the provider configuration to delete.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.ListOidcProviderConfigsAsync(FirebaseAdmin.Auth.Providers.ListProviderConfigsOptions)">
<summary>
Gets an async enumerable to iterate or page through OIDC provider configurations
starting from the specified page token. If the page token is null or unspecified,
iteration starts from the first page. See
<a href="https://googleapis.github.io/google-cloud-dotnet/docs/guides/page-streaming.html">
Page Streaming</a> for more details on how to use this API.
</summary>
<param name="options">The options to control the starting point and page size. Pass
null to list from the beginning with default settings.</param>
<returns>A <see cref="T:Google.Api.Gax.PagedAsyncEnumerable`2"/>
instance.</returns>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.ListSamlProviderConfigsAsync(FirebaseAdmin.Auth.Providers.ListProviderConfigsOptions)">
<summary>
Gets an async enumerable to iterate or page through SAML provider configurations
starting from the specified page token. If the page token is null or unspecified,
iteration starts from the first page. See
<a href="https://googleapis.github.io/google-cloud-dotnet/docs/guides/page-streaming.html">
Page Streaming</a> for more details on how to use this API.
</summary>
<param name="options">The options to control the starting point and page size. Pass
null to list from the beginning with default settings.</param>
<returns>A <see cref="T:Google.Api.Gax.PagedAsyncEnumerable`2"/>
instance.</returns>
</member>
<member name="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.FirebaseAdmin#IFirebaseService#Delete">
<summary>
Deletes this <see cref="T:FirebaseAdmin.Auth.FirebaseAuth"/> service instance.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.ActionCodeSettings">
<summary>
Defines the required continue/state URL with optional Android and iOS settings. Used when
invoking the email action link generation APIs in <see cref="T:FirebaseAdmin.Auth.FirebaseAuth"/>.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.ActionCodeSettings.Url">
<summary>
Gets or sets the continue/state URL. This property has different meanings in different
contexts.
<list type="bullet">
<item>
<description>
When the link is handled in the web action widgets, this is the deep link in the
<c>continueUrl</c> query parameter.
</description>
</item>
<item>
<description>
When the link is handled in the app directly, this is the <c>continueUrl</c> query
parameter in the deep link of the Dynamic Link.
</description>
</item>
</list>
This property is required.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.ActionCodeSettings.HandleCodeInApp">
<summary>
Gets or sets a value indicating whether to open the link via a mobile app or a browser.
The default is false. When set to true, the action code link is sent as a Universal
Link or an Android App Link and is opened by the app if installed. In the false case,
the code is sent to the web widget first and then redirects to the app if installed.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.ActionCodeSettings.DynamicLinkDomain">
<summary>
Gets or sets the dynamic link domain to use for the current link if it is to be opened
using Firebase Dynamic Links, as multiple dynamic link domains can be configured per
project. This setting provides the ability to explicitly choose one. If none is provided,
the oldest domain is used by default.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.ActionCodeSettings.IosBundleId">
<summary>
Gets or sets the bundle ID of the iOS app where the link should be handled if the
application is already installed on the device.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.ActionCodeSettings.AndroidPackageName">
<summary>
Gets or sets the Android package name of the app where the link should be handled if
the Android app is installed. Must be specified when setting other Android-specific
settings.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.ActionCodeSettings.AndroidMinimumVersion">
<summary>
Gets or sets the minimum version for the Android app. If the installed app is an older
version, the user is taken to the Play Store to upgrade the app.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.ActionCodeSettings.AndroidInstallApp">
<summary>
Gets or sets a value indicating whether to install the Android app if the device
supports it and the app is not already installed.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.AuthErrorCode">
<summary>
Error codes that can be raised by the Firebase Auth APIs.
</summary>
</member>
<member name="F:FirebaseAdmin.Auth.AuthErrorCode.CertificateFetchFailed">
<summary>
Failed to retrieve required public key certificates.
</summary>
</member>
<member name="F:FirebaseAdmin.Auth.AuthErrorCode.EmailAlreadyExists">
<summary>
The user with the provided email already exists.
</summary>
</member>
<member name="F:FirebaseAdmin.Auth.AuthErrorCode.ExpiredIdToken">
<summary>
The specified ID token is expired.
</summary>
</member>
<member name="F:FirebaseAdmin.Auth.AuthErrorCode.InvalidIdToken">
<summary>
The specified ID token is invalid.
</summary>
</member>
<member name="F:FirebaseAdmin.Auth.AuthErrorCode.PhoneNumberAlreadyExists">
<summary>
The user with the provided phone number already exists.
</summary>
</member>
<member name="F:FirebaseAdmin.Auth.AuthErrorCode.UidAlreadyExists">
<summary>
The user with the provided uid already exists.
</summary>
</member>
<member name="F:FirebaseAdmin.Auth.AuthErrorCode.UnexpectedResponse">
<summary>
Backend API responded with an unexpected message.
</summary>
</member>
<member name="F:FirebaseAdmin.Auth.AuthErrorCode.UserNotFound">
<summary>
No user record found for the given identifier.
</summary>
</member>
<member name="F:FirebaseAdmin.Auth.AuthErrorCode.InvalidDynamicLinkDomain">
<summary>
Dynamic link domain specified in <see cref="T:FirebaseAdmin.Auth.ActionCodeSettings"/> is not authorized.
</summary>
</member>
<member name="F:FirebaseAdmin.Auth.AuthErrorCode.RevokedIdToken">
<summary>
The specified ID token has been revoked.
</summary>
</member>
<member name="F:FirebaseAdmin.Auth.AuthErrorCode.InvalidSessionCookie">
<summary>
The specified session cookie is invalid.
</summary>
</member>
<member name="F:FirebaseAdmin.Auth.AuthErrorCode.ExpiredSessionCookie">
<summary>
The specified session cookie is expired.
</summary>
</member>
<member name="F:FirebaseAdmin.Auth.AuthErrorCode.RevokedSessionCookie">
<summary>
The specified session cookie has been revoked.
</summary>
</member>
<member name="F:FirebaseAdmin.Auth.AuthErrorCode.ConfigurationNotFound">
<summary>
No identity provider configuration found for the given identifier.
</summary>
</member>
<member name="F:FirebaseAdmin.Auth.AuthErrorCode.TenantNotFound">
<summary>
No tenant found for the given identifier.
</summary>
</member>
<member name="F:FirebaseAdmin.Auth.AuthErrorCode.TenantIdMismatch">
<summary>
Tenant ID in a token does not match.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.AuthErrorHandler">
<summary>
Parses error responses received from the Auth service, and creates instances of
<see cref="T:FirebaseAdmin.Auth.FirebaseAuthException"/>.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.AuthErrorHandler.ErrorInfo">
<summary>
Describes a class of errors that can be raised by the Firebase Auth backend API.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.AuthErrorHandler.AuthError.Code">
<summary>
Gets the Firebase Auth error code extracted from the response. Returns empty string
if the error code cannot be determined.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.AuthErrorHandler.AuthError.Detail">
<summary>
Gets the error detail sent by the Firebase Auth API. May be null.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.DeleteUsersResult">
<summary>
Represents the result of the
<see cref="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.DeleteUsersAsync(System.Collections.Generic.IReadOnlyList{System.String})"/> API.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.DeleteUsersResult.SuccessCount">
<summary>
Gets the number of users that were deleted successfully (possibly zero). Users that
did not exist prior to calling
<see cref="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.DeleteUsersAsync(System.Collections.Generic.IReadOnlyList{System.String})"/> are considered to
be successfully deleted.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.DeleteUsersResult.FailureCount">
<summary>
Gets the number of users that `DeleteUsersAsync` failed to be deleted (possibly zero).
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.DeleteUsersResult.Errors">
<summary>
Gets a list of <see cref="T:FirebaseAdmin.Auth.ErrorInfo"/> instances describing the errors that were
encountered during the deletion. Length of this list is equal to the return value of
<see cref="P:FirebaseAdmin.Auth.DeleteUsersResult.FailureCount"/>.
</summary>
<returns>A non-null list (possibly empty).</returns>
</member>
<member name="T:FirebaseAdmin.Auth.EmailIdentifier">
<summary>
Used for looking up an account by email.
See <see cref="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.GetUsersAsync(System.Collections.Generic.IReadOnlyCollection{FirebaseAdmin.Auth.UserIdentifier})"/>.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.EmailIdentifier.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:FirebaseAdmin.Auth.EmailIdentifier"/> class.
</summary>
<param name="email">The email.</param>
</member>
<member name="M:FirebaseAdmin.Auth.EmailIdentifier.ToString">
<inheritdoc/>
</member>
<member name="T:FirebaseAdmin.Auth.ErrorInfo">
<summary>
Represents an error encountered while performing a batch operation such as
<see cref="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.ImportUsersAsync(System.Collections.Generic.IEnumerable{FirebaseAdmin.Auth.ImportUserRecordArgs})"/> or
<see cref="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.DeleteUsersAsync(System.Collections.Generic.IReadOnlyList{System.String})"/>.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.ErrorInfo.Index">
<summary>
Gets the index of the entry that caused the error.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.ErrorInfo.Reason">
<summary>
Gets a string describing the error.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.ExportedUserRecord">
<summary>
Contains metadata associated with a Firebase user account, along with password hash and salt.
Instances of this class are immutable and thread safe.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.ExportedUserRecord.PasswordHash">
<summary>
Gets the user's password hash as a base64-encoded string.
If the Firebase Auth hashing algorithm (SCRYPT) was used to create the user account,
returns the base64-encoded password hash of the user. If a different hashing algorithm was
used to create this user, as is typical when migrating from another Auth system, returns
an empty string. Returns null if no password is set.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.ExportedUserRecord.PasswordSalt">
<summary>
Gets the user's password salt as a base64-encoded string.
If the Firebase Auth hashing algorithm (SCRYPT) was used to create the user account,
returns the base64-encoded password salt of the user. If a different hashing algorithm was
used to create this user, as is typical when migrating from another Auth system, returns
an empty string. Returns null if no password is set.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.ExportedUserRecords">
<summary>
Contains a collection of Firebase user accounts.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.ExportedUserRecords.NextPageToken">
<summary>
Gets the token representing the next page of users. Null if there are no more pages.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.ExportedUserRecords.Users">
<summary>
Gets the users included in the current page.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.FirebaseAuth">
<summary>
This is the entry point to all server-side Firebase Authentication operations. You can
get an instance of this class via <c>FirebaseAuth.DefaultInstance</c>.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.FirebaseAuth.DefaultInstance">
<summary>
Gets the auth instance associated with the default Firebase app. This property is
<c>null</c> if the default app doesn't yet exist.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.FirebaseAuth.TenantManager">
<summary>
Gets the <see cref="P:FirebaseAdmin.Auth.FirebaseAuth.TenantManager"/> instance associated with the current project.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.FirebaseAuth.GetAuth(FirebaseAdmin.FirebaseApp)">
<summary>
Returns the auth instance for the specified app.
</summary>
<returns>The <see cref="T:FirebaseAdmin.Auth.FirebaseAuth"/> instance associated with the specified
app.</returns>
<exception cref="T:System.ArgumentNullException">If the app argument is null.</exception>
<param name="app">An app instance.</param>
</member>
<member name="M:FirebaseAdmin.Auth.FirebaseAuth.CreateSessionCookieAsync(System.String,FirebaseAdmin.Auth.SessionCookieOptions)">
<summary>
Creates a new Firebase session cookie from the given ID token and options. The returned JWT can
be set as a server-side session cookie with a custom cookie policy.
</summary>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If an error occurs while creating the cookie.</exception>
<param name="idToken">The Firebase ID token to exchange for a session cookie.</param>
<param name="options">Additional options required to create the cookie.</param>
<returns>A task that completes with the Firebase session cookie.</returns>
</member>
<member name="M:FirebaseAdmin.Auth.FirebaseAuth.CreateSessionCookieAsync(System.String,FirebaseAdmin.Auth.SessionCookieOptions,System.Threading.CancellationToken)">
<summary>
Creates a new Firebase session cookie from the given ID token and options. The returned JWT can
be set as a server-side session cookie with a custom cookie policy.
</summary>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If an error occurs while creating the cookie.</exception>
<param name="idToken">The Firebase ID token to exchange for a session cookie.</param>
<param name="options">Additional options required to create the cookie.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
<returns>A task that completes with the Firebase session cookie.</returns>
</member>
<member name="M:FirebaseAdmin.Auth.FirebaseAuth.VerifySessionCookieAsync(System.String)">
<summary>
Parses and verifies a Firebase session cookie.
<para>See <a href="https://firebase.google.com/docs/auth/admin/manage-cookies">Manage
Session Cookies</a> for code samples and detailed documentation.</para>
</summary>
<returns>A task that completes with a <see cref="T:FirebaseAdmin.Auth.FirebaseToken"/> representing
the verified and decoded session cookie.</returns>
<exception cref="T:System.ArgumentException">If the session cookie is null or
empty.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If the session cookie is invalid.</exception>
<param name="sessionCookie">A Firebase session cookie string to verify and
parse.</param>
</member>
<member name="M:FirebaseAdmin.Auth.FirebaseAuth.VerifySessionCookieAsync(System.String,System.Threading.CancellationToken)">
<summary>
Parses and verifies a Firebase session cookie.
<para>See <a href="https://firebase.google.com/docs/auth/admin/manage-cookies">Manage
Session Cookies</a> for code samples and detailed documentation.</para>
</summary>
<returns>A task that completes with a <see cref="T:FirebaseAdmin.Auth.FirebaseToken"/> representing
the verified and decoded session cookie.</returns>
<exception cref="T:System.ArgumentException">If the session cookie is null or
empty.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If the session cookie is invalid.</exception>
<param name="sessionCookie">A Firebase session cookie string to verify and
parse.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
</member>
<member name="M:FirebaseAdmin.Auth.FirebaseAuth.VerifySessionCookieAsync(System.String,System.Boolean)">
<summary>
Parses and verifies a Firebase session cookie.
<para>See <a href="https://firebase.google.com/docs/auth/admin/manage-cookies">Manage
Session Cookies</a> for code samples and detailed documentation.</para>
</summary>
<returns>A task that completes with a <see cref="T:FirebaseAdmin.Auth.FirebaseToken"/> representing
the verified and decoded session cookie.</returns>
<exception cref="T:System.ArgumentException">If the session cookie is null or
empty.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If the session cookie is invalid.</exception>
<param name="sessionCookie">A Firebase session cookie string to verify and
parse.</param>
<param name="checkRevoked">A boolean indicating whether to check if the tokens were
revoked.</param>
</member>
<member name="M:FirebaseAdmin.Auth.FirebaseAuth.VerifySessionCookieAsync(System.String,System.Boolean,System.Threading.CancellationToken)">
<summary>
Parses and verifies a Firebase session cookie.
<para>See <a href="https://firebase.google.com/docs/auth/admin/manage-cookies">Manage
Session Cookies</a> for code samples and detailed documentation.</para>
</summary>
<returns>A task that completes with a <see cref="T:FirebaseAdmin.Auth.FirebaseToken"/> representing
the verified and decoded session cookie.</returns>
<exception cref="T:System.ArgumentException">If the session cookie is null or
empty.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If the session cookie is invalid.</exception>
<param name="sessionCookie">A Firebase session cookie string to verify and
parse.</param>
<param name="checkRevoked">A boolean indicating whether to check if the tokens were
revoked.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
</member>
<member name="M:FirebaseAdmin.Auth.FirebaseAuth.Cleanup">
<summary>
Deletes this <see cref="T:FirebaseAdmin.Auth.FirebaseAuth"/> service instance.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.FirebaseAuthException">
<summary>
Exception type raised by Firebase Auth APIs.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.FirebaseAuthException.AuthErrorCode">
<summary>
Gets the Firease Auth error code associated with this exception. May be null.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.FirebaseToken">
<summary>
Represents a valid, decoded Firebase ID token. It can be used to get the <c>Uid</c> and
other claims available in the token.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.FirebaseToken.Issuer">
<summary>
Gets the issuer claim that identifies the principal that issued the JWT.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.FirebaseToken.Subject">
<summary>
Gets the subject claim identifying the principal that is the subject of the JWT.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.FirebaseToken.Audience">
<summary>
Gets the audience claim that identifies the audience that the JWT is intended for.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.FirebaseToken.ExpirationTimeSeconds">
<summary>
Gets the expiration time claim that identifies the expiration time (in seconds)
on or after which the token MUST NOT be accepted for processing.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.FirebaseToken.IssuedAtTimeSeconds">
<summary>
Gets the issued at claim that identifies the time (in seconds) at which the JWT was
issued.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.FirebaseToken.Uid">
<summary>
Gets the User ID of the user to which this ID token belongs. This is same as
<see cref="P:FirebaseAdmin.Auth.FirebaseToken.Subject"/>.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.FirebaseToken.TenantId">
<summary>
Gets the ID of the tenant the user belongs to, if available. Returns null if the ID
token is not scoped to a tenant.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.FirebaseToken.Claims">
<summary>
Gets all other claims present in the JWT as a readonly dictionary. This can be used to
access custom claims of the token.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.GetUsersResult">
<summary>
Represents the result of the
<see cref="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.GetUsersAsync(System.Collections.Generic.IReadOnlyCollection{FirebaseAdmin.Auth.UserIdentifier})"/> API.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.GetUsersResult.Users">
<summary>
Gets user records corresponding to the set of users that were requested. Only
users that were found are listed here. The result set is unordered.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.GetUsersResult.NotFound">
<summary>
Gets the set of identifiers that were requested, but not found.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Hash.Bcrypt">
<summary>
Represents the Bcrypt password hashing algorithm. Can be used as an instance of
<a cref="T:FirebaseAdmin.Auth.UserImportHash">UserImportHash</a> when importing users.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.Hash.Bcrypt.#ctor">
<summary>
Initializes a new instance of the <see cref="T:FirebaseAdmin.Auth.Hash.Bcrypt"/> class.
Defines name to be equal to BCRYPT.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.Hash.Bcrypt.GetHashConfiguration">
<summary>
Returns an empty dictionary representing no options for the Bcrypt hashing algorithm.
</summary>
<returns>
Dictionary defining no options.
</returns>
</member>
<member name="T:FirebaseAdmin.Auth.Hash.Hmac">
<summary>
Base class for Hmac type hashes.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.Hash.Hmac.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:FirebaseAdmin.Auth.Hash.Hmac"/> class.
Propogates the name to <c>UserImportHash</c>.
</summary>
<param name="hashName">The name of the hashing algorithm.</param>
</member>
<member name="P:FirebaseAdmin.Auth.Hash.Hmac.Key">
<summary>
Gets or sets the key for the hash.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.Hash.Hmac.GetHashConfiguration">
<summary>
Verifies that the is key non-empty or null and returns the options dictionary.
</summary>
<returns>
Returns the dictionary containing an entry for the signing key.
</returns>
</member>
<member name="T:FirebaseAdmin.Auth.Hash.HmacMd5">
<summary>
Represents the HMAC MD5 password hashing algorithm. Can be used as an instance of
<a cref="T:FirebaseAdmin.Auth.UserImportHash">UserImportHash</a> when importing users.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.Hash.HmacMd5.#ctor">
<summary>
Initializes a new instance of the <see cref="T:FirebaseAdmin.Auth.Hash.HmacMd5"/> class.
Defines the name of the hash to be equal to HMAC_MD5.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Hash.HmacSha1">
<summary>
Represents the HMAC SHA1 password hashing algorithm. Can be used as an instance of
<a cref="T:FirebaseAdmin.Auth.UserImportHash">UserImportHash</a> when importing users.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.Hash.HmacSha1.#ctor">
<summary>
Initializes a new instance of the <see cref="T:FirebaseAdmin.Auth.Hash.HmacSha1"/> class.
Defines the name of the hash to be equal to HMAC_SHA1.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Hash.HmacSha256">
<summary>
Represents the HMAC SHA256 password hashing algorithm. Can be used as an instance of
<a cref="T:FirebaseAdmin.Auth.UserImportHash">UserImportHash</a> when importing users.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.Hash.HmacSha256.#ctor">
<summary>
Initializes a new instance of the <see cref="T:FirebaseAdmin.Auth.Hash.HmacSha256"/> class.
Defines the name of the hash to be equal to HMAC_SHA256.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Hash.HmacSha512">
<summary>
Represents the HMAC SHA512 password hashing algorithm. Can be used as an instance of
<a cref="T:FirebaseAdmin.Auth.UserImportHash">UserImportHash</a> when importing users.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.Hash.HmacSha512.#ctor">
<summary>
Initializes a new instance of the <see cref="T:FirebaseAdmin.Auth.Hash.HmacSha512"/> class.
Defines the name of the hash to be equal to HMAC_SHA512.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Hash.Md5">
<summary>
Represents the MD5 password hashing algorithm. Can be used as an instance of
<a cref="T:FirebaseAdmin.Auth.UserImportHash">UserImportHash</a> when importing users.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.Hash.Md5.#ctor">
<summary>
Initializes a new instance of the <see cref="T:FirebaseAdmin.Auth.Hash.Md5"/> class.
Defines the name of the hash to be equal to MD5.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Hash.Md5.MinRounds">
<summary>
Gets the minimum number of rounds for an MD5 hash, which is 0.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Hash.Md5.MaxRounds">
<summary>
Gets the maximum number of rounds for an MD5 hash, which is 8192.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Hash.Pbkdf2Sha256">
<summary>
Represents the PBKDF2 SHA256 password hashing algorithm. Can be used as an instance of
<a cref="T:FirebaseAdmin.Auth.UserImportHash">UserImportHash</a> when importing users.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.Hash.Pbkdf2Sha256.#ctor">
<summary>
Initializes a new instance of the <see cref="T:FirebaseAdmin.Auth.Hash.Pbkdf2Sha256"/> class.
Defines the name of the hash to be equal to PBKDF2_SHA256.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Hash.Pbkdf2Sha256.MinRounds">
<summary>
Gets the minimum number of rounds for a Pbkdf2 Sha256 hash, which is 0.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Hash.Pbkdf2Sha256.MaxRounds">
<summary>
Gets the maximum number of rounds for a Pbkdf2 Sha256 hash, which is 120000.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Hash.PbkdfSha1">
<summary>
Represents the PBKDF SHA1 password hashing algorithm. Can be used as an instance of
<a cref="T:FirebaseAdmin.Auth.UserImportHash">UserImportHash</a> when importing users.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.Hash.PbkdfSha1.#ctor">
<summary>
Initializes a new instance of the <see cref="T:FirebaseAdmin.Auth.Hash.PbkdfSha1"/> class.
Defines the name of the hash to be equal to PBKDF_SHA1.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Hash.PbkdfSha1.MinRounds">
<summary>
Gets the minimum number of rounds for a Pbkdf Sha1 hash, which is 0.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Hash.PbkdfSha1.MaxRounds">
<summary>
Gets the maximum number of rounds for a Pbkdf Sha1 hash, which is 120000.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Hash.RepeatableHash">
<summary>
An abstract <a cref="T:FirebaseAdmin.Auth.UserImportHash">UserImportHash</a> implementation for specifying a
<c>Rounds</c> count in a given range.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.Hash.RepeatableHash.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:FirebaseAdmin.Auth.Hash.RepeatableHash"/> class.
Propogates the name to <c>UserImportHash</c>.
</summary>
<param name="hashName">The name of the hashing algorithm.</param>
</member>
<member name="P:FirebaseAdmin.Auth.Hash.RepeatableHash.Rounds">
<summary>
Gets or sets the number of rounds for the repeatable hash.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Hash.RepeatableHash.MinRounds">
<summary>
Gets the minimum number of rounds for that respective repeatable hash implementation.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Hash.RepeatableHash.MaxRounds">
<summary>
Gets the maximum number of rounds for that respective repeatable hash implementation.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.Hash.RepeatableHash.GetHashConfiguration">
<summary>
Returns a dictionary specifying the number of rounds the hashing algorithm
was set to iterate over.
</summary>
<returns>Dictionary containing the number of rounds.</returns>
</member>
<member name="T:FirebaseAdmin.Auth.Hash.Scrypt">
<summary>
Represents the Scrypt password hashing algorithm. This is the
<a href="https://github.com/firebase/scrypt">modified Scrypt algorithm</a> used by
Firebase Auth. See <a cref="T:FirebaseAdmin.Auth.Hash.StandardScrypt">StandardScrypt</a> for the standard
Scrypt algorithm. Can be used as an instance of
<a cref="T:FirebaseAdmin.Auth.UserImportHash">UserImportHash</a> when importing users.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.Hash.Scrypt.#ctor">
<summary>
Initializes a new instance of the <see cref="T:FirebaseAdmin.Auth.Hash.Scrypt"/> class.
Defines the name of the hash to be equal to SCRYPT.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Hash.Scrypt.Key">
<summary>
Gets or sets the signer key for the hashing algorithm.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Hash.Scrypt.SaltSeparator">
<summary>
Gets or sets the salt separator for the hashing algorithm.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Hash.Scrypt.MemoryCost">
<summary>
Gets or sets the memory cost for the hashing algorithm.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Hash.Scrypt.MinRounds">
<summary>
Gets the minimum number of rounds for a Scrypt hash, which is 0.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Hash.Scrypt.MaxRounds">
<summary>
Gets the maximum number of rounds for a Scrypt hash, which is 8.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.Hash.Scrypt.GetHashConfiguration">
<summary>
Returns the options for the hashing algorithm.
</summary>
<returns>
Dictionary defining options such as signer key.
</returns>
</member>
<member name="T:FirebaseAdmin.Auth.Hash.Sha1">
<summary>
Represents the SHA1 password hashing algorithm. Can be used as an instance of
<a cref="T:FirebaseAdmin.Auth.UserImportHash">UserImportHash</a> when importing users.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.Hash.Sha1.#ctor">
<summary>
Initializes a new instance of the <see cref="T:FirebaseAdmin.Auth.Hash.Sha1"/> class.
Defines the name of the hash to be equal to SHA1.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Hash.Sha1.MinRounds">
<summary>
Gets the minimum number of rounds for a SHA1 hash, which is 1.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Hash.Sha1.MaxRounds">
<summary>
Gets the maximum number of rounds for a SHA1 hash, which is 8192.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Hash.Sha256">
<summary>
Represents the SHA256 password hashing algorithm. Can be used as an instance of
<a cref="T:FirebaseAdmin.Auth.UserImportHash">UserImportHash</a> when importing users.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.Hash.Sha256.#ctor">
<summary>
Initializes a new instance of the <see cref="T:FirebaseAdmin.Auth.Hash.Sha256"/> class.
Defines the name of the hash to be equal to SHA256.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Hash.Sha256.MinRounds">
<summary>
Gets the minimum number of rounds for a SHA256 hash, which is 1.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Hash.Sha256.MaxRounds">
<summary>
Gets the maximum number of rounds for a SHA256 hash, which is 8192.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Hash.Sha512">
<summary>
Represents the SHA512 password hashing algorithm. Can be used as an instance of
<a cref="T:FirebaseAdmin.Auth.UserImportHash">UserImportHash</a> when importing users.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.Hash.Sha512.#ctor">
<summary>
Initializes a new instance of the <see cref="T:FirebaseAdmin.Auth.Hash.Sha512"/> class.
Defines the name of the hash to be equal to SHA512.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Hash.Sha512.MinRounds">
<summary>
Gets the minimum number of rounds for a SHA512 hash, which is 1.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Hash.Sha512.MaxRounds">
<summary>
Gets the maximum number of rounds for a SHA512 hash, which is 8192.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Hash.StandardScrypt">
<summary>
Represents the Standard Scrypt password hashing algorithm. Can be used as an instance of
<a cref="T:FirebaseAdmin.Auth.UserImportHash">UserImportHash</a> when importing users.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.Hash.StandardScrypt.#ctor">
<summary>
Initializes a new instance of the <see cref="T:FirebaseAdmin.Auth.Hash.StandardScrypt"/> class.
Defines the name of the hash to be equal to STANDARD_SCRYPT.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Hash.StandardScrypt.DerivedKeyLength">
<summary>
Gets or sets the derived key length for the hashing algorithm.
<remarks>The length cannot be negative.</remarks>
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Hash.StandardScrypt.BlockSize">
<summary>
Gets or sets the block size for the hashing algorithm.
<remarks>The size cannot be negative.</remarks>
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Hash.StandardScrypt.Parallelization">
<summary>
Gets or sets parallelization of the hashing algorithm.
<remarks> The parallelization factor cannot be negative. </remarks>
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Hash.StandardScrypt.MemoryCost">
<summary>
Gets or sets memory cost for the hashing algorithm.
<remarks> The memory cost cannot be negative. </remarks>
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.Hash.StandardScrypt.GetHashConfiguration">
<summary>
Returns the options for the hashing algorithm.
</summary>
<returns>
Dictionary defining options such as derived key length, block size, parallelization and memory cost.
</returns>
</member>
<member name="T:FirebaseAdmin.Auth.ImportUserRecordArgs">
<summary>
Represents a user account to be imported to Firebase Auth via the
<see cref="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.ImportUsersAsync(System.Collections.Generic.IEnumerable{FirebaseAdmin.Auth.ImportUserRecordArgs})"/> API.
Must contain at least a user ID string.
</summary>
</member>
<member name="F:FirebaseAdmin.Auth.ImportUserRecordArgs.CustomAttributes">
<summary>
Key name for custom attributes.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.ImportUserRecordArgs.Uid">
<summary>
Gets or sets the user ID of the user.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.ImportUserRecordArgs.Email">
<summary>
Gets or sets the email address of the user.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.ImportUserRecordArgs.EmailVerified">
<summary>
Gets or sets if the email was verified, null signifies that it was not specified.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.ImportUserRecordArgs.DisplayName">
<summary>
Gets or sets the display name of the user.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.ImportUserRecordArgs.PhoneNumber">
<summary>
Gets or sets phone number of the user.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.ImportUserRecordArgs.PhotoUrl">
<summary>
Gets or sets the photo URL.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.ImportUserRecordArgs.Disabled">
<summary>
Gets or sets the disabled value, null signifies that it was not specified.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.ImportUserRecordArgs.UserMetadata">
<summary>
Gets or sets the user metadata.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.ImportUserRecordArgs.PasswordHash">
<summary>
Gets or sets the password hash.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.ImportUserRecordArgs.PasswordSalt">
<summary>
Gets or sets the password salt.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.ImportUserRecordArgs.UserProviders">
<summary>
Gets or sets the user providers.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.ImportUserRecordArgs.CustomClaims">
<summary>
Gets or sets the custom claims.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.IUserInfo">
<summary>
A collection of standard profile information for a user. Used to expose profile information
returned by an identity provider.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.IUserInfo.Uid">
<summary>
Gets the user's unique ID assigned by the identity provider.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.IUserInfo.DisplayName">
<summary>
Gets the user's display name, if available. Otherwise null.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.IUserInfo.Email">
<summary>
Gets the user's email address, if available. Otherwise null.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.IUserInfo.PhoneNumber">
<summary>
Gets the user's phone number, if available. Otherwise null.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.IUserInfo.PhotoUrl">
<summary>
Gets the user's photo URL, if available. Otherwise null.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.IUserInfo.ProviderId">
<summary>
Gets the ID of the identity provider. This can be a short domain name (e.g. google.com) or
the identifier of an OpenID identity provider.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Jwt.FirebaseTokenFactory">
<summary>
A helper class that creates Firebase custom tokens.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Jwt.FirebaseTokenVerifier">
<summary>
A helper class that can be used to verify signed Firebase tokens (e.g. ID tokens).
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.Jwt.FirebaseTokenVerifier.VerifySignatureAsync(System.String[],System.String,System.Threading.CancellationToken)">
<summary>
Verifies the integrity of a JWT by validating its signature. The JWT must be specified
as an array of three segments (header, body and signature).
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Jwt.FixedAccountIAMSigner">
<summary>
An <see cref="T:FirebaseAdmin.Auth.Jwt.ISigner"/> implementation that uses the IAM service to sign data. Unlike
<see cref="T:FirebaseAdmin.Auth.Jwt.IAMSigner"/> this class does not attempt to auto discover a service account ID.
Insterad it must be initialized with a fixed service account ID string.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Jwt.HttpPublicKeySource">
<summary>
An <see cref="T:FirebaseAdmin.Auth.Jwt.IPublicKeySource"/> implementation that retrieves public keys from a remote
HTTP server. Retrieved keys are cached in memory according to the HTTP cache-control
directive.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Jwt.IAMSigner">
<summary>
An <see cref="T:FirebaseAdmin.Auth.Jwt.ISigner"/> implementation that uses the
<a href="https://cloud.google.com/iam/docs/reference/credentials/rest/v1/projects.serviceAccounts/signBlob">
IAMCredentials service</a> to sign data. The IAMCredentials
service must be called with a service account ID, and this class attempts to auto
discover a service account ID by contacting the local metadata service present in
Google-managed runtimes.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Jwt.IAMSigner.SignBlobRequest">
<summary>
Represents the sign request sent to the remote IAM service.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Jwt.IAMSigner.SignBlobResponse">
<summary>
Represents the sign response sent by the remote IAM service.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Jwt.IPublicKeySource">
<summary>
An object that can be used to retrieve a set of RSA public keys for verifying signatures.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.Jwt.IPublicKeySource.GetPublicKeysAsync(System.Threading.CancellationToken)">
<summary>
Returns a set of public keys.
</summary>
<returns>A task that completes with a list of public keys.</returns>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
</member>
<member name="T:FirebaseAdmin.Auth.Jwt.ISigner">
<summary>
Represents an object can be used to cryptographically sign data. Mainly used for signing
custom JWT tokens issued to Firebase users.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Jwt.ISigner.Algorithm">
<summary>
Gets the name of the algorithm used to sign data.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.Jwt.ISigner.GetKeyIdAsync(System.Threading.CancellationToken)">
<summary>
Returns the ID (client email) of the service account used to sign payloads.
</summary>
<returns>A task that completes with the key ID string.</returns>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
</member>
<member name="M:FirebaseAdmin.Auth.Jwt.ISigner.SignDataAsync(System.Byte[],System.Threading.CancellationToken)">
<summary>
Signs the given data payload.
</summary>
<returns>A task that completes with the crypto signature.</returns>
<param name="data">A byte array of data to be signed.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
</member>
<member name="T:FirebaseAdmin.Auth.Jwt.JwtUtils">
<summary>
A collection of utilities for encoding and decoding JWTs.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.Jwt.JwtUtils.Decode``1(System.String)">
<summary>
Decodes a single JWT segment, and deserializes it into a value of type
<typeparamref name="T"/>.
</summary>
<typeparam name="T">The type of the decoded result.</typeparam>
<returns>Decoded JWT segment as a value of type <typeparamref name="T"/>.</returns>
<param name="value">JWT segment to be decoded.</param>
</member>
<member name="T:FirebaseAdmin.Auth.Jwt.PublicKey">
<summary>
Represents an RSA public key, which can be used to verify signatures.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Jwt.PublicKey.Id">
<summary>
Gets the unique identifier of this key.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Jwt.PublicKey.RSA">
<summary>
Gets the <see cref="T:System.Security.Cryptography.RSA"/> instance containing the contents of
the public key.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Jwt.ServiceAccountSigner">
<summary>
An <see cref="T:FirebaseAdmin.Auth.Jwt.ISigner"/> implementation that uses service account credentials to sign
data. Uses the private key present in the credential to produce signatures.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.ListUsersOptions">
<summary>
Options for the <see cref="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.ListUsersAsync(FirebaseAdmin.Auth.ListUsersOptions)"/> API.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.ListUsersOptions.PageSize">
<summary>
Gets or sets the number of results to fetch in a single API call. This does not affect
the total number of results returned. Must not exceed 1000.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.ListUsersOptions.PageToken">
<summary>
Gets or sets the page token. If set, this token is used to indicate a continued list
operation.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Multitenancy.ListTenantsOptions">
<summary>
Options for listing tenants.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Multitenancy.ListTenantsOptions.PageSize">
<summary>
Gets or sets the number of results to fetch in a single API call. This does not affect
the total number of results returned. Must not exceed 100.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Multitenancy.ListTenantsOptions.PageToken">
<summary>
Gets or sets the page token. If set, this token is used to indicate a continued list
operation.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Multitenancy.Tenant">
<summary>
Represents a tenant in a multi-tenant application..
<para>Multitenancy support requires Google Cloud Identity Platform (GCIP). To learn more
about GCIP, including pricing and features, see the
<a href="https://cloud.google.com/identity-platform">GCIP documentation</a>.</para>
<para>Before multitenancy can be used in a Google Cloud Identity Platform project, tenants
must be allowed on that project via the Cloud Console UI.</para>
<para>A tenant configuration provides information such as the display name, tenant
identifier and email authentication configuration. For OIDC/SAML provider configuration
management, TenantAwareFirebaseAuth instances should be used instead of a Tenant to
retrieve the list of configured IdPs on a tenant. When configuring these providers, note
that tenants will inherit whitelisted domains and authenticated redirect URIs of their
parent project.</para>
<para>All other settings of a tenant will also be inherited. These will need to be managed
from the Cloud Console UI.</para>
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Multitenancy.Tenant.TenantId">
<summary>
Gets the tenant identifier.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Multitenancy.Tenant.DisplayName">
<summary>
Gets the tenant display name.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Multitenancy.Tenant.PasswordSignUpAllowed">
<summary>
Gets a value indicating whether the email sign-in provider is enabled.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Multitenancy.Tenant.EmailLinkSignInEnabled">
<summary>
Gets a value indicating whether the email link sign-in is enabled.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Multitenancy.TenantArgs">
<summary>
Arguments for creating and updating tenants.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Multitenancy.TenantArgs.DisplayName">
<summary>
Gets or sets the tenant display name.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Multitenancy.TenantArgs.PasswordSignUpAllowed">
<summary>
Gets or sets a value indicating whether the email sign-in provider is enabled.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Multitenancy.TenantArgs.EmailLinkSignInEnabled">
<summary>
Gets or sets a value indicating whether the email link sign-in is enabled.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Multitenancy.TenantAwareFirebaseAuth">
<summary>
The tenant-aware Firebase client. This can be used to perform a variety of
authentication-related operations, scoped to a particular tenant.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Multitenancy.TenantAwareFirebaseAuth.TenantId">
<summary>
Gets the tenant ID associated with this instance.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Multitenancy.TenantManager">
<summary>
The tenant manager facilitates GCIP multitenancy related operations. This includes:
<list type="bullet">
<item>
<description>Creating, updating, retrieving and deleting tenants in the underlying
project.</description>
</item>
<item>
<description>Obtaining TenantAwareFirebaseAuth instances for performing operations (user
management, provider configuration management, token verification, email link generation,
etc) in the context of a specified tenant.</description>
</item>
</list>
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.Multitenancy.TenantManager.GetTenantAsync(System.String)">
<summary>
Gets the <see cref="T:FirebaseAdmin.Auth.Multitenancy.Tenant"/> corresponding to the given <paramref name="tenantId"/>.
</summary>
<param name="tenantId">A tenant identifier string.</param>
<returns>A task that completes with a <see cref="T:FirebaseAdmin.Auth.Multitenancy.Tenant"/>.</returns>
<exception cref="T:System.ArgumentException">If tenant ID argument is null or empty.</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If a tenant cannot be found with the specified
ID.</exception>
</member>
<member name="M:FirebaseAdmin.Auth.Multitenancy.TenantManager.GetTenantAsync(System.String,System.Threading.CancellationToken)">
<summary>
Gets the <see cref="T:FirebaseAdmin.Auth.Multitenancy.Tenant"/> corresponding to the given <paramref name="tenantId"/>.
</summary>
<param name="tenantId">A tenant identifier string.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
<returns>A task that completes with a <see cref="T:FirebaseAdmin.Auth.Multitenancy.Tenant"/>.</returns>
<exception cref="T:System.ArgumentException">If the tenant ID argument is null or empty.
</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If a tenant cannot be found with the specified
ID.</exception>
</member>
<member name="M:FirebaseAdmin.Auth.Multitenancy.TenantManager.CreateTenantAsync(FirebaseAdmin.Auth.Multitenancy.TenantArgs)">
<summary>
Creates a new tenant.
</summary>
<param name="args">Arguments that describe the new tenant configuration.</param>
<returns>A task that completes with a <see cref="T:FirebaseAdmin.Auth.Multitenancy.Tenant"/>.</returns>
<exception cref="T:System.ArgumentNullException">If <paramref name="args"/> is null.
</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If an unexpected error occurs while creating
the tenant.</exception>
</member>
<member name="M:FirebaseAdmin.Auth.Multitenancy.TenantManager.CreateTenantAsync(FirebaseAdmin.Auth.Multitenancy.TenantArgs,System.Threading.CancellationToken)">
<summary>
Creates a new tenant.
</summary>
<param name="args">Arguments that describe the new tenant configuration.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
<returns>A task that completes with a <see cref="T:FirebaseAdmin.Auth.Multitenancy.Tenant"/>.</returns>
<exception cref="T:System.ArgumentNullException">If <paramref name="args"/> is null.
</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If an unexpected error occurs while creating
the tenant.</exception>
</member>
<member name="M:FirebaseAdmin.Auth.Multitenancy.TenantManager.UpdateTenantAsync(System.String,FirebaseAdmin.Auth.Multitenancy.TenantArgs)">
<summary>
Updates an existing tenant.
</summary>
<param name="tenantId">ID of the tenant to be updated.</param>
<param name="args">Properties to be updated in the tenant.</param>
<returns>A task that completes with a <see cref="T:FirebaseAdmin.Auth.Multitenancy.Tenant"/>.</returns>
<exception cref="T:System.ArgumentException">If <paramref name="tenantId"/> is null or empty,
or if <paramref name="args"/> does not contain any values.
</exception>
<exception cref="T:System.ArgumentNullException">If <paramref name="args"/> is null.
</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If an unexpected error occurs while updating
the tenant.</exception>
</member>
<member name="M:FirebaseAdmin.Auth.Multitenancy.TenantManager.UpdateTenantAsync(System.String,FirebaseAdmin.Auth.Multitenancy.TenantArgs,System.Threading.CancellationToken)">
<summary>
Updates an existing tenant.
</summary>
<param name="tenantId">ID of the tenant to be updated.</param>
<param name="args">Properties to be updated in the tenant.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
<returns>A task that completes with a <see cref="T:FirebaseAdmin.Auth.Multitenancy.Tenant"/>.</returns>
<exception cref="T:System.ArgumentException">If <paramref name="tenantId"/> is null or empty,
or if <paramref name="args"/> does not contain any values.
</exception>
<exception cref="T:System.ArgumentNullException">If <paramref name="args"/> is null.
</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If an unexpected error occurs while updating
the tenant.</exception>
</member>
<member name="M:FirebaseAdmin.Auth.Multitenancy.TenantManager.DeleteTenantAsync(System.String)">
<summary>
Deletes the tenant corresponding to the given <paramref name="tenantId"/>.
</summary>
<param name="tenantId">A tenant identifier string.</param>
<returns>A task that completes when the tenant is deleted.</returns>
<exception cref="T:System.ArgumentException">If the tenant ID argument is null or empty.
</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If a tenant cannot be found with the specified
ID.</exception>
</member>
<member name="M:FirebaseAdmin.Auth.Multitenancy.TenantManager.DeleteTenantAsync(System.String,System.Threading.CancellationToken)">
<summary>
Deletes the tenant corresponding to the given <paramref name="tenantId"/>.
</summary>
<param name="tenantId">A tenant identifier string.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
<returns>A task that completes when the tenant is deleted.</returns>
<exception cref="T:System.ArgumentException">If the tenant ID argument is null or empty.
</exception>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If a tenant cannot be found with the specified
ID.</exception>
</member>
<member name="M:FirebaseAdmin.Auth.Multitenancy.TenantManager.ListTenantsAsync(FirebaseAdmin.Auth.Multitenancy.ListTenantsOptions)">
<summary>
Gets an async enumerable to iterate or page through tenants
starting from the specified page token. If the page token is null or unspecified,
iteration starts from the first page. See
<a href="https://googleapis.github.io/google-cloud-dotnet/docs/guides/page-streaming.html">
Page Streaming</a> for more details on how to use this API.
</summary>
<param name="options">The options to control the starting point and page size. Pass
null to list from the beginning with default settings.</param>
<returns>A <see cref="T:Google.Api.Gax.PagedAsyncEnumerable`2"/>
instance.</returns>
</member>
<member name="M:FirebaseAdmin.Auth.Multitenancy.TenantManager.AuthForTenant(System.String)">
<summary>
Gets a <see cref="T:FirebaseAdmin.Auth.Multitenancy.TenantAwareFirebaseAuth"/> instance scoped to the specified tenant.
</summary>
<param name="tenantId">A tenant identifier string.</param>
<returns>An object that can be used to perform tenant-aware operations.</returns>
<exception cref="T:System.ArgumentException">If the tenant ID argument is null or empty.
</exception>
</member>
<member name="M:FirebaseAdmin.Auth.Multitenancy.TenantManager.System#IDisposable#Dispose">
<summary>
Cleans up and invalidates this instance. For internal use only.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Multitenancy.TenantsPage">
<summary>
Contains a collection of tenants.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Multitenancy.TenantsPage.NextPageToken">
<summary>
Gets the token representing the next page of tenants. Null if there are no more pages.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Multitenancy.TenantsPage.Tenants">
<summary>
Gets the tenants included in the current page.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.PhoneIdentifier">
<summary>
Used for looking up an account by phone number.
See <see cref="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.GetUsersAsync(System.Collections.Generic.IReadOnlyCollection{FirebaseAdmin.Auth.UserIdentifier})"/>.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.PhoneIdentifier.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:FirebaseAdmin.Auth.PhoneIdentifier"/> class.
</summary>
<param name="phoneNumber">The phoneNumber.</param>
</member>
<member name="M:FirebaseAdmin.Auth.PhoneIdentifier.ToString">
<inheritdoc/>
</member>
<member name="T:FirebaseAdmin.Auth.ProviderIdentifier">
<summary>
Used for looking up an account by provider.
See <see cref="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.GetUsersAsync(System.Collections.Generic.IReadOnlyCollection{FirebaseAdmin.Auth.UserIdentifier})"/>.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.ProviderIdentifier.#ctor(System.String,System.String)">
<summary>
Initializes a new instance of the <see cref="T:FirebaseAdmin.Auth.ProviderIdentifier"/> class.
</summary>
<param name="providerId">The providerId.</param>
<param name="providerUid">The providerUid.</param>
</member>
<member name="M:FirebaseAdmin.Auth.ProviderIdentifier.ToString">
<inheritdoc/>
</member>
<member name="T:FirebaseAdmin.Auth.Providers.ApiClient">
<summary>
Provides low-level methods for interacting with the
<a href="https://developers.google.com/identity/toolkit/web/reference/relyingparty">
Google Identity Toolkit v2 REST API</a>. Implemented as a simple wrapper of the
<see cref="T:FirebaseAdmin.Util.ErrorHandlingHttpClient`1"/> class. This class has state that must be disposed
after use.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Providers.AuthProviderConfig">
<summary>
The base Auth provider configuration interface.
<para>
Auth provider configuration support requires Google Cloud's Identity Platform (GCIP). To
learn more about GCIP, including pricing and features, see the
<a href="https://cloud.google.com/identity-platform">GCIP documentation</a>.
</para>
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Providers.AuthProviderConfig.ProviderId">
<summary>
Gets the provider ID defined by the developer. For an OIDC provider, this is always
prefixed by <c>oidc.</c>. For a SAML provider, this is always prefixed by <c>saml.</c>.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Providers.AuthProviderConfig.DisplayName">
<summary>
Gets the user-friendly display name of the configuration. This name is also used
as the provider label in the Cloud Console.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Providers.AuthProviderConfig.Enabled">
<summary>
Gets a value indicating whether the provider configuration is enabled or disabled. A
user cannot sign in using a disabled provider.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Providers.AuthProviderConfigArgs`1">
<summary>
The base auth provider configuration interface.
<para>
Auth provider configuration support requires Google Cloud's Identity Platform (GCIP). To
learn more about GCIP, including pricing and features, see the
<a href="https://cloud.google.com/identity-platform">GCIP documentation</a>.
</para>
</summary>
<typeparam name="T">Type of <see cref="T:FirebaseAdmin.Auth.Providers.AuthProviderConfig"/> that can be created or
updated using this argument type.</typeparam>
</member>
<member name="P:FirebaseAdmin.Auth.Providers.AuthProviderConfigArgs`1.ProviderId">
<summary>
Gets or sets the provider ID defined by the developer. For an OIDC provider, this is
always prefixed by <c>oidc.</c>. For a SAML provider, this is always prefixed by
<c>saml.</c>.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Providers.AuthProviderConfigArgs`1.DisplayName">
<summary>
Gets or sets the user-friendly display name of the configuration. This name is
also used as the provider label in the Cloud Console.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Providers.AuthProviderConfigArgs`1.Enabled">
<summary>
Gets or sets a value indicating whether the provider configuration is enabled or
disabled. A user cannot sign in using a disabled provider.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Providers.AuthProviderConfigs`1">
<summary>
A page of auth provider configurations.
</summary>
<typeparam name="T">Type of <see cref="T:FirebaseAdmin.Auth.Providers.AuthProviderConfig"/> that is included.</typeparam>
</member>
<member name="P:FirebaseAdmin.Auth.Providers.AuthProviderConfigs`1.NextPageToken">
<summary>
Gets the token representing the next page of auth provider configurations. Null if
there are no more pages.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Providers.AuthProviderConfigs`1.ProviderConfigs">
<summary>
Gets the auth provider configurations included in the current page.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Providers.ListProviderConfigsOptions">
<summary>
Options for listing auth provider configurations.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Providers.ListProviderConfigsOptions.PageSize">
<summary>
Gets or sets the number of results to fetch in a single API call. This does not affect
the total number of results returned. Must not exceed 100.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Providers.ListProviderConfigsOptions.PageToken">
<summary>
Gets or sets the page token. If set, this token is used to indicate a continued list
operation.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Providers.OidcProviderConfig">
<summary>
Represents an OIDC auth provider configuration. See
<a href="https://openid.net/specs/openid-connect-core-1_0-final.html">OpenID Connect</a>.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Providers.OidcProviderConfig.ClientId">
<summary>
Gets the client ID used to confirm the audience of an OIDC provider's ID token.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Providers.OidcProviderConfig.Issuer">
<summary>
Gets the issuer used to match the issuer of the ID token and to determine the
corresponding OIDC discovery document, eg. <c>/.well-known/openid-configuration</c>.
This is needed for the following:
<list type="bullet">
<item>
<description>To verify the provided issuer.</description>
</item>
<item>
<description>To determine the authentication/authorization endpoint during the OAuth
<c>id_token</c> authentication flow.</description>
</item>
<item>
<description>To retrieve the public signing keys from <c>jwks_uri</c>, which is used
to verify the signature of the ID token.</description>
</item>
<item>
<description>To determine the <c>claims_supported</c>, which are passed through in
the additional user info response.</description>
</item>
</list>
<para>
ID token validation is performed as defined in
<a href="https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation">
OpenID Connect</a>.
</para>
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Providers.OidcProviderConfigArgs">
<summary>
Represents an OIDC auth provider configuration. See
<a href="https://openid.net/specs/openid-connect-core-1_0-final.html">OpenID Connect</a>.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Providers.OidcProviderConfigArgs.ClientId">
<summary>
Gets or sets the client ID used to confirm the audience of an OIDC provider's ID token.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Providers.OidcProviderConfigArgs.Issuer">
<summary>
Gets or sets the issuer used to match the issuer of the ID token and to determine the
corresponding OIDC discovery document, eg. <c>/.well-known/openid-configuration</c>.
This is needed for the following:
<list type="bullet">
<item>
<description>To verify the provided issuer.</description>
</item>
<item>
<description>To determine the authentication/authorization endpoint during the OAuth
<c>id_token</c> authentication flow.</description>
</item>
<item>
<description>To retrieve the public signing keys from <c>jwks_uri</c>, which is used
to verify the signature of the ID token.</description>
</item>
<item>
<description>To determine the <c>claims_supported</c>, which are passed through in
the additional user info response.</description>
</item>
</list>
<para>
ID token validation is performed as defined in
<a href="https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation">
OpenID Connect</a>.
</para>
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Providers.OidcProviderConfigClient.ListResponse.NextPageToken">
<summary>
Gets or sets the next page link.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Providers.OidcProviderConfigClient.ListResponse.Configs">
<summary>
Gets or sets the users.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Providers.ProviderConfigClient`1">
<summary>
A client that supports managing auth provider configurations by making remote API calls to
the Firebase Auth backend services. This class is stateless, and the HTTP transport
capabilities are provided by the <see cref="T:FirebaseAdmin.Auth.Providers.ApiClient"/>.
</summary>
<typeparam name="T">Type of <see cref="T:FirebaseAdmin.Auth.Providers.AuthProviderConfig"/> that can be managed using this
client.</typeparam>
</member>
<member name="T:FirebaseAdmin.Auth.Providers.ProviderConfigClient`1.AbstractListRequest">
<summary>
A class for making batch GET requests to list a specific type of auth provider
configuration. An instance of this class is used by the Google API client to provide
pagination support.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Providers.ProviderConfigClient`1.PageManager">
<summary>
A Google API client utility for paging through a sequence of provider configurations.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Providers.ProviderConfigManager">
<summary>
The facade for managing auth provider configurations in a Firebase project. It is used by
other high-level classes like <see cref="T:FirebaseAdmin.Auth.FirebaseAuth"/>. Remote API calls are delegated
to the appropriate <see cref="T:FirebaseAdmin.Auth.Providers.ProviderConfigClient`1"/> implementations, with
<see cref="T:FirebaseAdmin.Auth.Providers.ApiClient"/> providing the necessary HTTP primitives.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Providers.SamlProviderConfig">
<summary>
Represents a SAML auth provider configuration. See
<a href="http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html">
SAML technical overview</a>.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Providers.SamlProviderConfig.IdpEntityId">
<summary>
Gets the SAML IdP entity identifier.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Providers.SamlProviderConfig.SsoUrl">
<summary>
Gets the SAML IdP SSO URL.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Providers.SamlProviderConfig.X509Certificates">
<summary>
Gets the collection of SAML IdP X.509 certificates issued by CA for this provider.
Multiple certificates are accepted to prevent outages during IdP key rotation (for
example ADFS rotates every 10 days). When the Auth server receives a SAML response,
it will match the SAML response with the certificate on record. Otherwise the response
is rejected. Developers are expected to manage the certificate updates as keys are
rotated.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Providers.SamlProviderConfig.RpEntityId">
<summary>
Gets the SAML relying party (service provider) entity ID. This is defined by the
developer but needs to be provided to the SAML IdP.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Providers.SamlProviderConfig.CallbackUrl">
<summary>
Gets the SAML callback URL. This is fixed and must always be the same as the OAuth
redirect URL provisioned by Firebase Auth,
<c>https://project-id.firebaseapp.com/__/auth/handler</c> unless a custom
<c>authDomain</c> is used. The callback URL should also be provided to the SAML IdP
during configuration.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Providers.SamlProviderConfigArgs">
<summary>
Represents a SAML auth provider configuration. See
<a href="http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html">
SAML technical overview</a>.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Providers.SamlProviderConfigArgs.IdpEntityId">
<summary>
Gets or sets the SAML IdP entity identifier.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Providers.SamlProviderConfigArgs.SsoUrl">
<summary>
Gets or sets the SAML IdP SSO URL.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Providers.SamlProviderConfigArgs.X509Certificates">
<summary>
Gets or sets the collection of SAML IdP X.509 certificates issued by CA for this
provider. Multiple certificates are accepted to prevent outages during IdP key
rotation (for example ADFS rotates every 10 days). When the Auth server receives a SAML
response, it will match the SAML response with the certificate on record. Otherwise the
response is rejected. Developers are expected to manage the certificate updates as keys
are rotated.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Providers.SamlProviderConfigArgs.RpEntityId">
<summary>
Gets or sets the SAML relying party (service provider) entity ID. This is defined by
the developer but needs to be provided to the SAML IdP.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Providers.SamlProviderConfigArgs.CallbackUrl">
<summary>
Gets or sets the SAML callback URL. This is fixed and must always be the same as the
OAuth redirect URL provisioned by Firebase Auth,
<c>https://project-id.firebaseapp.com/__/auth/handler</c> unless a custom
<c>authDomain</c> is used. The callback URL should also be provided to the SAML IdP
during configuration.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Providers.SamlProviderConfigClient.ListResponse.NextPageToken">
<summary>
Gets or sets the next page link.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Providers.SamlProviderConfigClient.ListResponse.Configs">
<summary>
Gets or sets the users.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.ProviderUserInfo">
<summary>
Contains metadata regarding how a user is known by a particular identity provider (IdP).
Instances of this class are immutable and thread safe.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.ProviderUserInfo.#ctor(FirebaseAdmin.Auth.Users.GetAccountInfoResponse.Provider)">
<summary>
Initializes a new instance of the <see cref="T:FirebaseAdmin.Auth.ProviderUserInfo"/> class with data provided by an authentication provider.
</summary>
<param name="provider">The deserialized JSON user data from the provider.</param>
</member>
<member name="P:FirebaseAdmin.Auth.ProviderUserInfo.Uid">
<summary>
Gets the user's unique ID assigned by the identity provider.
</summary>
<returns>a user ID string.</returns>
</member>
<member name="P:FirebaseAdmin.Auth.ProviderUserInfo.DisplayName">
<summary>
Gets the user's display name, if available.
</summary>
<returns>a display name string or null.</returns>
</member>
<member name="P:FirebaseAdmin.Auth.ProviderUserInfo.Email">
<summary>
Gets the user's email address, if available.
</summary>
<returns>an email address string or null.</returns>
</member>
<member name="P:FirebaseAdmin.Auth.ProviderUserInfo.PhoneNumber">
<summary>
Gets the user's phone number.
</summary>
<returns>a phone number string or null.</returns>
</member>
<member name="P:FirebaseAdmin.Auth.ProviderUserInfo.PhotoUrl">
<summary>
Gets the user's photo URL, if available.
</summary>
<returns>a URL string or null.</returns>
</member>
<member name="P:FirebaseAdmin.Auth.ProviderUserInfo.ProviderId">
<summary>
Gets the ID of the identity provider. This can be a short domain name (e.g. google.com) or
the identifier of an OpenID identity provider.
</summary>
<returns>an ID string that uniquely identifies the identity provider.</returns>
</member>
<member name="T:FirebaseAdmin.Auth.SessionCookieOptions">
<summary>
Options for the
<see cref="M:FirebaseAdmin.Auth.FirebaseAuth.CreateSessionCookieAsync(System.String,FirebaseAdmin.Auth.SessionCookieOptions)"/>
API.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.SessionCookieOptions.ExpiresIn">
<summary>
Gets or sets the duration until the cookie is expired. Must be between 5 minutes
and 14 days. The backend service uses seconds precision for this parameter.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.UidIdentifier">
<summary>
Used for looking up an account by uid.
See <see cref="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.GetUsersAsync(System.Collections.Generic.IReadOnlyCollection{FirebaseAdmin.Auth.UserIdentifier})"/>.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.UidIdentifier.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:FirebaseAdmin.Auth.UidIdentifier"/> class.
</summary>
<param name="uid">The uid.</param>
</member>
<member name="M:FirebaseAdmin.Auth.UidIdentifier.ToString">
<inheritdoc/>
</member>
<member name="T:FirebaseAdmin.Auth.UserIdentifier">
<summary>
Identifies a user to be looked up.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.UserImportHash">
<summary>
Represents a hash algorithm and the related configuration parameters used to hash user
passwords. An instance of this class must be specified if importing any users with password
hashes (see <a cref="T:FirebaseAdmin.Auth.UserImportOptions">UserImportOptions</a>).
</summary>
<remarks>
This is not expected to be extended in user code. Applications should use one of the provided
concrete implementations in the <a cref="N:FirebaseAdmin.Auth.Hash">namespace</a>. See
<a href="https://firebase.google.com/docs/auth/admin/import-users">documentation</a> for more
details on available options.
</remarks>
</member>
<member name="M:FirebaseAdmin.Auth.UserImportHash.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:FirebaseAdmin.Auth.UserImportHash"/> class.
</summary>
<param name="hashName">The name of the hashing algorithm.</param>
</member>
<member name="M:FirebaseAdmin.Auth.UserImportHash.GetProperties">
<summary>
Retrieves the properties of the chosen hashing algorithm.
</summary>
<returns>Dictionary containing the specified properties of the hashing algorithm.</returns>
</member>
<member name="M:FirebaseAdmin.Auth.UserImportHash.GetHashConfiguration">
<summary>
Retrieves dictionary with the specified properties of the hashing algorithm.
</summary>
<returns>Dictionary containing the specified properties of the hashing algorithm.</returns>
</member>
<member name="T:FirebaseAdmin.Auth.UserImportOptions">
<summary>
A collection of options that can be passed to the
<a cref="o:FirebaseAuth.ImportUsersAsync">FirebaseAuth.ImportUsersAsync</a> API.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.UserImportOptions.Hash">
<summary>
Gets or sets the <a cref="T:FirebaseAdmin.Auth.UserImportHash">UserImportHash</a> object associated with
the UserImportOptions instance.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.UserImportOptions.GetHashProperties">
<summary>
Retrieves properties of the password hashing algorithm.
</summary>
<returns>Dictionary containing key/values for password hashing properties.</returns>
</member>
<member name="T:FirebaseAdmin.Auth.UserImportResult">
<summary>
Represents the result of the
<see cref="M:FirebaseAdmin.Auth.AbstractFirebaseAuth.ImportUsersAsync(System.Collections.Generic.IEnumerable{FirebaseAdmin.Auth.ImportUserRecordArgs})"/> API.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.UserImportResult.#ctor(System.Int32,System.Collections.Generic.IReadOnlyList{FirebaseAdmin.Auth.ErrorInfo})">
<summary>
Initializes a new instance of the <see cref="T:FirebaseAdmin.Auth.UserImportResult"/> class.
</summary>
<param name="users">The number of users that was included in the input import
request.</param>
<param name="errors">Any errors encountered while importing users. Possibly
null.</param>
</member>
<member name="P:FirebaseAdmin.Auth.UserImportResult.Errors">
<summary>
Gets errors associated with a user import. Empty list if there were no errors.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.UserImportResult.SuccessCount">
<summary>
Gets the number of users that were imported successfully.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.UserImportResult.FailureCount">
<summary>
Gets the number of users that failed to be imported.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.UserMetadata">
<summary>
Contains additional metadata associated with a user account.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.UserMetadata.#ctor(System.Int64,System.Int64,System.Nullable{System.DateTime})">
<summary>
Initializes a new instance of the <see cref="T:FirebaseAdmin.Auth.UserMetadata"/> class with the specified creation and last sign-in timestamps.
</summary>
<param name="creationTimestamp">A timestamp representing the date and time that the user account was created.</param>
<param name="lastSignInTimestamp">A timestamp representing the date and time that the user account was last signed-on to.</param>
<param name="lastRefreshTimestamp">A timestamp representing the date and time that the user account was last refreshed.</param>
</member>
<member name="P:FirebaseAdmin.Auth.UserMetadata.CreationTimestamp">
<summary>
Gets a timestamp representing the date and time that the account was created.
If not available this property is <c>null</c>.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.UserMetadata.LastSignInTimestamp">
<summary>
Gets a timestamp representing the last time that the user has signed in. If the user
has never signed in this property is <c>null</c>.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.UserMetadata.LastRefreshTimestamp">
<summary>
Gets the time at which the user was last active (ID token refreshed), or <c>null</c>
if the user was never active.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.UserProvider">
<summary>
Represents a user identity provider that can be associated with a Firebase user.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.UserProvider.Uid">
<summary>
Gets or sets the user's unique ID assigned by the identity provider. This field is required.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.UserProvider.DisplayName">
<summary>
Gets or sets the user's display name.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.UserProvider.Email">
<summary>
Gets or sets the user's email address.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.UserProvider.PhotoUrl">
<summary>
Gets or sets the photo URL of the user.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.UserProvider.ProviderId">
<summary>
Gets or sets the ID of the identity provider. This can be a short domain name
(e.g. google.com) or the identifier of an OpenID identity provider. This field
is required.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.UserProvider.ToRequest">
<summary>
Creates the serialized request object containing all the properties of UserProvider
and performs validation.
</summary>
<returns>Serializable and validated object containing UserProvier properties.</returns>
</member>
<member name="T:FirebaseAdmin.Auth.UserRecord">
<summary>
Contains metadata associated with a Firebase user account. Instances
of this class are immutable and thread safe.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.UserRecord.#ctor(FirebaseAdmin.Auth.Users.GetAccountInfoResponse.User)">
<summary>
Initializes a new instance of the <see cref="T:FirebaseAdmin.Auth.UserRecord"/> class from an existing
instance of the <see cref="T:FirebaseAdmin.Auth.Users.GetAccountInfoResponse.User"/> class.
</summary>
<param name="user">The <see cref="T:FirebaseAdmin.Auth.Users.GetAccountInfoResponse.User"/> instance to copy
the user's data from.</param>
</member>
<member name="P:FirebaseAdmin.Auth.UserRecord.Uid">
<summary>
Gets the user ID of this user.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.UserRecord.DisplayName">
<summary>
Gets the user's display name, if available. Otherwise null.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.UserRecord.Email">
<summary>
Gets the user's email address, if available. Otherwise null.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.UserRecord.PhoneNumber">
<summary>
Gets the user's phone number, if available. Otherwise null.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.UserRecord.PhotoUrl">
<summary>
Gets the user's photo URL, if available. Otherwise null.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.UserRecord.ProviderId">
<summary>
Gets the ID of the identity provider. This returns the constant value <c>firebase</c>.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.UserRecord.EmailVerified">
<summary>
Gets a value indicating whether the user's email address is verified or not.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.UserRecord.Disabled">
<summary>
Gets a value indicating whether the user account is disabled or not.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.UserRecord.ProviderData">
<summary>
Gets a non-null array of provider data for this user. Possibly empty.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.UserRecord.TokensValidAfterTimestamp">
<summary>
Gets a timestamp that indicates the earliest point in time at which a valid ID token
could have been issued to this user. Tokens issued prior to this timestamp are
considered invalid.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.UserRecord.UserMetaData">
<summary>
Gets additional user metadata. This is guaranteed not to be null.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.UserRecord.CustomClaims">
<summary>
Gets the custom claims set on this user, as a non-null dictionary. Possibly empty.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.UserRecord.TenantId">
<summary>
Gets the user's tenant ID, if available. Otherwise null.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.UserRecordArgs">
<summary>
A specification for creating or updating user accounts.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.UserRecordArgs.Uid">
<summary>
Gets or sets the user ID of the account.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.UserRecordArgs.Email">
<summary>
Gets or sets the email address of the user.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.UserRecordArgs.PhoneNumber">
<summary>
Gets or sets the phone number of the user.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.UserRecordArgs.DisplayName">
<summary>
Gets or sets the display name of the user account.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.UserRecordArgs.EmailVerified">
<summary>
Gets or sets a value indicating whether the user email address has been verified or not.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.UserRecordArgs.PhotoUrl">
<summary>
Gets or sets the photo URL of the user.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.UserRecordArgs.Disabled">
<summary>
Gets or sets a value indicating whether the user account should be disabled by default or not.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.UserRecordArgs.Password">
<summary>
Gets or sets the password of the user.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.UserRecordArgs.Optional`1">
<summary>
Wraps a nullable value. Used to differentiate between parameters that have not been set, and
the parameters that have been explicitly set to null.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Users.BatchDeleteResponse">
<summary>
JSON data binding for `BatchDeleteResponse` messages sent by Google Identity Toolkit
service.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Users.BatchDeleteResponse.Errors">
<summary>
Gets or sets a list of errors.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Users.DownloadAccountResponse">
<summary>
JSON data binding for downloadAccountResponse messages sent by Google identity toolkit service.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Users.DownloadAccountResponse.NextPageToken">
<summary>
Gets or sets the next page link.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Users.DownloadAccountResponse.Users">
<summary>
Gets or sets the users.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Users.FirebaseUserManager">
<summary>
FirebaseUserManager provides methods for interacting with the
<a href="https://developers.google.com/identity/toolkit/web/reference/relyingparty">
Google Identity Toolkit</a> via its REST API. This class does not hold any mutable state,
and is thread safe.
</summary>
</member>
<member name="F:FirebaseAdmin.Auth.Users.FirebaseUserManager.MaxGetAccountsBatchSize">
Maximum allowed number of users to batch get at one time.
</member>
<member name="F:FirebaseAdmin.Auth.Users.FirebaseUserManager.MaxDeleteAccountsBatchSize">
Maximum allowed number of users to batch delete at one time.
</member>
<member name="M:FirebaseAdmin.Auth.Users.FirebaseUserManager.GetUserByIdAsync(System.String,System.Threading.CancellationToken)">
<summary>
Gets the user data corresponding to the given user ID.
</summary>
<param name="uid">A user ID string.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
<returns>A record of user with the queried id if one exists.</returns>
</member>
<member name="M:FirebaseAdmin.Auth.Users.FirebaseUserManager.GetUserByEmailAsync(System.String,System.Threading.CancellationToken)">
<summary>
Gets the user data corresponding to the given email address.
</summary>
<param name="email">An email address.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
<returns>A record of user with the queried email if one exists.</returns>
</member>
<member name="M:FirebaseAdmin.Auth.Users.FirebaseUserManager.GetUserByPhoneNumberAsync(System.String,System.Threading.CancellationToken)">
<summary>
Gets the user data corresponding to the given phone number.
</summary>
<param name="phoneNumber">A phone number.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
<returns>A record of user with the queried phone number if one exists.</returns>
</member>
<member name="M:FirebaseAdmin.Auth.Users.FirebaseUserManager.CreateUserAsync(FirebaseAdmin.Auth.UserRecordArgs,System.Threading.CancellationToken)">
<summary>
Create a new user account.
</summary>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If an error occurs while creating the user
account.</exception>
<param name="args">The data to create the user account with.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
<returns>The unique uid assigned to the newly created user account.</returns>
</member>
<member name="M:FirebaseAdmin.Auth.Users.FirebaseUserManager.UpdateUserAsync(FirebaseAdmin.Auth.UserRecordArgs,System.Threading.CancellationToken)">
<summary>
Update an existing user.
</summary>
<exception cref="T:FirebaseAdmin.Auth.FirebaseAuthException">If the server responds that cannot update the
user.</exception>
<param name="args">The user account data to be updated.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
</member>
<member name="M:FirebaseAdmin.Auth.Users.FirebaseUserManager.DeleteUserAsync(System.String,System.Threading.CancellationToken)">
<summary>
Delete user data corresponding to the given user ID.
</summary>
<param name="uid">A user ID string.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
</member>
<member name="T:FirebaseAdmin.Auth.Users.FirebaseUserManager.UploadAccountResponse">
<summary>
Represents the response from identity toolkit for a user import request.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Users.FirebaseUserManager.UserQuery">
<summary>
Represents a query that can be executed against the Firebase Auth service to retrieve user records.
A query mainly consists of a <see cref="P:FirebaseAdmin.Auth.Users.FirebaseUserManager.UserQuery.Field"/> and a <see cref="P:FirebaseAdmin.Auth.Users.FirebaseUserManager.UserQuery.Value"/> (e.g.
<c>Field = localId</c> and <c>Value = alice</c>). Additionally, a query may also specify a more
human-readable <see cref="P:FirebaseAdmin.Auth.Users.FirebaseUserManager.UserQuery.Label"/> for the field, which will appear on any error messages
produced by the query.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Users.GetAccountInfoRequest">
<summary>
Represents a request to look up account information.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Users.GetAccountInfoResponse">
<summary>
JSON data binding for GetAccountInfoResponse messages sent by Google identity toolkit service.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Users.GetAccountInfoResponse.Kind">
<summary>
Gets or sets a string representing what kind of account is represented by this object.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Users.GetAccountInfoResponse.Users">
<summary>
Gets or sets a list of provider users linked to this account.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Users.GetAccountInfoResponse.User">
<summary>
JSON data binding for user records.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Users.GetAccountInfoResponse.User.UserId">
<summary>
Gets or sets the user's ID.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Users.GetAccountInfoResponse.User.Email">
<summary>
Gets or sets the user's email address.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Users.GetAccountInfoResponse.User.PasswordHash">
<summary>
Gets or sets the user's password hash.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Users.GetAccountInfoResponse.User.PasswordSalt">
<summary>
Gets or sets the user's password salt.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Users.GetAccountInfoResponse.User.PhoneNumber">
<summary>
Gets or sets the user's phone number.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Users.GetAccountInfoResponse.User.EmailVerified">
<summary>
Gets or sets a value indicating whether the user's email address is verified or not.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Users.GetAccountInfoResponse.User.DisplayName">
<summary>
Gets or sets the user's display name.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Users.GetAccountInfoResponse.User.PhotoUrl">
<summary>
Gets or sets the URL for the user's photo.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Users.GetAccountInfoResponse.User.Disabled">
<summary>
Gets or sets a value indicating whether the user is disabled or not.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Users.GetAccountInfoResponse.User.Providers">
<summary>
Gets or sets a list of provider-specified data for this user.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Users.GetAccountInfoResponse.User.CreatedAt">
<summary>
Gets or sets the timestamp representing the time that the user account was created.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Users.GetAccountInfoResponse.User.LastLoginAt">
<summary>
Gets or sets the timestamp representing the last time that the user has logged in.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Users.GetAccountInfoResponse.User.LastRefreshAt">
<summary>
Gets or sets the timestamp representing the last refresh time.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Users.GetAccountInfoResponse.User.ValidSince">
<summary>
Gets or sets the timestamp representing the time that the user account was first valid.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Users.GetAccountInfoResponse.User.CustomClaims">
<summary>
Gets or sets the user's custom claims.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Users.GetAccountInfoResponse.User.TenantId">
<summary>
Gets or sets the user's tenant ID.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Users.GetAccountInfoResponse.Provider">
<summary>
JSON data binding for provider data.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Users.GetAccountInfoResponse.Provider.UserId">
<summary>
Gets or sets the user's ID.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Users.GetAccountInfoResponse.Provider.DisplayName">
<summary>
Gets or sets the user's display name.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Users.GetAccountInfoResponse.Provider.Email">
<summary>
Gets or sets the user's email address.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Users.GetAccountInfoResponse.Provider.PhoneNumber">
<summary>
Gets or sets the user's phone number.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Users.GetAccountInfoResponse.Provider.PhotoUrl">
<summary>
Gets or sets the URL for the user's photo.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Users.GetAccountInfoResponse.Provider.ProviderID">
<summary>
Gets or sets the provider's ID.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Users.ListUsersPageManager">
<summary>
Utility for paging through user accounts using the Google API client.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Users.ListUsersRequest">
<summary>
Represents a request made using the Google API client to list all Firebase users in a
project.
</summary>
</member>
<member name="T:FirebaseAdmin.Auth.Users.UserImportRequest">
<summary>
Encapsulates user import requests by specifying hashing properties for passwords and
the list of users to be imported.
</summary>
</member>
<member name="M:FirebaseAdmin.Auth.Users.UserImportRequest.#ctor(System.Collections.Generic.IEnumerable{FirebaseAdmin.Auth.ImportUserRecordArgs},FirebaseAdmin.Auth.UserImportOptions)">
<summary>
Initializes a new instance of the <see cref="T:FirebaseAdmin.Auth.Users.UserImportRequest"/> class by verifying
the supplied user's <c>IEnumerable</c> is valid (non-empty and not greater than
<c>MaxImportUsers</c>), and a valid <see cref="T:FirebaseAdmin.Auth.UserImportHash"/> is supplied when a
password is provided to at least one of the users.
</summary>
<param name="usersToImport">List of users to be imported.</param>
<param name="options">Options for user imports. Possibly null.</param>
</member>
<member name="P:FirebaseAdmin.Auth.Users.UserImportRequest.UserCount">
<summary>
Gets the number of users based on the constructor parameter.
</summary>
</member>
<member name="P:FirebaseAdmin.Auth.Users.UserImportRequest.HashProperties">
<summary>
Gets or sets JSON extension data for putting hashing properties at the root of the
JSON serialized object.
</summary>
</member>
<member name="T:FirebaseAdmin.ErrorCode">
<summary>
Platform-wide error codes that can be raised by Admin SDK APIs.
</summary>
</member>
<member name="F:FirebaseAdmin.ErrorCode.InvalidArgument">
<summary>
Client specified an invalid argument.
</summary>
</member>
<member name="F:FirebaseAdmin.ErrorCode.FailedPrecondition">
<summary>
Request can not be executed in the current system state, such as deleting a non-empty
directory.
</summary>
</member>
<member name="F:FirebaseAdmin.ErrorCode.OutOfRange">
<summary>
Client specified an invalid range.
</summary>
</member>
<member name="F:FirebaseAdmin.ErrorCode.Unauthenticated">
<summary>
Request not authenticated due to missing, invalid, or expired OAuth token.
</summary>
</member>
<member name="F:FirebaseAdmin.ErrorCode.PermissionDenied">
<summary>
Client does not have sufficient permission. This can happen because the OAuth token
does not have the right scopes, the client doesn't have permission, or the API has not
been enabled for the client project.
</summary>
</member>
<member name="F:FirebaseAdmin.ErrorCode.NotFound">
<summary>
A specified resource is not found, or the request is rejected due to undisclosed
reasons, such as whitelisting.
</summary>
</member>
<member name="F:FirebaseAdmin.ErrorCode.Conflict">
<summary>
Concurrency conflict, such as read-modify-write conflict.
</summary>
</member>
<member name="F:FirebaseAdmin.ErrorCode.Aborted">
<summary>
Concurrency conflict, such as read-modify-write conflict.
</summary>
</member>
<member name="F:FirebaseAdmin.ErrorCode.AlreadyExists">
<summary>
The resource that a client tried to create already exists.
</summary>
</member>
<member name="F:FirebaseAdmin.ErrorCode.ResourceExhausted">
<summary>
Either out of resource quota or reaching rate limiting.
</summary>
</member>
<member name="F:FirebaseAdmin.ErrorCode.Cancelled">
<summary>
Request cancelled by the client.
</summary>
</member>
<member name="F:FirebaseAdmin.ErrorCode.DataLoss">
<summary>
Unrecoverable data loss or data corruption.
</summary>
</member>
<member name="F:FirebaseAdmin.ErrorCode.Unknown">
<summary>
Unknown server error.
</summary>
</member>
<member name="F:FirebaseAdmin.ErrorCode.Internal">
<summary>
Internal server error.
</summary>
</member>
<member name="F:FirebaseAdmin.ErrorCode.Unavailable">
<summary>
Service unavailable. Typically the server is down.
</summary>
</member>
<member name="F:FirebaseAdmin.ErrorCode.DeadlineExceeded">
<summary>
Request deadline exceeded. This will happen only if the caller sets a deadline that is
shorter than the method's default deadline (i.e. requested deadline is not enough for
the server to process the request) and the request did not finish within the deadline.
</summary>
</member>
<member name="T:FirebaseAdmin.Extensions">
<summary>
A collection of extension methods for internal use in the SDK.
</summary>
</member>
<member name="M:FirebaseAdmin.Extensions.ToServiceAccountCredential(Google.Apis.Auth.OAuth2.GoogleCredential)">
<summary>
Extracts and returns the underlying <see cref="T:Google.Apis.Auth.OAuth2.ServiceAccountCredential"/> from a
<see cref="T:Google.Apis.Auth.OAuth2.GoogleCredential"/>. Returns null if the <c>GoogleCredential</c> is not
based on a service account.
</summary>
<returns>A service account credential if available, or null.</returns>
<param name="credential">The Google credential from which to extract service account
credentials.</param>
</member>
<member name="M:FirebaseAdmin.Extensions.CreateDefaultHttpClient(Google.Apis.Http.HttpClientFactory)">
<summary>
Creates a default (unauthenticated) <see cref="T:Google.Apis.Http.ConfigurableHttpClient"/> from the
factory.
</summary>
<returns>An HTTP client that can be used to make unauthenticated requests.</returns>
<param name="clientFactory">The <see cref="T:Google.Apis.Http.HttpClientFactory"/> used to create
the HTTP client.</param>
</member>
<member name="M:FirebaseAdmin.Extensions.PostJsonAsync``1(System.Net.Http.HttpClient,System.String,``0,System.Threading.CancellationToken)">
<summary>
Makes a JSON POST request using the given parameters.
</summary>
<returns>An <see cref="T:System.Net.Http.HttpRequestMessage"/> representing the response to the
POST request.</returns>
<typeparam name="T">Type of the object that will be serialized into JSON.</typeparam>
<param name="client">The <see cref="T:System.Net.Http.HttpClient"/> used to make the request.</param>
<param name="requestUri">URI for the outgoing request.</param>
<param name="body">The object that will be serialized as the JSON body.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
</member>
<member name="M:FirebaseAdmin.Extensions.CreateJsonHttpContent(Google.Apis.Json.NewtonsoftJsonSerializer,System.Object)">
<summary>
Serializes the <paramref name="body"/> into JSON, and wraps the result in an instance
of <see cref="T:System.Net.Http.HttpContent"/>, which can be included in an outgoing HTTP request.
</summary>
<returns>An instance of <see cref="T:System.Net.Http.HttpContent"/> containing the JSON representation
of <paramref name="body"/>.</returns>
<param name="serializer">The JSON serializer to serialize the given object.</param>
<param name="body">The object that will be serialized into JSON.</param>
</member>
<member name="M:FirebaseAdmin.Extensions.UnixTimestamp(Google.Apis.Util.IClock)">
<summary>
Returns a Unix-styled timestamp (seconds from epoch) from the <see cref="T:Google.Apis.Util.IClock"/>.
</summary>
<returns>Number of seconds since epoch.</returns>
<param name="clock">The <see cref="T:Google.Apis.Util.IClock"/> used to generate the timestamp.</param>
</member>
<member name="M:FirebaseAdmin.Extensions.DisposeIfCreated``1(System.Lazy{``0})">
<summary>
Disposes a lazy-initialized object if the object has already been created.
</summary>
<param name="lazy">The lazy initializer containing a disposable object.</param>
<typeparam name="T">Type of the object that needs to be disposed.</typeparam>
</member>
<member name="M:FirebaseAdmin.Extensions.Copy``2(System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{``0,``1}})">
<summary>
Creates a shallow copy of a collection of key-value pairs.
</summary>
</member>
<member name="T:FirebaseAdmin.FirebaseApp">
<summary>
This is the entry point to the Firebase Admin SDK. It holds configuration and state common
to all APIs exposed from the SDK.
<para>Use one of the provided <c>Create()</c> methods to obtain a new instance.
See <a href="https://firebase.google.com/docs/admin/setup#initialize_the_sdk">
Initialize the SDK</a> for code samples and detailed documentation.</para>
</summary>
</member>
<member name="P:FirebaseAdmin.FirebaseApp.DefaultInstance">
<summary>
Gets the default app instance. This property is <c>null</c> if the default app instance
doesn't yet exist.
</summary>
</member>
<member name="P:FirebaseAdmin.FirebaseApp.Options">
<summary>
Gets a copy of the <see cref="T:FirebaseAdmin.AppOptions"/> this app was created with.
</summary>
</member>
<member name="P:FirebaseAdmin.FirebaseApp.Name">
<summary>
Gets the name of this app.
</summary>
</member>
<member name="M:FirebaseAdmin.FirebaseApp.GetInstance(System.String)">
<summary>
Returns the app instance identified by the given name.
</summary>
<returns>The <see cref="T:FirebaseAdmin.FirebaseApp"/> instance with the specified name or null if it
doesn't exist.</returns>
<exception cref="T:System.ArgumentException">If the name argument is null or empty.</exception>
<param name="name">Name of the app to retrieve.</param>
</member>
<member name="M:FirebaseAdmin.FirebaseApp.Create">
<summary>
Creates the default app instance with Google Application Default Credentials.
</summary>
<returns>The newly created <see cref="T:FirebaseAdmin.FirebaseApp"/> instance.</returns>
<exception cref="T:System.ArgumentException">If the default app instance already
exists.</exception>
</member>
<member name="M:FirebaseAdmin.FirebaseApp.Create(System.String)">
<summary>
Creates an app with the specified name, and Google Application Default Credentials.
</summary>
<returns>The newly created <see cref="T:FirebaseAdmin.FirebaseApp"/> instance.</returns>
<exception cref="T:System.ArgumentException">If the default app instance already
exists.</exception>
<param name="name">Name of the app.</param>
</member>
<member name="M:FirebaseAdmin.FirebaseApp.Create(FirebaseAdmin.AppOptions)">
<summary>
Creates the default app instance with the specified options.
</summary>
<returns>The newly created <see cref="T:FirebaseAdmin.FirebaseApp"/> instance.</returns>
<exception cref="T:System.ArgumentException">If the default app instance already
exists.</exception>
<param name="options">Options to create the app with. Must at least contain the
<c>Credential</c>.</param>
</member>
<member name="M:FirebaseAdmin.FirebaseApp.Create(FirebaseAdmin.AppOptions,System.String)">
<summary>
Creates an app with the specified name and options.
</summary>
<returns>The newly created <see cref="T:FirebaseAdmin.FirebaseApp"/> instance.</returns>
<exception cref="T:System.ArgumentException">If the default app instance already
exists.</exception>
<param name="options">Options to create the app with. Must at least contain the
<c>Credential</c>.</param>
<param name="name">Name of the app.</param>
</member>
<member name="M:FirebaseAdmin.FirebaseApp.Delete">
<summary>
Deletes this app instance and cleans up any state associated with it. Once an app has
been deleted, accessing any services related to it will result in an exception.
If the app is already deleted, this method is a no-op.
</summary>
</member>
<member name="M:FirebaseAdmin.FirebaseApp.DeleteAll">
<summary>
Deleted all the apps created so far. Used for unit testing.
</summary>
</member>
<member name="M:FirebaseAdmin.FirebaseApp.GetSdkVersion">
<summary>
Returns the current version of the .NET assembly.
</summary>
<returns>A version string in major.minor.patch format.</returns>
</member>
<member name="M:FirebaseAdmin.FirebaseApp.GetProjectId">
<summary>
Returns the Google Cloud Platform project ID associated with this Firebase app. If a
project ID is specified in <see cref="T:FirebaseAdmin.AppOptions"/>, that value is returned. If not
attempts to determine a project ID from the <see cref="T:Google.Apis.Auth.OAuth2.GoogleCredential"/> used to
initialize the app. Looks up the GOOGLE_CLOUD_PROJECT environment variable when all
else fails.
</summary>
<returns>A project ID string or null.</returns>
</member>
<member name="T:FirebaseAdmin.FirebaseException">
<summary>
Common error type for all exceptions raised by Firebase APIs.
</summary>
</member>
<member name="P:FirebaseAdmin.FirebaseException.ErrorCode">
<summary>
Gets the platform-wide error code associated with this exception.
</summary>
</member>
<member name="P:FirebaseAdmin.FirebaseException.HttpResponse">
<summary>
Gets the HTTP response that resulted in this exception. Null, if the exception was not
caused by an HTTP error response.
</summary>
</member>
<member name="T:FirebaseAdmin.HttpErrorHandler`1">
<summary>
Base class for handling HTTP error responses.
</summary>
</member>
<member name="M:FirebaseAdmin.HttpErrorHandler`1.CreateExceptionArgs(System.Net.Http.HttpResponseMessage,System.String)">
<summary>
Parses the given HTTP response to extract an error code and message from it.
</summary>
<param name="response">HTTP response message to process.</param>
<param name="body">The response body read from the message.</param>
<returns>A <see cref="T:FirebaseAdmin.HttpErrorHandler`1.FirebaseExceptionArgs"/> object containing error code and message.
Both the code and the message should not be null or empty.</returns>
</member>
<member name="M:FirebaseAdmin.HttpErrorHandler`1.CreateException(FirebaseAdmin.HttpErrorHandler{`0}.FirebaseExceptionArgs)">
<summary>
Creates a new <see cref="T:FirebaseAdmin.FirebaseException"/> from the specified arguments.
</summary>
<param name="args">A <see cref="T:FirebaseAdmin.HttpErrorHandler`1.FirebaseExceptionArgs"/> instance containing error
code, message and other details.</param>
<returns>A <see cref="T:FirebaseAdmin.FirebaseException"/> object.</returns>
</member>
<member name="T:FirebaseAdmin.IFirebaseService">
<summary>
A stateful service that can be associated with an <see cref="T:FirebaseAdmin.FirebaseApp"/>. This
interface enables tearing down the service when the parent app instance is deleted.
</summary>
</member>
<member name="M:FirebaseAdmin.IFirebaseService.Delete">
<summary>
Cleans up any state associated with this service making it unsuitable for further use.
</summary>
</member>
<member name="T:FirebaseAdmin.Messaging.Action">
<summary>
Represents an action available to users when the notification is presented.
</summary>
</member>
<member name="M:FirebaseAdmin.Messaging.Action.#ctor">
<summary>
Initializes a new instance of the <see cref="T:FirebaseAdmin.Messaging.Action"/> class.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.Action.ActionName">
<summary>
Gets or sets the name of the Action.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.Action.Title">
<summary>
Gets or sets the title text.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.Action.Icon">
<summary>
Gets or sets the icon URL.
</summary>
</member>
<member name="T:FirebaseAdmin.Messaging.AndroidConfig">
<summary>
Represents the Android-specific options that can be included in a <see cref="T:FirebaseAdmin.Messaging.Message"/>.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.AndroidConfig.CollapseKey">
<summary>
Gets or sets a collapse key for the message. Collapse key serves as an identifier for a
group of messages that can be collapsed, so that only the last message gets sent when
delivery can be resumed. A maximum of 4 different collapse keys may be active at any
given time.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.AndroidConfig.Priority">
<summary>
Gets or sets the priority of the message.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.AndroidConfig.TimeToLive">
<summary>
Gets or sets the time-to-live duration of the message.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.AndroidConfig.RestrictedPackageName">
<summary>
Gets or sets the package name of the application where the registration tokens must
match in order to receive the message.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.AndroidConfig.Data">
<summary>
Gets or sets a collection of key-value pairs that will be added to the message as data
fields. Keys and the values must not be null. When set, overrides any data fields set
on the top-level
<see cref="T:FirebaseAdmin.Messaging.Message"/>.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.AndroidConfig.Notification">
<summary>
Gets or sets the Android notification to be included in the message.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.AndroidConfig.FcmOptions">
<summary>
Gets or sets the FCM options to be included in the message.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.AndroidConfig.PriorityString">
<summary>
Gets or sets the string representation of <see cref="P:FirebaseAdmin.Messaging.AndroidConfig.Priority"/> as accepted by the FCM
backend service.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.AndroidConfig.TtlString">
<summary>
Gets or sets the string representation of <see cref="P:FirebaseAdmin.Messaging.AndroidConfig.TimeToLive"/> as accepted by the
FCM backend service. The string ends in the suffix "s" (indicating seconds) and is
preceded by the number of seconds, with nanoseconds expressed as fractional seconds.
</summary>
</member>
<member name="M:FirebaseAdmin.Messaging.AndroidConfig.CopyAndValidate">
<summary>
Copies this Android config, and validates the content of it to ensure that it can be
serialized into the JSON format expected by the FCM service.
</summary>
</member>
<member name="T:FirebaseAdmin.Messaging.AndroidFcmOptions">
<summary>
Represents Android FCM options.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.AndroidFcmOptions.AnalyticsLabel">
<summary>
Gets or sets analytics label.
</summary>
</member>
<member name="M:FirebaseAdmin.Messaging.AndroidFcmOptions.CopyAndValidate">
<summary>
Copies this FCM options, and validates the content of it to ensure that it can
be serialized into the JSON format expected by the FCM service.
</summary>
</member>
<member name="T:FirebaseAdmin.Messaging.AndroidNotification">
<summary>
Represents the Android-specific notification options that can be included in a
<see cref="T:FirebaseAdmin.Messaging.Message"/>.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.AndroidNotification.Title">
<summary>
Gets or sets the title of the Android notification. When provided, overrides the title
set via <see cref="P:FirebaseAdmin.Messaging.Notification.Title"/>.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.AndroidNotification.Body">
<summary>
Gets or sets the title of the Android notification. When provided, overrides the title
set via <see cref="P:FirebaseAdmin.Messaging.Notification.Body"/>.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.AndroidNotification.Icon">
<summary>
Gets or sets the icon of the Android notification.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.AndroidNotification.Color">
<summary>
Gets or sets the notification icon color. Must be of the form <c>#RRGGBB</c>.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.AndroidNotification.Sound">
<summary>
Gets or sets the sound to be played when the device receives the notification.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.AndroidNotification.Tag">
<summary>
Gets or sets the notification tag. This is an identifier used to replace existing
notifications in the notification drawer. If not specified, each request creates a new
notification.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.AndroidNotification.ImageUrl">
<summary>
Gets or sets the URL of the image to be displayed in the notification.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.AndroidNotification.ClickAction">
<summary>
Gets or sets the action associated with a user click on the notification. If specified,
an activity with a matching Intent Filter is launched when a user clicks on the
notification.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.AndroidNotification.TitleLocKey">
<summary>
Gets or sets the key of the title string in the app's string resources to use to
localize the title text.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.AndroidNotification.TitleLocArgs">
<summary>
Gets or sets the collection of resource key strings that will be used in place of the
format specifiers in <see cref="P:FirebaseAdmin.Messaging.AndroidNotification.TitleLocKey"/>.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.AndroidNotification.BodyLocKey">
<summary>
Gets or sets the key of the body string in the app's string resources to use to
localize the body text.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.AndroidNotification.BodyLocArgs">
<summary>
Gets or sets the collection of resource key strings that will be used in place of the
format specifiers in <see cref="P:FirebaseAdmin.Messaging.AndroidNotification.BodyLocKey"/>.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.AndroidNotification.ChannelId">
<summary>
Gets or sets the Android notification channel ID (new in Android O). The app must
create a channel with this channel ID before any notification with this channel ID is
received. If you don't send this channel ID in the request, or if the channel ID
provided has not yet been created by the app, FCM uses the channel ID specified in the
app manifest.
</summary>
</member>
<member name="M:FirebaseAdmin.Messaging.AndroidNotification.CopyAndValidate">
<summary>
Copies this notification, and validates the content of it to ensure that it can be
serialized into the JSON format expected by the FCM service.
</summary>
</member>
<member name="T:FirebaseAdmin.Messaging.ApnsConfig">
<summary>
Represents the APNS-specific options that can be included in a <see cref="T:FirebaseAdmin.Messaging.Message"/>. Refer
to <a href="https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/APNSOverview.html">
APNs documentation</a> for various headers and payload fields supported by APNS.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.ApnsConfig.Headers">
<summary>
Gets or sets the APNs headers.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.ApnsConfig.FcmOptions">
<summary>
Gets or sets the FCM options to be included in the message.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.ApnsConfig.Aps">
<summary>
Gets or sets the <c>aps</c> dictionary to be included in the APNs payload.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.ApnsConfig.CustomData">
<summary>
Gets or sets a collection of arbitrary key-value data that will be included in the APNs
payload.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.ApnsConfig.Payload">
<summary>
Gets or sets the APNs payload as accepted by the FCM backend servers.
</summary>
</member>
<member name="M:FirebaseAdmin.Messaging.ApnsConfig.CopyAndValidate">
<summary>
Copies this APNs config, and validates the content of it to ensure that it can be
serialized into the JSON format expected by the FCM service.
</summary>
</member>
<member name="T:FirebaseAdmin.Messaging.ApnsConfig.ApnsPayload">
<summary>
The APNs payload object as expected by the FCM backend service.
</summary>
</member>
<member name="M:FirebaseAdmin.Messaging.ApnsConfig.ApnsPayload.CopyAndValidate">
<summary>
Copies this APNs payload, and validates the content of it to ensure that it can be
serialized into the JSON format expected by the FCM service.
</summary>
</member>
<member name="T:FirebaseAdmin.Messaging.ApnsFcmOptions">
<summary>
Represents Apple Push Notification Service FCM options.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.ApnsFcmOptions.AnalyticsLabel">
<summary>
Gets or sets analytics label.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.ApnsFcmOptions.ImageUrl">
<summary>
Gets or sets the URL of the image to be displayed in the notification.
</summary>
</member>
<member name="M:FirebaseAdmin.Messaging.ApnsFcmOptions.CopyAndValidate">
<summary>
Copies this FCM options, and validates the content of it to ensure that it can
be serialized into the JSON format expected by the FCM service.
</summary>
</member>
<member name="T:FirebaseAdmin.Messaging.Aps">
<summary>
Represents the <a href="https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/PayloadKeyReference.html">
aps dictionary</a> that is part of every APNs message.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.Aps.Alert">
<summary>
Gets or sets an advanced alert configuration to be included in the message. It is an
error to set both <see cref="P:FirebaseAdmin.Messaging.Aps.Alert"/> and <see cref="P:FirebaseAdmin.Messaging.Aps.AlertString"/> properties
together.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.Aps.AlertString">
<summary>
Gets or sets the alert text to be included in the message. To specify a more advanced
alert configuration, use the <see cref="P:FirebaseAdmin.Messaging.Aps.Alert"/> property instead. It is an error to
set both <see cref="P:FirebaseAdmin.Messaging.Aps.Alert"/> and <see cref="P:FirebaseAdmin.Messaging.Aps.AlertString"/> properties together.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.Aps.Badge">
<summary>
Gets or sets the badge to be displayed with the message. Set to 0 to remove the badge.
When not specified, the badge will remain unchanged.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.Aps.Sound">
<summary>
Gets or sets the name of a sound file in your app's main bundle or in the
<c>Library/Sounds</c> folder of your app's container directory. Specify the
string <c>default</c> to play the system sound. It is an error to set both
<see cref="P:FirebaseAdmin.Messaging.Aps.Sound"/> and <see cref="P:FirebaseAdmin.Messaging.Aps.CriticalSound"/> properties together.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.Aps.CriticalSound">
<summary>
Gets or sets the critical alert sound to be played with the message. It is an error to
set both <see cref="P:FirebaseAdmin.Messaging.Aps.Sound"/> and <see cref="P:FirebaseAdmin.Messaging.Aps.CriticalSound"/> properties together.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.Aps.ContentAvailable">
<summary>
Gets or sets a value indicating whether to configure a background update notification.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.Aps.MutableContent">
<summary>
Gets or sets a value indicating whether to include the <c>mutable-content</c> property
in the message. When set, this property allows clients to modify the notification via
app extensions.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.Aps.Category">
<summary>
Gets or sets the type of the notification.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.Aps.ThreadId">
<summary>
Gets or sets the app-specific identifier for grouping notifications.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.Aps.CustomData">
<summary>
Gets or sets a collection of arbitrary key-value data to be included in the <c>aps</c>
dictionary. This is exposed as an <see cref="T:System.Collections.Generic.IDictionary`2"/> to support
correct deserialization of custom properties.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.Aps.AlertObject">
<summary>
Gets or sets the alert configuration of the <c>aps</c> dictionary. Read from either
<see cref="P:FirebaseAdmin.Messaging.Aps.Alert"/> or <see cref="P:FirebaseAdmin.Messaging.Aps.AlertString"/> property.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.Aps.SoundObject">
<summary>
Gets or sets the sound configuration of the <c>aps</c> dictionary. Read from either
<see cref="P:FirebaseAdmin.Messaging.Aps.Sound"/> or <see cref="P:FirebaseAdmin.Messaging.Aps.CriticalSound"/> property.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.Aps.ContentAvailableInt">
<summary>
Gets or sets the integer representation of the <see cref="P:FirebaseAdmin.Messaging.Aps.ContentAvailable"/> property,
which is how APNs expects it.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.Aps.MutableContentInt">
<summary>
Gets or sets the integer representation of the <see cref="P:FirebaseAdmin.Messaging.Aps.MutableContent"/> property,
which is how APNs expects it.
</summary>
</member>
<member name="M:FirebaseAdmin.Messaging.Aps.CopyAndValidate">
<summary>
Copies this Aps dictionary, and validates the content of it to ensure that it can be
serialized into the JSON format expected by the FCM and APNs services.
</summary>
</member>
<member name="T:FirebaseAdmin.Messaging.ApsAlert">
<summary>
Represents the <a href="https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/PayloadKeyReference.html#//apple_ref/doc/uid/TP40008194-CH17-SW5">
alert property</a> that can be included in the <c>aps</c> dictionary of an APNs
payload.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.ApsAlert.Title">
<summary>
Gets or sets the title of the alert. When provided, overrides the title set via
<see cref="P:FirebaseAdmin.Messaging.Notification.Title"/>.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.ApsAlert.Subtitle">
<summary>
Gets or sets the subtitle of the alert.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.ApsAlert.Body">
<summary>
Gets or sets the body of the alert. When provided, overrides the body set via
<see cref="P:FirebaseAdmin.Messaging.Notification.Body"/>.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.ApsAlert.LocKey">
<summary>
Gets or sets the key of the body string in the app's string resources to use to
localize the body text.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.ApsAlert.LocArgs">
<summary>
Gets or sets the resource key strings that will be used in place of the format
specifiers in <see cref="P:FirebaseAdmin.Messaging.ApsAlert.LocKey"/>.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.ApsAlert.TitleLocKey">
<summary>
Gets or sets the key of the title string in the app's string resources to use to
localize the title text.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.ApsAlert.TitleLocArgs">
<summary>
Gets or sets the resource key strings that will be used in place of the format
specifiers in <see cref="P:FirebaseAdmin.Messaging.ApsAlert.TitleLocKey"/>.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.ApsAlert.SubtitleLocKey">
<summary>
Gets or sets the key of the subtitle string in the app's string resources to use to
localize the subtitle text.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.ApsAlert.SubtitleLocArgs">
<summary>
Gets or sets the resource key strings that will be used in place of the format
specifiers in <see cref="P:FirebaseAdmin.Messaging.ApsAlert.SubtitleLocKey"/>.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.ApsAlert.ActionLocKey">
<summary>
Gets or sets the key of the text in the app's string resources to use to localize the
action button text.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.ApsAlert.LaunchImage">
<summary>
Gets or sets the launch image for the notification action.
</summary>
</member>
<member name="M:FirebaseAdmin.Messaging.ApsAlert.CopyAndValidate">
<summary>
Copies this alert dictionary, and validates the content of it to ensure that it can be
serialized into the JSON format expected by the FCM and APNs services.
</summary>
</member>
<member name="T:FirebaseAdmin.Messaging.BatchResponse">
<summary>
Response from an operation that sends FCM messages to multiple recipients.
See <see cref="M:FirebaseAdmin.Messaging.FirebaseMessaging.SendMulticastAsync(FirebaseAdmin.Messaging.MulticastMessage)"/>.
</summary>
</member>
<member name="M:FirebaseAdmin.Messaging.BatchResponse.#ctor(System.Collections.Generic.IEnumerable{FirebaseAdmin.Messaging.SendResponse})">
<summary>
Initializes a new instance of the <see cref="T:FirebaseAdmin.Messaging.BatchResponse"/> class.
</summary>
<param name="responses">The responses.</param>
</member>
<member name="P:FirebaseAdmin.Messaging.BatchResponse.Responses">
<summary>
Gets information about all responses for the batch.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.BatchResponse.SuccessCount">
<summary>
Gets a count of how many of the responses in <see cref="P:FirebaseAdmin.Messaging.BatchResponse.Responses"/> were
successful.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.BatchResponse.FailureCount">
<summary>
Gets a count of how many of the responses in <see cref="P:FirebaseAdmin.Messaging.BatchResponse.Responses"/> were
unsuccessful.
</summary>
</member>
<member name="T:FirebaseAdmin.Messaging.CriticalSound">
<summary>
The sound configuration for APNs critical alerts.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.CriticalSound.Critical">
<summary>
Gets or sets a value indicating whether to set the critical alert flag on the sound
configuration.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.CriticalSound.Name">
<summary>
Gets or sets the name of the sound to be played. This should be a sound file in your
app's main bundle or in the <c>Library/Sounds</c> folder of your app's container
directory. Specify the string <c>default</c> to play the system sound.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.CriticalSound.Volume">
<summary>
Gets or sets the volume for the critical alert's sound. Must be a value between 0.0
(silent) and 1.0 (full volume).
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.CriticalSound.CriticalInt">
<summary>
Gets or sets the integer representation of the <see cref="P:FirebaseAdmin.Messaging.CriticalSound.Critical"/> property, which
is how APNs expects it.
</summary>
</member>
<member name="M:FirebaseAdmin.Messaging.CriticalSound.CopyAndValidate">
<summary>
Copies this critical sound configuration, and validates the content of it to ensure
that it can be serialized into the JSON format expected by the FCM and APNs services.
</summary>
</member>
<member name="T:FirebaseAdmin.Messaging.Direction">
<summary>
Different directions a notification can be displayed in.
</summary>
</member>
<member name="F:FirebaseAdmin.Messaging.Direction.Auto">
<summary>
Direction automatically determined.
</summary>
</member>
<member name="F:FirebaseAdmin.Messaging.Direction.LeftToRight">
<summary>
Left to right.
</summary>
</member>
<member name="F:FirebaseAdmin.Messaging.Direction.RightToLeft">
<summary>
Right to left.
</summary>
</member>
<member name="T:FirebaseAdmin.Messaging.ErrorInfo">
<summary>
A topic management error.
</summary>
</member>
<member name="M:FirebaseAdmin.Messaging.ErrorInfo.#ctor(System.Int32,System.String)">
<summary>
Initializes a new instance of the <see cref="T:FirebaseAdmin.Messaging.ErrorInfo"/> class.
</summary>
<param name="index">Index of the error in the error codes.</param>
<param name="reason">Reason for the error.</param>
</member>
<member name="P:FirebaseAdmin.Messaging.ErrorInfo.Index">
<summary>
Gets the registration token to which this error is related to.
</summary>
<returns>An index into the original registration token list.</returns>
</member>
<member name="P:FirebaseAdmin.Messaging.ErrorInfo.Reason">
<summary>
Gets the nature of the error.
</summary>
<returns>A non-null, non-empty error message.</returns>
</member>
<member name="T:FirebaseAdmin.Messaging.FcmOptions">
<summary>
Represents FCM options.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.FcmOptions.AnalyticsLabel">
<summary>
Gets or sets analytics label.
</summary>
</member>
<member name="M:FirebaseAdmin.Messaging.FcmOptions.CopyAndValidate">
<summary>
Copies this FCM options, and validates the content of it to ensure that it can
be serialized into the JSON format expected by the FCM service.
</summary>
</member>
<member name="T:FirebaseAdmin.Messaging.FirebaseMessaging">
<summary>
This is the entry point to all server-side Firebase Cloud Messaging (FCM) operations. You
can get an instance of this class via <c>FirebaseMessaging.DefaultInstance</c>.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.FirebaseMessaging.DefaultInstance">
<summary>
Gets the messaging instance associated with the default Firebase app. This property is
<c>null</c> if the default app doesn't yet exist.
</summary>
</member>
<member name="M:FirebaseAdmin.Messaging.FirebaseMessaging.GetMessaging(FirebaseAdmin.FirebaseApp)">
<summary>
Returns the messaging instance for the specified app.
</summary>
<returns>The <see cref="T:FirebaseAdmin.Messaging.FirebaseMessaging"/> instance associated with the specified
app.</returns>
<exception cref="T:System.ArgumentNullException">If the app argument is null.</exception>
<param name="app">An app instance.</param>
</member>
<member name="M:FirebaseAdmin.Messaging.FirebaseMessaging.SendAsync(FirebaseAdmin.Messaging.Message)">
<summary>
Sends a message to the FCM service for delivery. The message gets validated both by
the Admin SDK, and the remote FCM service. A successful return value indicates
that the message has been successfully sent to FCM, where it has been accepted by the
FCM service.
</summary>
<returns>A task that completes with a message ID string, which represents
successful handoff to FCM.</returns>
<exception cref="T:System.ArgumentNullException">If the message argument is null.</exception>
<exception cref="T:System.ArgumentException">If the message contains any invalid
fields.</exception>
<exception cref="T:FirebaseAdmin.Messaging.FirebaseMessagingException">If an error occurs while sending the
message.</exception>
<param name="message">The message to be sent. Must not be null.</param>
</member>
<member name="M:FirebaseAdmin.Messaging.FirebaseMessaging.SendAsync(FirebaseAdmin.Messaging.Message,System.Threading.CancellationToken)">
<summary>
Sends a message to the FCM service for delivery. The message gets validated both by
the Admin SDK, and the remote FCM service. A successful return value indicates
that the message has been successfully sent to FCM, where it has been accepted by the
FCM service.
</summary>
<returns>A task that completes with a message ID string, which represents
successful handoff to FCM.</returns>
<exception cref="T:System.ArgumentNullException">If the message argument is null.</exception>
<exception cref="T:System.ArgumentException">If the message contains any invalid
fields.</exception>
<exception cref="T:FirebaseAdmin.Messaging.FirebaseMessagingException">If an error occurs while sending the
message.</exception>
<param name="message">The message to be sent. Must not be null.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
</member>
<member name="M:FirebaseAdmin.Messaging.FirebaseMessaging.SendAsync(FirebaseAdmin.Messaging.Message,System.Boolean)">
<summary>
Sends a message to the FCM service for delivery. The message gets validated both by
the Admin SDK, and the remote FCM service. A successful return value indicates
that the message has been successfully sent to FCM, where it has been accepted by the
FCM service.
<para>If the <paramref name="dryRun"/> option is set to true, the message will not be
actually sent to the recipients. Instead, the FCM service performs all the necessary
validations, and emulates the send operation. This is a good way to check if a
certain message will be accepted by FCM for delivery.</para>
</summary>
<returns>A task that completes with a message ID string, which represents
successful handoff to FCM.</returns>
<exception cref="T:System.ArgumentNullException">If the message argument is null.</exception>
<exception cref="T:System.ArgumentException">If the message contains any invalid
fields.</exception>
<exception cref="T:FirebaseAdmin.Messaging.FirebaseMessagingException">If an error occurs while sending the
message.</exception>
<param name="message">The message to be sent. Must not be null.</param>
<param name="dryRun">A boolean indicating whether to perform a dry run (validation
only) of the send. If set to true, the message will be sent to the FCM backend service,
but it will not be delivered to any actual recipients.</param>
</member>
<member name="M:FirebaseAdmin.Messaging.FirebaseMessaging.SendAsync(FirebaseAdmin.Messaging.Message,System.Boolean,System.Threading.CancellationToken)">
<summary>
Sends a message to the FCM service for delivery. The message gets validated both by
the Admin SDK, and the remote FCM service. A successful return value indicates
that the message has been successfully sent to FCM, where it has been accepted by the
FCM service.
<para>If the <paramref name="dryRun"/> option is set to true, the message will not be
actually sent to the recipients. Instead, the FCM service performs all the necessary
validations, and emulates the send operation. This is a good way to check if a
certain message will be accepted by FCM for delivery.</para>
</summary>
<returns>A task that completes with a message ID string, which represents
successful handoff to FCM.</returns>
<exception cref="T:System.ArgumentNullException">If the message argument is null.</exception>
<exception cref="T:System.ArgumentException">If the message contains any invalid
fields.</exception>
<exception cref="T:FirebaseAdmin.Messaging.FirebaseMessagingException">If an error occurs while sending the
message.</exception>
<param name="message">The message to be sent. Must not be null.</param>
<param name="dryRun">A boolean indicating whether to perform a dry run (validation
only) of the send. If set to true, the message will be sent to the FCM backend service,
but it will not be delivered to any actual recipients.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
</member>
<member name="M:FirebaseAdmin.Messaging.FirebaseMessaging.SendAllAsync(System.Collections.Generic.IEnumerable{FirebaseAdmin.Messaging.Message})">
<summary>
Sends all the messages in the given list via Firebase Cloud Messaging. Employs batching to
send the entire list as a single RPC call. Compared to the <see cref="M:FirebaseAdmin.Messaging.FirebaseMessaging.SendAsync(FirebaseAdmin.Messaging.Message)"/>
method, this is a significantly more efficient way to send multiple messages.
</summary>
<exception cref="T:FirebaseAdmin.Messaging.FirebaseMessagingException">If an error occurs while sending the
messages.</exception>
<param name="messages">Up to 100 messages to send in the batch. Cannot be null.</param>
<returns>A <see cref="T:FirebaseAdmin.Messaging.BatchResponse"/> containing details of the batch operation's
outcome.</returns>
</member>
<member name="M:FirebaseAdmin.Messaging.FirebaseMessaging.SendAllAsync(System.Collections.Generic.IEnumerable{FirebaseAdmin.Messaging.Message},System.Threading.CancellationToken)">
<summary>
Sends all the messages in the given list via Firebase Cloud Messaging. Employs batching to
send the entire list as a single RPC call. Compared to the <see cref="M:FirebaseAdmin.Messaging.FirebaseMessaging.SendAsync(FirebaseAdmin.Messaging.Message)"/>
method, this is a significantly more efficient way to send multiple messages.
</summary>
<exception cref="T:FirebaseAdmin.Messaging.FirebaseMessagingException">If an error occurs while sending the
messages.</exception>
<param name="messages">Up to 100 messages to send in the batch. Cannot be null.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
<returns>A <see cref="T:FirebaseAdmin.Messaging.BatchResponse"/> containing details of the batch operation's
outcome.</returns>
</member>
<member name="M:FirebaseAdmin.Messaging.FirebaseMessaging.SendAllAsync(System.Collections.Generic.IEnumerable{FirebaseAdmin.Messaging.Message},System.Boolean)">
<summary>
Sends all the messages in the given list via Firebase Cloud Messaging. Employs batching to
send the entire list as a single RPC call. Compared to the <see cref="M:FirebaseAdmin.Messaging.FirebaseMessaging.SendAsync(FirebaseAdmin.Messaging.Message)"/>
method, this is a significantly more efficient way to send multiple messages.
</summary>
<exception cref="T:FirebaseAdmin.Messaging.FirebaseMessagingException">If an error occurs while sending the
messages.</exception>
<param name="messages">Up to 100 messages to send in the batch. Cannot be null.</param>
<param name="dryRun">A boolean indicating whether to perform a dry run (validation
only) of the send. If set to true, the message will be sent to the FCM backend service,
but it will not be delivered to any actual recipients.</param>
<returns>A <see cref="T:FirebaseAdmin.Messaging.BatchResponse"/> containing details of the batch operation's
outcome.</returns>
</member>
<member name="M:FirebaseAdmin.Messaging.FirebaseMessaging.SendAllAsync(System.Collections.Generic.IEnumerable{FirebaseAdmin.Messaging.Message},System.Boolean,System.Threading.CancellationToken)">
<summary>
Sends all the messages in the given list via Firebase Cloud Messaging. Employs batching to
send the entire list as a single RPC call. Compared to the <see cref="M:FirebaseAdmin.Messaging.FirebaseMessaging.SendAsync(FirebaseAdmin.Messaging.Message)"/>
method, this is a significantly more efficient way to send multiple messages.
</summary>
<exception cref="T:FirebaseAdmin.Messaging.FirebaseMessagingException">If an error occurs while sending the
messages.</exception>
<param name="messages">Up to 100 messages to send in the batch. Cannot be null.</param>
<param name="dryRun">A boolean indicating whether to perform a dry run (validation
only) of the send. If set to true, the message will be sent to the FCM backend service,
but it will not be delivered to any actual recipients.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
<returns>A <see cref="T:FirebaseAdmin.Messaging.BatchResponse"/> containing details of the batch operation's
outcome.</returns>
</member>
<member name="M:FirebaseAdmin.Messaging.FirebaseMessaging.SendMulticastAsync(FirebaseAdmin.Messaging.MulticastMessage)">
<summary>
Sends the given multicast message to all the FCM registration tokens specified in it.
</summary>
<exception cref="T:FirebaseAdmin.Messaging.FirebaseMessagingException">If an error occurs while sending the
messages.</exception>
<param name="message">The message to be sent. Must not be null.</param>
<returns>A <see cref="T:FirebaseAdmin.Messaging.BatchResponse"/> containing details of the batch operation's
outcome.</returns>
</member>
<member name="M:FirebaseAdmin.Messaging.FirebaseMessaging.SendMulticastAsync(FirebaseAdmin.Messaging.MulticastMessage,System.Threading.CancellationToken)">
<summary>
Sends the given multicast message to all the FCM registration tokens specified in it.
</summary>
<exception cref="T:FirebaseAdmin.Messaging.FirebaseMessagingException">If an error occurs while sending the
messages.</exception>
<param name="message">The message to be sent. Must not be null.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
<returns>A <see cref="T:FirebaseAdmin.Messaging.BatchResponse"/> containing details of the batch operation's
outcome.</returns>
</member>
<member name="M:FirebaseAdmin.Messaging.FirebaseMessaging.SendMulticastAsync(FirebaseAdmin.Messaging.MulticastMessage,System.Boolean)">
<summary>
Sends the given multicast message to all the FCM registration tokens specified in it.
<para>If the <paramref name="dryRun"/> option is set to true, the message will not be
actually sent to the recipients. Instead, the FCM service performs all the necessary
validations, and emulates the send operation. This is a good way to check if a
certain message will be accepted by FCM for delivery.</para>
</summary>
<exception cref="T:FirebaseAdmin.Messaging.FirebaseMessagingException">If an error occurs while sending the
messages.</exception>
<param name="message">The message to be sent. Must not be null.</param>
<param name="dryRun">A boolean indicating whether to perform a dry run (validation
only) of the send. If set to true, the message will be sent to the FCM backend service,
but it will not be delivered to any actual recipients.</param>
<returns>A <see cref="T:FirebaseAdmin.Messaging.BatchResponse"/> containing details of the batch operation's
outcome.</returns>
</member>
<member name="M:FirebaseAdmin.Messaging.FirebaseMessaging.SendMulticastAsync(FirebaseAdmin.Messaging.MulticastMessage,System.Boolean,System.Threading.CancellationToken)">
<summary>
Sends the given multicast message to all the FCM registration tokens specified in it.
<para>If the <paramref name="dryRun"/> option is set to true, the message will not be
actually sent to the recipients. Instead, the FCM service performs all the necessary
validations, and emulates the send operation. This is a good way to check if a
certain message will be accepted by FCM for delivery.</para>
</summary>
<exception cref="T:FirebaseAdmin.Messaging.FirebaseMessagingException">If an error occurs while sending the
messages.</exception>
<param name="message">The message to be sent. Must not be null.</param>
<param name="dryRun">A boolean indicating whether to perform a dry run (validation
only) of the send. If set to true, the message will be sent to the FCM backend service,
but it will not be delivered to any actual recipients.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
<returns>A <see cref="T:FirebaseAdmin.Messaging.BatchResponse"/> containing details of the batch operation's
outcome.</returns>
</member>
<member name="M:FirebaseAdmin.Messaging.FirebaseMessaging.SubscribeToTopicAsync(System.Collections.Generic.IReadOnlyList{System.String},System.String)">
<summary>
Subscribes a list of registration tokens to a topic.
</summary>
<param name="registrationTokens">A list of registration tokens to subscribe.</param>
<param name="topic">The topic name to subscribe to. /topics/ will be prepended to the topic name provided if absent.</param>
<returns>A task that completes with a <see cref="T:FirebaseAdmin.Messaging.TopicManagementResponse"/>, giving details about the topic subscription operations.</returns>
</member>
<member name="M:FirebaseAdmin.Messaging.FirebaseMessaging.UnsubscribeFromTopicAsync(System.Collections.Generic.IReadOnlyList{System.String},System.String)">
<summary>
Unsubscribes a list of registration tokens from a topic.
</summary>
<param name="registrationTokens">A list of registration tokens to unsubscribe.</param>
<param name="topic">The topic name to unsubscribe from. /topics/ will be prepended to the topic name provided if absent.</param>
<returns>A task that completes with a <see cref="T:FirebaseAdmin.Messaging.TopicManagementResponse"/>, giving details about the topic unsubscription operations.</returns>
</member>
<member name="M:FirebaseAdmin.Messaging.FirebaseMessaging.FirebaseAdmin#IFirebaseService#Delete">
<summary>
Deletes this <see cref="T:FirebaseAdmin.Messaging.FirebaseMessaging"/> service instance.
</summary>
</member>
<member name="T:FirebaseAdmin.Messaging.FirebaseMessagingClient">
<summary>
A client for making authorized HTTP calls to the FCM backend service. Handles request
serialization, response parsing, and HTTP error handling.
</summary>
</member>
<member name="M:FirebaseAdmin.Messaging.FirebaseMessagingClient.SendAsync(FirebaseAdmin.Messaging.Message,System.Boolean,System.Threading.CancellationToken)">
<summary>
Sends a message to the FCM service for delivery. The message gets validated both by
the Admin SDK, and the remote FCM service. A successful return value indicates
that the message has been successfully sent to FCM, where it has been accepted by the
FCM service.
</summary>
<returns>A task that completes with a message ID string, which represents
successful handoff to FCM.</returns>
<exception cref="T:System.ArgumentNullException">If the message argument is null.</exception>
<exception cref="T:System.ArgumentException">If the message contains any invalid
fields.</exception>
<exception cref="T:FirebaseAdmin.Messaging.FirebaseMessagingException">If an error occurs while sending the
message.</exception>
<param name="message">The message to be sent. Must not be null.</param>
<param name="dryRun">A boolean indicating whether to perform a dry run (validation
only) of the send. If set to true, the message will be sent to the FCM backend service,
but it will not be delivered to any actual recipients.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
</member>
<member name="M:FirebaseAdmin.Messaging.FirebaseMessagingClient.SendAllAsync(System.Collections.Generic.IEnumerable{FirebaseAdmin.Messaging.Message},System.Boolean,System.Threading.CancellationToken)">
<summary>
Sends all messages in a single batch.
</summary>
<param name="messages">The messages to be sent. Must not be null.</param>
<param name="dryRun">A boolean indicating whether to perform a dry run (validation
only) of the send. If set to true, the messages will be sent to the FCM backend service,
but it will not be delivered to any actual recipients.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
<returns>A task that completes with a <see cref="T:FirebaseAdmin.Messaging.BatchResponse"/>, giving details about
the batch operation.</returns>
</member>
<member name="T:FirebaseAdmin.Messaging.FirebaseMessagingClient.SendRequest">
<summary>
Represents the envelope message accepted by the FCM backend service, including the message
payload and other options like <c>validate_only</c>.
</summary>
</member>
<member name="T:FirebaseAdmin.Messaging.FirebaseMessagingClient.SingleMessageResponse">
<summary>
Represents the response messages sent by the FCM backend service when sending a single
message. Primarily consists of the message ID (Name) that indicates success handoff to FCM.
</summary>
</member>
<member name="T:FirebaseAdmin.Messaging.FirebaseMessagingException">
<summary>
Exception type raised by Firebase Cloud Messaging APIs.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.FirebaseMessagingException.MessagingErrorCode">
<summary>
Gets the Cloud Messaging error code associated with this exception. May be null.
</summary>
</member>
<member name="T:FirebaseAdmin.Messaging.InstanceIdClient">
<summary>
A helper class for interacting with the Firebase Instance ID service.Implements the FCM
topic management functionality.
</summary>
</member>
<member name="M:FirebaseAdmin.Messaging.InstanceIdClient.#ctor(Google.Apis.Http.HttpClientFactory,Google.Apis.Auth.OAuth2.GoogleCredential,FirebaseAdmin.Util.RetryOptions)">
<summary>
Initializes a new instance of the <see cref="T:FirebaseAdmin.Messaging.InstanceIdClient"/> class.
</summary>
<param name="clientFactory">A default implentation of the HTTP client factory.</param>
<param name="credential">An instance of the <see cref="T:Google.Apis.Auth.OAuth2.GoogleCredential"/> class.</param>
<param name="retryOptions">An instance of the <see cref="T:FirebaseAdmin.Util.RetryOptions"/> class.</param>
</member>
<member name="M:FirebaseAdmin.Messaging.InstanceIdClient.SubscribeToTopicAsync(System.Collections.Generic.IReadOnlyList{System.String},System.String)">
<summary>
Subscribes a list of registration tokens to a topic.
</summary>
<param name="registrationTokens">A list of registration tokens to subscribe.</param>
<param name="topic">The topic name to subscribe to. /topics/ will be prepended to the
topic name provided if absent.</param>
<returns>A task that completes with a <see cref="T:FirebaseAdmin.Messaging.TopicManagementResponse"/>, giving
details about the topic subscription operations.</returns>
</member>
<member name="M:FirebaseAdmin.Messaging.InstanceIdClient.UnsubscribeFromTopicAsync(System.Collections.Generic.IReadOnlyList{System.String},System.String)">
<summary>
Unsubscribes a list of registration tokens from a topic.
</summary>
<param name="registrationTokens">A list of registration tokens to unsubscribe.</param>
<param name="topic">The topic name to unsubscribe from. /topics/ will be prepended to
the topic name provided if absent.</param>
<returns>A task that completes with a <see cref="T:FirebaseAdmin.Messaging.TopicManagementResponse"/>, giving
details about the topic unsubscription operations.</returns>
</member>
<member name="M:FirebaseAdmin.Messaging.InstanceIdClient.Dispose">
<summary>
Dispose the HttpClient.
</summary>
</member>
<member name="T:FirebaseAdmin.Messaging.InstanceIdServiceResponse">
<summary>
Response from an operation that subscribes or unsubscribes registration tokens to a topic.
See <see cref="M:FirebaseAdmin.Messaging.FirebaseMessaging.SubscribeToTopicAsync(System.Collections.Generic.IReadOnlyList{System.String},System.String)"/> and
<see cref="M:FirebaseAdmin.Messaging.FirebaseMessaging.UnsubscribeFromTopicAsync(System.Collections.Generic.IReadOnlyList{System.String},System.String)"/>.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.InstanceIdServiceResponse.Results">
<summary>
Gets the errors returned by the operation.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.InstanceIdServiceResponse.ErrorCount">
<summary>
Gets the number of errors returned by the operation.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.InstanceIdServiceResponse.ResultCount">
<summary>
Gets the number of results returned by the operation.
</summary>
</member>
<member name="T:FirebaseAdmin.Messaging.InstanceIdServiceResponse.InstanceIdServiceResponseElement">
<summary>
An instance Id response error.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.InstanceIdServiceResponse.InstanceIdServiceResponseElement.Error">
<summary>
Gets a value indicating the error in this element of the response array. If this is empty this indicates success.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.InstanceIdServiceResponse.InstanceIdServiceResponseElement.HasError">
<summary>
Gets a value indicating whether this response element in the response array is an error, as an empty element indicates success.
</summary>
</member>
<member name="T:FirebaseAdmin.Messaging.Message">
<summary>
Represents a message that can be sent via Firebase Cloud Messaging (FCM). Contains payload
information as well as the recipient information. The recipient information must be
specified by setting exactly one of the <see cref="P:FirebaseAdmin.Messaging.Message.Token"/>, <see cref="P:FirebaseAdmin.Messaging.Message.Topic"/> or
<see cref="P:FirebaseAdmin.Messaging.Message.Condition"/> fields.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.Message.Token">
<summary>
Gets or sets the registration token of the device to which the message should be sent.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.Message.Topic">
<summary>
Gets or sets the name of the FCM topic to which the message should be sent. Topic names
may contain the <c>/topics/</c> prefix.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.Message.Condition">
<summary>
Gets or sets the FCM condition to which the message should be sent. Must be a valid
condition string such as <c>"'foo' in topics"</c>.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.Message.Data">
<summary>
Gets or sets a collection of key-value pairs that will be added to the message as data
fields. Keys and the values must not be null.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.Message.Notification">
<summary>
Gets or sets the notification information to be included in the message.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.Message.Android">
<summary>
Gets or sets the Android-specific information to be included in the message.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.Message.Webpush">
<summary>
Gets or sets the Webpush-specific information to be included in the message.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.Message.Apns">
<summary>
Gets or sets the APNs-specific information to be included in the message.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.Message.FcmOptions">
<summary>
Gets or sets the FCM options to be included in the message.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.Message.UnprefixedTopic">
<summary>
Gets or sets the formatted representation of the <see cref="P:FirebaseAdmin.Messaging.Message.Topic"/>. Removes the
<c>/topics/</c> prefix if present. This is what's ultimately sent to the FCM
service.
</summary>
</member>
<member name="M:FirebaseAdmin.Messaging.Message.CopyAndValidate">
<summary>
Copies this message, and validates the content of it to ensure that it can be
serialized into the JSON format expected by the FCM service. Each property is copied
before validation to guard against the original being modified in the user code
post-validation.
</summary>
</member>
<member name="T:FirebaseAdmin.Messaging.MessagingErrorCode">
<summary>
Error codes that can be raised by the Cloud Messaging APIs.
</summary>
</member>
<member name="F:FirebaseAdmin.Messaging.MessagingErrorCode.ThirdPartyAuthError">
<summary>
APNs certificate or web push auth key was invalid or missing.
</summary>
</member>
<member name="F:FirebaseAdmin.Messaging.MessagingErrorCode.InvalidArgument">
<summary>
One or more argument specified in the request was invalid.
</summary>
</member>
<member name="F:FirebaseAdmin.Messaging.MessagingErrorCode.Internal">
<summary>
Internal server error.
</summary>
</member>
<member name="F:FirebaseAdmin.Messaging.MessagingErrorCode.QuotaExceeded">
<summary>
Sending limit exceeded for the message target.
</summary>
</member>
<member name="F:FirebaseAdmin.Messaging.MessagingErrorCode.SenderIdMismatch">
<summary>
The authenticated sender ID is different from the sender ID for the registration token.
</summary>
</member>
<member name="F:FirebaseAdmin.Messaging.MessagingErrorCode.Unavailable">
<summary>
Cloud Messaging service is temporarily unavailable.
</summary>
</member>
<member name="F:FirebaseAdmin.Messaging.MessagingErrorCode.Unregistered">
<summary>
App instance was unregistered from FCM. This usually means that the token used is no
longer valid and a new one must be used.
</summary>
</member>
<member name="T:FirebaseAdmin.Messaging.MessagingErrorHandler">
<summary>
Parses error responses received from the FCM service, and creates instances of
<see cref="T:FirebaseAdmin.Messaging.FirebaseMessagingException"/>.
</summary>
</member>
<member name="T:FirebaseAdmin.Messaging.MulticastMessage">
<summary>
Represents a message that can be sent to multiple devices via Firebase Cloud Messaging (FCM).
Contains payload information as well as the list of device registration tokens to which the
message should be sent. A single <c>MulticastMessage</c> may contain up to 500 registration
tokens.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.MulticastMessage.Tokens">
<summary>
Gets or sets the registration tokens for the devices to which the message should be distributed.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.MulticastMessage.Data">
<summary>
Gets or sets a collection of key-value pairs that will be added to the message as data
fields. Keys and the values must not be null.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.MulticastMessage.Notification">
<summary>
Gets or sets the notification information to be included in the message.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.MulticastMessage.Android">
<summary>
Gets or sets the Android-specific information to be included in the message.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.MulticastMessage.Webpush">
<summary>
Gets or sets the Webpush-specific information to be included in the message.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.MulticastMessage.Apns">
<summary>
Gets or sets the APNs-specific information to be included in the message.
</summary>
</member>
<member name="T:FirebaseAdmin.Messaging.Notification">
<summary>
Represents the notification parameters that can be included in a <see cref="T:FirebaseAdmin.Messaging.Message"/>.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.Notification.Title">
<summary>
Gets or sets the title of the notification.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.Notification.Body">
<summary>
Gets or sets the body of the notification.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.Notification.ImageUrl">
<summary>
Gets or sets the URL of the image to be displayed in the notification.
</summary>
</member>
<member name="M:FirebaseAdmin.Messaging.Notification.CopyAndValidate">
<summary>
Copies this notification, and validates the content of it to ensure that it can
be serialized into the JSON format expected by the FCM service.
</summary>
</member>
<member name="T:FirebaseAdmin.Messaging.Priority">
<summary>
Priority levels that can be set on an <see cref="T:FirebaseAdmin.Messaging.AndroidConfig"/>.
</summary>
</member>
<member name="F:FirebaseAdmin.Messaging.Priority.High">
<summary>
High priority message.
</summary>
</member>
<member name="F:FirebaseAdmin.Messaging.Priority.Normal">
<summary>
Normal priority message.
</summary>
</member>
<member name="T:FirebaseAdmin.Messaging.SendResponse">
<summary>
The result of an individual send operation that was executed as part of a batch. See
<see cref="T:FirebaseAdmin.Messaging.BatchResponse"/> for more details.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.SendResponse.MessageId">
<summary>
Gets a message ID string if the send operation was successful. Otherwise returns null.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.SendResponse.Exception">
<summary>
Gets an exception if the send operation failed. Otherwise returns null.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.SendResponse.IsSuccess">
<summary>
Gets a value indicating whether the send operation was successful or not. When this property
is <c>true</c>, <see cref="P:FirebaseAdmin.Messaging.SendResponse.MessageId"/> is guaranteed to return a
non-null value. When this property is <c>false</c>,
<see cref="P:FirebaseAdmin.Messaging.SendResponse.Exception"/> is guaranteed to return a non-null value.
</summary>
</member>
<member name="T:FirebaseAdmin.Messaging.TopicManagementResponse">
<summary>
The response produced by FCM topic management operations.
</summary>
</member>
<member name="M:FirebaseAdmin.Messaging.TopicManagementResponse.#ctor(FirebaseAdmin.Messaging.InstanceIdServiceResponse)">
<summary>
Initializes a new instance of the <see cref="T:FirebaseAdmin.Messaging.TopicManagementResponse"/> class.
</summary>
<param name="instanceIdServiceResponse">The results from the response produced by FCM topic management operations.</param>
</member>
<member name="P:FirebaseAdmin.Messaging.TopicManagementResponse.SuccessCount">
<summary>
Gets the number of registration tokens that were successfully subscribed or unsubscribed.
</summary>
<returns>The number of registration tokens that were successfully subscribed or unsubscribed.</returns>
</member>
<member name="P:FirebaseAdmin.Messaging.TopicManagementResponse.FailureCount">
<summary>
Gets the number of registration tokens that could not be subscribed or unsubscribed, and resulted in an error.
</summary>
<returns>The number of failures.</returns>
</member>
<member name="P:FirebaseAdmin.Messaging.TopicManagementResponse.Errors">
<summary>
Gets a list of errors encountered while executing the topic management operation.
</summary>
<returns>A non-null list.</returns>
</member>
<member name="T:FirebaseAdmin.Messaging.Util.AnalyticsLabelChecker">
<summary>
Checker for analytics label.
</summary>
</member>
<member name="M:FirebaseAdmin.Messaging.Util.AnalyticsLabelChecker.ValidateAnalyticsLabel(System.String)">
<summary>
Checks anytytics labels an throw if not valid.
</summary>
<exception cref="T:System.ArgumentException">If analytics label does not match pattern.</exception>
<param name="analyticsLabel">Analytics label.</param>
</member>
<member name="T:FirebaseAdmin.Messaging.WebpushConfig">
<summary>
Represents the Webpush protocol options that can be included in a <see cref="T:FirebaseAdmin.Messaging.Message"/>.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.WebpushConfig.Headers">
<summary>
Gets or sets the Webpush HTTP headers. Refer
<a href="https://tools.ietf.org/html/rfc8030#section-5">
Webpush specification</a> for supported headers.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.WebpushConfig.Data">
<summary>
Gets or sets the Webpush data fields. When set, overrides any data fields set via
<see cref="P:FirebaseAdmin.Messaging.Message.Data"/>.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.WebpushConfig.Notification">
<summary>
Gets or sets the Webpush notification included in the message.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.WebpushConfig.FcmOptions">
<summary>
Gets or sets the Webpush options included in the message.
</summary>
</member>
<member name="M:FirebaseAdmin.Messaging.WebpushConfig.CopyAndValidate">
<summary>
Copies this Webpush config, and validates the content of it to ensure that it can be
serialized into the JSON format expected by the FCM service.
</summary>
</member>
<member name="T:FirebaseAdmin.Messaging.WebpushFcmOptions">
<summary>
Represents the Webpush-specific notification options that can be included in a <see cref="T:FirebaseAdmin.Messaging.Message"/>.
See <a href="https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#WebpushFcmOptions">REST
API reference</a> for a list of supported fields.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.WebpushFcmOptions.Link">
<summary>
Gets or sets the link to open when the user clicks on the notification. For all URL values, HTTPS is required.
</summary>
</member>
<member name="M:FirebaseAdmin.Messaging.WebpushFcmOptions.CopyAndValidate">
<summary>
Copies this Webpush FCM options, and validates the content of it to ensure that it can
be serialized into the JSON format expected by the FCM service.
</summary>
</member>
<member name="T:FirebaseAdmin.Messaging.WebpushNotification">
<summary>
Represents the Webpush-specific notification options that can be included in a
<see cref="T:FirebaseAdmin.Messaging.Message"/>. Supports most standard options defined in the
<a href="https://developer.mozilla.org/en-US/docs/Web/API/notification/Notification">
Web Notification specification</a>.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.WebpushNotification.Title">
<summary>
Gets or sets the title text of the notification.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.WebpushNotification.Body">
<summary>
Gets or sets the body text of the notification.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.WebpushNotification.Icon">
<summary>
Gets or sets the URL to the icon of the notification.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.WebpushNotification.Badge">
<summary>
Gets or sets the URL of the image used to represent the notification when there is not
enough space to display the notification itself.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.WebpushNotification.Data">
<summary>
Gets or sets some arbitrary data that will be included in the notification.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.WebpushNotification.Direction">
<summary>
Gets or sets the direction in which to display the notification.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.WebpushNotification.Image">
<summary>
Gets or sets the URL of an image to be displayed in the notification.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.WebpushNotification.Language">
<summary>
Gets or sets the language of the notification.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.WebpushNotification.Renotify">
<summary>
Gets or sets whether the user should be notified after a new notification replaces an
old one.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.WebpushNotification.RequireInteraction">
<summary>
Gets or sets whether the notification should remain active until the user clicks or
dismisses it, rather than closing it automatically.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.WebpushNotification.Silent">
<summary>
Gets or sets whether the notification should be silent.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.WebpushNotification.Tag">
<summary>
Gets or sets an identifying tag for the notification.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.WebpushNotification.TimestampMillis">
<summary>
Gets or sets the notification's timestamp value in milliseconds.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.WebpushNotification.Vibrate">
<summary>
Gets or sets a vibration pattern for the receiving device's vibration hardware.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.WebpushNotification.Actions">
<summary>
Gets or sets a collection of Webpush notification actions.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.WebpushNotification.CustomData">
<summary>
Gets or sets the custom key-value pairs that will be included in the
notification. This is exposed as an <see cref="T:System.Collections.Generic.IDictionary`2"/> to support
correct deserialization of custom properties.
</summary>
</member>
<member name="P:FirebaseAdmin.Messaging.WebpushNotification.DirectionString">
<summary>
Gets or sets the string representation of the <see cref="P:FirebaseAdmin.Messaging.WebpushNotification.Direction"/> property.
</summary>
</member>
<member name="M:FirebaseAdmin.Messaging.WebpushNotification.CopyAndValidate">
<summary>
Copies this Webpush notification, and validates the content of it to ensure that it can
be serialized into the JSON format expected by the FCM service.
</summary>
</member>
<member name="T:FirebaseAdmin.PlatformErrorHandler`1">
<summary>
Base class for handling HTTP error responses returned by Google Cloud Platform APIs.
See <a href="https://cloud.google.com/apis/design/errors">Errors</a> for more details on
how Google Cloud Platform APIs report back error codes and details. If this class fails
to determine an error code or message from a given API response, it falls back to the
error handling logic defined in the parent <see cref="T:FirebaseAdmin.HttpErrorHandler`1"/> class.
</summary>
</member>
<member name="T:FirebaseAdmin.Util.AdaptedListResourcesRequest`2">
<summary>
An implementation of <see cref="T:FirebaseAdmin.Util.ListResourcesRequest`1"/> that uses the
<see cref="T:FirebaseAdmin.Util.ErrorHandlingHttpClient`1"/> API to communicate with the backend server.
</summary>
</member>
<member name="T:FirebaseAdmin.Util.DeserializedResponseInfo`1">
<summary>
HTTP response and the body string read from it. Additionally also contains a
deserialized representation of the body.
</summary>
</member>
<member name="T:FirebaseAdmin.Util.ErrorHandlingHttpClient`1">
<summary>
An HTTP client wrapper that handles various exceptions by turning them into the suitable
instances of <see cref="T:FirebaseAdmin.FirebaseException"/>. Specifically, this implementation handles
low-level network exceptions, HTTP error responses (non 2xx responses), and response
deserialization exceptions.
</summary>
<typeparam name="T">Subtype of <see cref="T:FirebaseAdmin.FirebaseException"/> raised by this
HTTP client.</typeparam>
</member>
<member name="T:FirebaseAdmin.Util.ErrorHandlingHttpClientArgs`1">
<summary>
Arguments for constructing an instance of <see cref="T:FirebaseAdmin.Util.ErrorHandlingHttpClient`1"/>.
</summary>
<typeparam name="T">Subtype of <see cref="T:FirebaseAdmin.FirebaseException"/> raised by the
HTTP client constructed using these arguments.</typeparam>
</member>
<member name="T:FirebaseAdmin.Util.HttpUtils">
<summary>
A collection of utilities that can be used when making marshaling HTTP requests.
</summary>
</member>
<member name="T:FirebaseAdmin.Util.IDeserializeExceptionHandler`1">
<summary>
An interface for handling HTTP response deserialization (unmarshalling) errors.
</summary>
<typeparam name="T">Subtype of <see cref="T:FirebaseAdmin.FirebaseException"/> raised by this
error handler.</typeparam>
</member>
<member name="M:FirebaseAdmin.Util.IDeserializeExceptionHandler`1.HandleDeserializeException(System.Exception,FirebaseAdmin.Util.ResponseInfo)">
<summary>
Handles the exceptions occured while deserializing HTTP response payloads, and turns
them into appropriate instances of <see cref="T:FirebaseAdmin.FirebaseException"/>.
</summary>
<returns>A <see cref="T:FirebaseAdmin.FirebaseException"/> instance.</returns>
<param name="exception">The exception encountered during deserialization.</param>
<param name="responseInfo">The HTTP response that triggered the exception.</param>
</member>
<member name="T:FirebaseAdmin.Util.IHttpErrorResponseHandler`1">
<summary>
An interface for handling HTTP error responses returned by services.
</summary>
<typeparam name="T">Subtype of <see cref="T:FirebaseAdmin.FirebaseException"/> raised by this
error handler.</typeparam>
</member>
<member name="M:FirebaseAdmin.Util.IHttpErrorResponseHandler`1.HandleHttpErrorResponse(System.Net.Http.HttpResponseMessage,System.String)">
<summary>
Handles the HTTP error responses returned by a service, and turns them into the
appropriate instances of <see cref="T:FirebaseAdmin.FirebaseException"/>.
</summary>
<returns>A <see cref="T:FirebaseAdmin.FirebaseException"/> instance.</returns>
<param name="response">The HTTP response.</param>
<param name="body">The response payload read from the response.</param>
</member>
<member name="T:FirebaseAdmin.Util.IHttpRequestExceptionHandler`1">
<summary>
An interface for handling <see cref="T:System.Net.Http.HttpRequestException"/> instances encountered while
sending HTTP requests.
</summary>
<typeparam name="T">Subtype of <see cref="T:FirebaseAdmin.FirebaseException"/> raised by this
error handler.</typeparam>
</member>
<member name="M:FirebaseAdmin.Util.IHttpRequestExceptionHandler`1.HandleHttpRequestException(System.Net.Http.HttpRequestException)">
<summary>
Handles the exceptions occured while sending HTTP requests, and turns
them into appropriate instances of <see cref="T:FirebaseAdmin.FirebaseException"/>.
</summary>
<returns>A <see cref="T:FirebaseAdmin.FirebaseException"/> instance.</returns>
<param name="exception">The exception encountered while sending a request.</param>
</member>
<member name="T:FirebaseAdmin.Util.IHttpResponseDeserializer">
<summary>
An interface for deserializing string payloads read from HTTP response.
</summary>
</member>
<member name="M:FirebaseAdmin.Util.IHttpResponseDeserializer.Deserialize``1(System.String)">
<summary>
Deserializes an HTTP response payload into the specified type.
</summary>
<returns>The deserialized object instance.</returns>
<param name="body">The response payload to deserialize.</param>
<typeparam name="T">Type to deserialize the response into.</typeparam>
</member>
<member name="T:FirebaseAdmin.Util.IWaiter">
<summary>
An interface that enables controlling how wait operations are implemented.
This is mainly useful during unit testing.
</summary>
</member>
<member name="M:FirebaseAdmin.Util.IWaiter.Wait(System.TimeSpan,System.Threading.CancellationToken)">
<summary>
Waits for the specified time span.
</summary>
<param name="ts">Time span to wait for.</param>
<param name="cancellationToken">A cancellation token to monitor the asynchronous
operation.</param>
<returns>A task that completes when the wait is over.</returns>
</member>
<member name="T:FirebaseAdmin.Util.ListResourcesRequest`1">
<summary>
A Google client service request implementation that supports paginating through a list of
resources. This parent class implements most of the argument validation and HTTP request
marshaling logic, but leaves the actual transport behavior to be implemented by the child
classes.
</summary>
</member>
<member name="T:FirebaseAdmin.Util.ResponseInfo">
<summary>
HTTP response and the body string read from it.
</summary>
</member>
<member name="T:FirebaseAdmin.Util.RetryHttpClientInitializer">
<summary>
An HTTP client initializer that configures clients to retry failing HTTP requests on
low-level exceptions and unsuccessful HTTP responses. Retry conditions and other parameters
are configured via <see cref="T:FirebaseAdmin.Util.RetryOptions"/>. Supports exponential back-off and the
"Retry-After" header in error responses.
</summary>
</member>
<member name="T:FirebaseAdmin.Util.RetryHttpClientInitializer.RetryAfterAwareBackOffHandler">
<summary>
A <see cref="T:Google.Apis.Http.BackOffHandler"/> that retries failing HTTP requests with exponential back-off
If an HTTP error response contains the "Retry-After" header, the delay indicated in the
header takes precedence over exponential back-off. If the delay indicated in the header
is longer than <see cref="P:Google.Apis.Http.BackOffHandler.MaxTimeSpan"/>, no retries are performed.
</summary>
</member>
<member name="T:FirebaseAdmin.Util.RetryHttpClientInitializer.FactoredExponentialBackOff">
<summary>
An <see cref="T:Google.Apis.Util.IBackOff"/> that multiplies the back-off durations produced by
<see cref="T:Google.Apis.Util.ExponentialBackOff"/> with a constant factor. The factor can be set to 0
to disable exponential back-off.
</summary>
</member>
<member name="T:FirebaseAdmin.Util.RetryOptions">
<summary>
Options for customizing how failing HTTP requests should be retried.
</summary>
</member>
<member name="P:FirebaseAdmin.Util.RetryOptions.Default">
<summary>
Gets the default retry configuration for HTTP calls. Default configuration retries
HTTP 503 errors and other transport errors up to 4 times with exponential back-off.
</summary>
</member>
<member name="P:FirebaseAdmin.Util.RetryOptions.NoBackOff">
<summary>
Gets the default retry configuration with back-off disabled. Useful for testing.
</summary>
</member>
<member name="P:FirebaseAdmin.Util.RetryOptions.MaxRetries">
<summary>
Gets or sets the maximum number of retry attempts.
</summary>
</member>
<member name="P:FirebaseAdmin.Util.RetryOptions.MaxTimeSpan">
<summary>
Gets or sets the maximum time span for wait for a retry.
</summary>
</member>
<member name="P:FirebaseAdmin.Util.RetryOptions.BackOffFactor">
<summary>
Gets or sets the multiplication factor for the exponential back-off algorithm.
</summary>
</member>
<member name="P:FirebaseAdmin.Util.RetryOptions.HandleUnsuccessfulResponseFunc">
<summary>
Gets or sets the function that determines which HTTP responses should be retried.
If not specified, unsuccessful responses are not retried.
</summary>
</member>
<member name="P:FirebaseAdmin.Util.RetryOptions.HandleExceptionFunc">
<summary>
Gets or sets the function that determines which exceptions should be retried.
If not specified, exceptions are not retried.
</summary>
</member>
</members>
</doc>