Firestore API - Class ServiceCollectionExtensions (3.12.0)

Version latest

• 3.12.0 (latest)
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.1
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.5.0
• 2.4.0
• 2.3.1

public static class ServiceCollectionExtensions

Reference documentation and code samples for the Firestore API class ServiceCollectionExtensions.

Provides extension methods to configure dependency injection with Firestore.

Inheritance

object > ServiceCollectionExtensions

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Microsoft.Extensions.DependencyInjection

Assembly

Google.Cloud.Firestore.dll

Methods

AddFirestoreDb(IServiceCollection, Action<FirestoreDbBuilder>)

public static IServiceCollection AddFirestoreDb(this IServiceCollection services, Action<FirestoreDbBuilder> action)

Adds a singleton FirestoreDb to the IServiceCollection as customized by the action.

Parameters
Name	Description
services	IServiceCollection The IServiceCollection to add the singleton client to.
action	ActionFirestoreDbBuilder An action to invoke on the FirestoreDbBuilder for configuring the FirestoreDb. This is invoked before services are used. Must not be null and must set at least ProjectId.

Returns
Type	Description
IServiceCollection	The updated IServiceCollection, for method chaining.

AddFirestoreDb(IServiceCollection, Action<IServiceProvider, FirestoreDbBuilder>)

public static IServiceCollection AddFirestoreDb(this IServiceCollection services, Action<IServiceProvider, FirestoreDbBuilder> action)

Adds a singleton FirestoreDb to the IServiceCollection as customized by the action.

Parameters
Name	Description
services	IServiceCollection The IServiceCollection to add the singleton client to.
action	ActionSystem.IServiceProviderFirestoreDbBuilder An action to invoke on the FirestoreDbBuilder for configuring the FirestoreDb. This is invoked before services are used. Must not be null and must set at least ProjectId.

Returns
Type	Description
IServiceCollection	The updated IServiceCollection, for method chaining.

AddFirestoreDb(IServiceCollection, string)

public static IServiceCollection AddFirestoreDb(this IServiceCollection services, string projectId)

Adds a singleton FirestoreDb for with the specified project ID, using default settings to the IServiceCollection.

Parameters
Name	Description
services	IServiceCollection The IServiceCollection to add the singleton client to.
projectId	string The project ID. Must not be null.

Returns
Type	Description
IServiceCollection	The updated IServiceCollection, for method chaining.