Skip to content

adding get actor reminder API in docs #1113

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
halspang merged 3 commits into from
Jul 21, 2023
Merged

adding get actor reminder API in docs #1113

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f657c6
adding get actor reminder API in docs
shivamkm07 Jun 13, 2023
480db8d
Merge branch 'master' into update_docs
halspang Jul 6, 2023
e8c642b
Merge branch 'master' into update_docs
halspang Jul 21, 2023
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
10 changes: 10 additions & 0 deletions daprdocs/content/en/dotnet-sdk-docs/dotnet-actors/dotnet-actors-howto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ Define `IMyActor` interface and `MyData` data object. Paste the following code i

```csharp
using Dapr.Actors;
using Dapr.Actors.Runtime;
using System.Threading.Tasks;

namespace MyActor.Interfaces
Expand All @@ -91,6 +92,7 @@ namespace MyActor.Interfaces
Task<MyData> GetDataAsync();
Task RegisterReminder();
Task UnregisterReminder();
Task<IActorReminder> GetReminder();
Task RegisterTimer();
Task UnregisterTimer();
}
Expand Down Expand Up @@ -219,6 +221,14 @@ namespace MyActorService
TimeSpan.FromSeconds(5)); // Time interval between reminder invocations after the first invocation
}

/// <summary>
/// Get MyReminder reminder details with the actor
/// </summary>
public async Task<IActorReminder> GetReminder()
{
await this.GetReminderAsync("MyReminder");
}
Comment on lines +227 to +230
Copy link
Copy Markdown
Contributor

@halspang halspang Jun 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personal preference, we should include this with an input string as an example. Otherwise people may think it can only take hardcoded names.

Copy link
Copy Markdown
Contributor Author

@shivamkm07 shivamkm07 Jul 4, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I kept this as to be consistent with other APIs where the reminder-name is hardcoded in RegisterReminder and UnregisterReminder. Both of them take the reminder name as inputs as well, similar to GetReminder.
https://github.com/dapr/dotnet-sdk/pull/1113/files/53876be8bf17e98bb9011094ab39623dc0be74e4#diff-763693d0f8815d098d3c9e4f284e8909335c17756bf549eef7abc550c3151a63L213
https://github.com/dapr/dotnet-sdk/pull/1113/files/53876be8bf17e98bb9011094ab39623dc0be74e4#diff-763693d0f8815d098d3c9e4f284e8909335c17756bf549eef7abc550c3151a63L225

It's also same as kept in examples: https://github.com/dapr/dotnet-sdk/blob/master/test/Dapr.E2E.Test.App/Actors/ReminderActor.cs

Copy link
Copy Markdown
Contributor Author

@shivamkm07 shivamkm07 Jul 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this okay @halspang ?


/// <summary>
/// Unregister MyReminder reminder with the actor
/// </summary>
Expand Down