Skip to content

Ammends SignalR docs to be simpier as the umbraco path can not be con… #7039

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
merged 4 commits into from
Apr 28, 2025
Merged

Ammends SignalR docs to be simpier as the umbraco path can not be con… #7039

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9b521d4
Ammends SignalR docs to be simpier as the umbraco path can not be con…
warrenbuckley Apr 23, 2025
e0a0289
Merge branch 'umbraco:main' into signalr-v13-update
warrenbuckley Apr 24, 2025
36eb2e4
Updates all other versions of the SignalR doc as they are greater tha…
warrenbuckley Apr 24, 2025
1e36e83
Rerun GitBook checks
sofietoft Apr 28, 2025
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
57 changes: 6 additions & 51 deletions 10/umbraco-cms/implementation/custom-routing/signalR.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,53 +34,9 @@ public class TestHub : Hub<ITestHubEvents>
}
```

## Define a custom route

Next up, is defining a custom route. For this, we are going to use a `IAreaRoutes` and the base umbrace backend path so we dont have to reserve another path in the settings.

```csharp
using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.DependencyInjection;
using Umbraco.Cms.Core.Composing;
using Umbraco.Cms.Core.DependencyInjection;
using Umbraco.Cms.Web.Common.ApplicationBuilder;
using Umbraco.Extensions;

public class TestHubRoutes : IAreaRoutes
{
private readonly IRuntimeState _runtimeState;
private readonly string _umbracoPathSegment;

public TestHubRoutes(
IOptions<GlobalSettings> globalSettings,
IHostingEnvironment hostingEnvironment,
IRuntimeState runtimeState)
{
_runtimeState = runtimeState;
_umbracoPathSegment = globalSettings.Value.GetUmbracoMvcArea(hostingEnvironment);
}

public void CreateRoutes(IEndpointRouteBuilder endpoints)
{
switch (_runtimeState.Level)
{
case Umbraco.Cms.Core.RuntimeLevel.Run:
endpoints.MapHub<TestHub>(GetTestHubRoute());
break;
}

}

public string GetTestHubRoute()
{
return $"/{_umbracoPathSegment}/{nameof(TestHub)}";
}
}
```

### Add the routing to the Umbraco Composer

Last step in the setup is registering our custom route:
The next step in the setup is registering our custom route:

```csharp
using Microsoft.AspNetCore.Builder;
Expand All @@ -101,18 +57,17 @@ public class TestHubComposer : IComposer
builder.Services.AddSignalR();
}

// next is adding the routes we defined earlier
builder.Services.AddUnique<TestHubRoutes>();
builder.Services.Configure<UmbracoPipelineOptions>(options =>
{
options.AddFilter(new UmbracoPipelineFilter(
"test",
endpoints: applicationBuilder =>
"Signalr",
endpoints: applicationBuilder =>
{
applicationBuilder.UseEndpoints(e =>
{
var hubRoutes = applicationBuilder.ApplicationServices.GetRequiredService<TestHubRoutes>();
hubRoutes.CreateRoutes(e);
e.MapHub<TestHub>($"/umbraco/{nameof(TestHub)}");

// Register more SignalR hubs or routes here...
});
}
));
Expand Down
57 changes: 6 additions & 51 deletions 13/umbraco-cms/implementation/custom-routing/signalR.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,53 +34,9 @@ public class TestHub : Hub<ITestHubEvents>
}
```

## Define a custom route

Next up, is defining a custom route. For this, we are going to use a `IAreaRoutes` and the base umbrace backend path so we dont have to reserve another path in the settings.

```csharp
using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.DependencyInjection;
using Umbraco.Cms.Core.Composing;
using Umbraco.Cms.Core.DependencyInjection;
using Umbraco.Cms.Web.Common.ApplicationBuilder;
using Umbraco.Extensions;

public class TestHubRoutes : IAreaRoutes
{
private readonly IRuntimeState _runtimeState;
private readonly string _umbracoPathSegment;

public TestHubRoutes(
IOptions<GlobalSettings> globalSettings,
IHostingEnvironment hostingEnvironment,
IRuntimeState runtimeState)
{
_runtimeState = runtimeState;
_umbracoPathSegment = globalSettings.Value.GetUmbracoMvcArea(hostingEnvironment);
}

public void CreateRoutes(IEndpointRouteBuilder endpoints)
{
switch (_runtimeState.Level)
{
case Umbraco.Cms.Core.RuntimeLevel.Run:
endpoints.MapHub<TestHub>(GetTestHubRoute());
break;
}

}

public string GetTestHubRoute()
{
return $"/{_umbracoPathSegment}/{nameof(TestHub)}";
}
}
```

### Add the routing to the Umbraco Composer

Last step in the setup is registering our custom route:
The next step in the setup is registering our custom route:

```csharp
using Microsoft.AspNetCore.Builder;
Expand All @@ -101,18 +57,17 @@ public class TestHubComposer : IComposer
builder.Services.AddSignalR();
}

