Class InviteUriProvider
Provides functionality to generate invite URIs for user invitations.
Inheritance
object
Namespace: Umbraco.Cms.Api.Management.Security
Assembly: Umbraco.Cms.Api.Management.dll
Syntax
public class InviteUriProvider : IInviteUriProviderConstructors
View SourceInviteUriProvider(ICoreBackOfficeUserManager, IHttpContextAccessor, IHostingEnvironment)
Initializes a new instance of the InviteUriProvider class, used to generate invite URIs for user management.
Declaration
public InviteUriProvider(ICoreBackOfficeUserManager userManager, IHttpContextAccessor httpContextAccessor, IHostingEnvironment hostingEnvironment)Parameters
| Type | Name | Description |
|---|---|---|
| ICoreBackOfficeUserManager | userManager | The user manager responsible for core back office user operations. |
| IHttpContextAccessor | httpContextAccessor | Provides access to the current HTTP context. |
| IHostingEnvironment | hostingEnvironment | Provides information about the web hosting environment. |
Methods
View SourceCreateInviteUriAsync(IUser)
Asynchronously creates an invitation URI for the specified user to be invited to the system.
Declaration
public Task<Attempt<Uri, UserOperationStatus>> CreateInviteUriAsync(IUser invitee)Parameters
| Type | Name | Description |
|---|---|---|
| IUser | invitee | The user to invite. |
Returns
| Type | Description |
|---|---|
| Task<Attempt<Uri, UserOperationStatus>> | A task that represents the asynchronous operation. The task result contains an Attempt<TResult, TStatus> indicating success with the generated invitation URI, or failure with the corresponding status. |