Skip to main content

​
Definition

Assembly: CloudNimble.EasyAF.Restier.EF6.dll Namespace: CloudNimble.EasyAF.Restier Inheritance: Microsoft.Restier.EntityFramework.EntityFrameworkApi<TContext>

​
Syntax

CloudNimble.EasyAF.Restier.EasyAFEntityFrameworkApi<TContext>

​
Summary

Provides a base implementation of an Entity Framework API for EasyAF, integrating SimpleMessageBus event publishing and logging capabilities. This class extends EntityFrameworkApi`1 and is intended to be used as a base class for APIs that require access to the current HTTP context, logging, and SimpleMessageBus publishing.

​
Type Parameters

  • TContext - The type of the DbContext used by the API.

​
Examples

public class MyApi : EasyAFEntityFrameworkApi&lt;MyDbContext&gt;
{
    public MyApi(IServiceProvider serviceProvider, IHttpContextAccessor httpContextAccessor, IMessagePublisher messagePublisher, ILogger&lt;EasyAFEntityFrameworkApi&lt;MyDbContext&gt;&gt; logger)
        : base(serviceProvider, httpContextAccessor, messagePublisher, logger)
    {
    }
}

​
Constructors

​
.ctor

Initializes a new instance of the EasyAFEntityFrameworkApi1` class.

​
Syntax

public EasyAFEntityFrameworkApi(System.IServiceProvider serviceProvider, Microsoft.AspNetCore.Http.IHttpContextAccessor httpContextAccessor, CloudNimble.SimpleMessageBus.Publish.IMessagePublisher messagePublisher, Microsoft.Extensions.Logging.ILogger<CloudNimble.EasyAF.Restier.EasyAFEntityFrameworkApi<TContext>> logger)

​
Parameters

NameTypeDescription
serviceProviderSystem.IServiceProviderThe service provider for dependency injection.
httpContextAccessorMicrosoft.AspNetCore.Http.IHttpContextAccessorThe IHttpContextAccessor for the current HTTP context.
messagePublisherCloudNimble.SimpleMessageBus.Publish.IMessagePublisherThe IMessagePublisher used for publishing messages to SimpleMessageBus.
loggerMicrosoft.Extensions.Logging.ILogger<CloudNimble.EasyAF.Restier.EasyAFEntityFrameworkApi<TContext>>The ILogger`1 instance for writing log traces.

​
Exceptions

ExceptionDescription
ArgumentNullExceptionThrown if httpContextAccessor or messagePublisher is null.

​
Properties

​
HttpContextAccessor

Gets or sets the accessor for the current HTTP context. Used to access HTTP-specific information about the current request.

​
Syntax

public Microsoft.AspNetCore.Http.IHttpContextAccessor HttpContextAccessor { get; set; }

​
Property Value

Type: Microsoft.AspNetCore.Http.IHttpContextAccessor

​
Logger

Gets or sets the ILogger`1 instance used for writing log traces.

​
Syntax

public Microsoft.Extensions.Logging.ILogger<CloudNimble.EasyAF.Restier.EasyAFEntityFrameworkApi<TContext>> Logger { get; set; }

​
Property Value

Type: Microsoft.Extensions.Logging.ILogger<CloudNimble.EasyAF.Restier.EasyAFEntityFrameworkApi<TContext>>

​
MessagePublisher

Gets or sets the IMessagePublisher used for publishing messages to SimpleMessageBus.

​
Syntax

public CloudNimble.SimpleMessageBus.Publish.IMessagePublisher MessagePublisher { get; set; }

​
Property Value

Type: CloudNimble.SimpleMessageBus.Publish.IMessagePublisher