// next is adding the routes we defined earlier
builder.Services.AddUnique<TestHubRoutes>();
builder.Services.Configure<UmbracoPipelineOptions>(options =>
{
options.AddFilter(new UmbracoPipelineFilter(
"test",
endpoints: applicationBuilder =>
"Signalr",
endpoints: applicationBuilder =>
{
applicationBuilder.UseEndpoints(e =>
{
var hubRoutes = applicationBuilder.ApplicationServices.GetRequiredService<TestHubRoutes>();
hubRoutes.CreateRoutes(e);
e.MapHub<TestHub>($"/umbraco/{nameof(TestHub)}");

// Register more SignalR hubs or routes here...
});
}
));
Expand Down
59 changes: 7 additions & 52 deletions 14/umbraco-cms/implementation/custom-routing/signalR.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: "Umbraco ships with signalR installed, find out how to add your own hub(s) to the existing setup"
description: "Umbraco ships with SignalR installed, find out how to add your own hub(s) to the existing setup"
---

# Adding a hub with SignalR and Umbraco
Expand Down Expand Up @@ -34,53 +34,9 @@ public class TestHub : Hub<ITestHubEvents>
}
```

## Define a custom route

Next up, is defining a custom route. For this, we are going to use a `IAreaRoutes` and the base umbrace backend path so we dont have to reserve another path in the settings.

```csharp
using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.DependencyInjection;
using Umbraco.Cms.Core.Composing;
using Umbraco.Cms.Core.DependencyInjection;
using Umbraco.Cms.Web.Common.ApplicationBuilder;
using Umbraco.Extensions;

public class TestHubRoutes : IAreaRoutes
{
private readonly IRuntimeState _runtimeState;
private readonly string _umbracoPathSegment;

public TestHubRoutes(
IOptions<GlobalSettings> globalSettings,
IHostingEnvironment hostingEnvironment,
IRuntimeState runtimeState)
{
_runtimeState = runtimeState;
_umbracoPathSegment = globalSettings.Value.GetUmbracoMvcArea(hostingEnvironment);
}

public void CreateRoutes(IEndpointRouteBuilder endpoints)
{
switch (_runtimeState.Level)
{
case Umbraco.Cms.Core.RuntimeLevel.Run:
endpoints.MapHub<TestHub>(GetTestHubRoute());
break;
}

}

public string GetTestHubRoute()
{
return $"/{_umbracoPathSegment}/{nameof(TestHub)}";
}
}
```

### Add the routing to the Umbraco Composer

Last step in the setup is registering our custom route:
The next step in the setup is registering our custom route:

```csharp
using Microsoft.AspNetCore.Builder;
Expand All @@ -101,18 +57,17 @@ public class TestHubComposer : IComposer
builder.Services.AddSignalR();
}

// next is adding the routes we defined earlier
builder.Services.AddUnique<TestHubRoutes>();
builder.Services.Configure<UmbracoPipelineOptions>(options =>
{
options.AddFilter(new UmbracoPipelineFilter(
"test",
endpoints: applicationBuilder =>
"Signalr",
endpoints: applicationBuilder =>
{
applicationBuilder.UseEndpoints(e =>
{
var hubRoutes = applicationBuilder.ApplicationServices.GetRequiredService<TestHubRoutes>();
hubRoutes.CreateRoutes(e);
e.MapHub<TestHub>($"/umbraco/{nameof(TestHub)}");

// Register more SignalR hubs or routes here...
});
}
));
Expand Down
57 changes: 6 additions & 51 deletions 15/umbraco-cms/implementation/custom-routing/signalR.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,53 +34,9 @@ public class TestHub : Hub<ITestHubEvents>
}
```

## Define a custom route

Next up, is defining a custom route. Use `IAreaRoutes` and the base Umbraco backend path so there's no need to reserve another path in the settings.

```csharp
using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.DependencyInjection;
using Umbraco.Cms.Core.Composing;
using Umbraco.Cms.Core.DependencyInjection;
using Umbraco.Cms.Web.Common.ApplicationBuilder;
using Umbraco.Extensions;

public class TestHubRoutes : IAreaRoutes
{
private readonly IRuntimeState _runtimeState;
private readonly string _umbracoPathSegment;

public TestHubRoutes(
IOptions<GlobalSettings> globalSettings,
IHostingEnvironment hostingEnvironment,
IRuntimeState runtimeState)
{
_runtimeState = runtimeState;
_umbracoPathSegment = globalSettings.Value.GetUmbracoMvcArea(hostingEnvironment);
}

public void CreateRoutes(IEndpointRouteBuilder endpoints)
{
switch (_runtimeState.Level)
{
case Umbraco.Cms.Core.RuntimeLevel.Run:
endpoints.MapHub<TestHub>(GetTestHubRoute());
break;
}

}

public string GetTestHubRoute()
{
return $"/{_umbracoPathSegment}/{nameof(TestHub)}";
}
}
```

### Add the routing to the Umbraco Composer

Last step in the setup is registering our custom route:
The next step in the setup is registering our custom route:

```csharp
using Microsoft.AspNetCore.Builder;
Expand All @@ -101,18 +57,17 @@ public class TestHubComposer : IComposer
builder.Services.AddSignalR();
}

// next is adding the routes we defined earlier
builder.Services.AddUnique<TestHubRoutes>();
builder.Services.Configure<UmbracoPipelineOptions>(options =>
{
options.AddFilter(new UmbracoPipelineFilter(
"test",
endpoints: applicationBuilder =>
"Signalr",
endpoints: applicationBuilder =>
{
applicationBuilder.UseEndpoints(e =>
{
var hubRoutes = applicationBuilder.ApplicationServices.GetRequiredService<TestHubRoutes>();
hubRoutes.CreateRoutes(e);
e.MapHub<TestHub>($"/umbraco/{nameof(TestHub)}");

// Register more SignalR hubs or routes here...
});
}
));
Expand Down
Loading