Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

[Docs] Adds possible implementation of invocable class to documentation #360

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions DocsV2/docs/Scheduler/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,31 @@ scheduler

What a simple, terse and expressive syntax! Easy Peasy!

For completeness here is the possible impelmentation of the `GrabDataFromApiAndPutInDBInvocable` class:

```csharp
public class GrabDataFromApiAndPutInDBInvocable: IInvocable
{
private readonly DbContext _dbContext;
public GrabDataFromApiAndPutInDBInvocable(DbContext dbContext)
{
_dbContext = dbContext;
}
public Task Invoke()
{
//call api and save data to db
//...
_dbContext.SaveChangesAsync();
}
}
```

Make sure that your invocable *itself* is available in the service container:

```csharp
services.AddTransient<GrabDataFromApiAndPutInDBInvocable>();
```

:::tip Cancel Long-Running Invocables
Make your long-running invocable classes implement `Coravel.Invocable.ICancellableInvocable` to enable it to gracefully abort on application shutdown.

Expand Down