SignalR Service
This demo shows how you can use a SignalR service to synchronize appointments across different devices. To emulate such a setup, each Scheduler on this page reads data from its own separate data store. Changes made in one control are repeated in the other and persist until the browser session has expired.
Follow the steps below to implement this functionality. Note again that this demo repeats all steps twice for the two Schedulers. Your project will have a single control and a single store.
-
Configure a CustomStore. In this demo, we use the createStore method (part of the DevExtreme.AspNet.data extension).
-
Create the Scheduler and use its dataSource property to bind it to the store instance.
-
When a push notification is received, call the store's push(changes) method to update the store's data (see the
connection.onevent handlers).
For server-side configuration, refer to the ASP.NET MVC version of this demo.
For more information about integration with push services, refer to the following help topic: Integration with Push Services.
Feel free to share demo-related thoughts here.
If you have technical questions, please create a support ticket in the DevExpress Support Center.
If you have technical questions, please create a support ticket in the DevExpress Support Center.
Thank you!
We appreciate your feedback.
We appreciate your feedback.
<template>
<div class="schedulers">
<div class="column-1">
<DxScheduler
time-zone="America/Los_Angeles"
:data-source="store1"
:current-date="currentDate"
:views="views"
:height="600"
:start-day-hour="9"
:end-day-hour="19"
:remote-filtering="true"
current-view="day"
date-serialization-format="yyyy-MM-ddTHH:mm:ssZ"
text-expr="Text"
description-expr="Description"
start-date-expr="StartDate"
end-date-expr="EndDate"
all-day-expr="AllDay"
/>
</div>
<div class="column-2">
<DxScheduler
time-zone="America/Los_Angeles"
:data-source="store2"
:current-date="currentDate"
:views="views"
:height="600"
:start-day-hour="9"
:end-day-hour="19"
:remote-filtering="true"
current-view="day"
date-serialization-format="yyyy-MM-ddTHH:mm:ssZ"
text-expr="Text"
start-date-expr="StartDate"
end-date-expr="EndDate"
all-day-expr="AllDay"
/>
</div>
</div>
</template>
<script>
import DxScheduler from 'devextreme-vue/scheduler';
import * as AspNetData from 'devextreme-aspnet-data-nojquery';
import { HubConnectionBuilder, HttpTransportType } from '@aspnet/signalr';
const BASE_PATH = 'https://js.devexpress.com/Demos/NetCore/';
const url = `${BASE_PATH}api/SchedulerSignalR`;
const createStore = () => AspNetData.createStore({
key: 'AppointmentId',
loadUrl: url,
insertUrl: url,
updateUrl: url,
deleteUrl: url,
onBeforeSend(method, ajaxOptions) {
ajaxOptions.xhrFields = { withCredentials: true };
},
});
const store1 = createStore();
const store2 = createStore();
const connection = new HubConnectionBuilder()
.withUrl(`${BASE_PATH}schedulerSignalRHub`, {
skipNegotiation: true,
transport: HttpTransportType.WebSockets,
})
.build();
connection
.start()
.then(() => {
connection.on('update', (key, data) => {
store1.push([{ type: 'update', key, data }]);
store2.push([{ type: 'update', key, data }]);
});
connection.on('insert', (data) => {
store1.push([{ type: 'insert', data }]);
store2.push([{ type: 'insert', data }]);
});
connection.on('remove', (key) => {
store1.push([{ type: 'remove', key }]);
store2.push([{ type: 'remove', key }]);
});
});
export default {
components: {
DxScheduler,
},
data() {
return {
views: ['day', 'workWeek'],
currentDate: new Date(2021, 3, 27),
store1,
store2,
};
},
};
</script>
<style scoped>
.schedulers {
display: flex;
}
.column-1 {
padding-right: 5px;
}
.column-2 {
padding-left: 5px;
}
.dx-scheduler-small .dx-scheduler-view-switcher.dx-tabs {
display: table;
}
</style>
import { createApp } from 'vue';
import App from './App.vue';
createApp(App).mount('#app');
<!DOCTYPE html>
<html>
<head>
<title>DevExtreme Demo</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0" />
<link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/23.1.5/css/dx.light.css" />
<script src="../signalr-session-id.js"></script>
<script src="https://unpkg.com/core-js@2.6.12/client/shim.min.js"></script>
<script src="https://unpkg.com/systemjs@0.21.3/dist/system.js"></script>
<script type="text/javascript" src="config.js"></script>
<script type="text/javascript">
System.import("./index.js");
</script>
</head>
<body class="dx-viewport">
<div class="demo-container">
<div id="app"> </div>
</div>
</body>
</html>
window.config = {
transpiler: 'plugin-babel',
meta: {
'*.vue': {
loader: 'vue-loader',
},
'*.ts': {
loader: 'demo-ts-loader',
},
'*.svg': {
loader: 'svg-loader',
},
'devextreme/localization.js': {
'esModule': true,
},
'devextreme-aspnet-data-nojquery': {
'esModule': true,
},
},
paths: {
'root:': '../../../../../',
'npm:': 'https://unpkg.com/',
},
map: {
'vue': 'npm:vue@3.3.4/dist/vue.esm-browser.js',
'vue-loader': 'npm:dx-systemjs-vue-browser@1.1.1/index.js',
'demo-ts-loader': 'root:utils/demo-ts-loader.js',
'svg-loader': 'root:utils/svg-loader.js',
'@aspnet/signalr': 'npm:@aspnet/signalr@1.0.27/dist/cjs',
'tslib': 'npm:tslib@2.3.1/tslib.js',
'devextreme-aspnet-data-nojquery': 'npm:devextreme-aspnet-data-nojquery@2.9.0/index.js',
'mitt': 'npm:mitt/dist/mitt.umd.js',
'rrule': 'npm:rrule@2.6.4/dist/es5/rrule.js',
'luxon': 'npm:luxon@1.28.1/build/global/luxon.min.js',
'es6-object-assign': 'npm:es6-object-assign@1.1.0',
'devextreme': 'npm:devextreme@23.1.5/cjs',
'devextreme-vue': 'npm:devextreme-vue@23.1.5',
'jszip': 'npm:jszip@3.7.1/dist/jszip.min.js',
'devextreme-quill': 'npm:devextreme-quill@1.6.2/dist/dx-quill.min.js',
'devexpress-diagram': 'npm:devexpress-diagram@2.2.1/dist/dx-diagram.js',
'devexpress-gantt': 'npm:devexpress-gantt@4.1.48/dist/dx-gantt.js',
'@devextreme/runtime': 'npm:@devextreme/runtime@3.0.11',
'inferno': 'npm:inferno@7.4.11/dist/inferno.min.js',
'inferno-compat': 'npm:inferno-compat/dist/inferno-compat.min.js',
'inferno-create-element': 'npm:inferno-create-element@7.4.11/dist/inferno-create-element.min.js',
'inferno-dom': 'npm:inferno-dom/dist/inferno-dom.min.js',
'inferno-hydrate': 'npm:inferno-hydrate@7.4.11/dist/inferno-hydrate.min.js',
'inferno-clone-vnode': 'npm:inferno-clone-vnode/dist/inferno-clone-vnode.min.js',
'inferno-create-class': 'npm:inferno-create-class/dist/inferno-create-class.min.js',
'inferno-extras': 'npm:inferno-extras/dist/inferno-extras.min.js',
'plugin-babel': 'npm:systemjs-plugin-babel@0.0.25/plugin-babel.js',
'systemjs-babel-build': 'npm:systemjs-plugin-babel@0.0.25/systemjs-babel-browser.js',
// Prettier
'prettier/standalone': 'npm:prettier@2.8.4/standalone.js',
'prettier/parser-html': 'npm:prettier@2.8.4/parser-html.js',
},
packages: {
'devextreme-vue': {
main: 'index.js',
},
'devextreme': {
defaultExtension: 'js',
},
'devextreme/events/utils': {
main: 'index',
},
'devextreme/events': {
main: 'index',
},
'@aspnet/signalr': {
main: 'index.js',
defaultExtension: 'js',
},
'es6-object-assign': {
main: './index.js',
defaultExtension: 'js',
},
},
packageConfigPaths: [
'npm:@devextreme/*/package.json',
'npm:@devextreme/runtime@3.0.11/inferno/package.json',
],
babelOptions: {
sourceMaps: false,
stage0: true,
},
};
System.config(window.config);
using DevExtreme.AspNet.Data;
using DevExtreme.AspNet.Mvc;
using DevExtreme.MVC.Demos.Hubs;
using DevExtreme.MVC.Demos.Models;
using Microsoft.AspNet.SignalR;
using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Net.Http.Formatting;
using System.Web;
using System.Web.Http;
namespace DevExtreme.MVC.Demos.Controllers.ApiControllers {
public class SchedulerSignalRController : ApiController {
InMemoryAppointmentsDataContext _data = new InMemoryAppointmentsDataContext();
IHubContext hubContext;
public SchedulerSignalRController() {
hubContext = GlobalHost.ConnectionManager.GetHubContext<SchedulerSignalRHub>();
}
[HttpGet]
public HttpResponseMessage Get(DataSourceLoadOptions loadOptions) {
return Request.CreateResponse(DataSourceLoader.Load(_data.Appointments, loadOptions));
}
[HttpPost]
public HttpResponseMessage Post(FormDataCollection form) {
var values = form.Get("values");
var newAppointment = new Appointment();
JsonConvert.PopulateObject(values, newAppointment);
Validate(newAppointment);
if(!ModelState.IsValid)
return Request.CreateErrorResponse(HttpStatusCode.BadRequest, ModelState.GetFullErrorMessage());
_data.Appointments.Add(newAppointment);
_data.SaveChanges();
var groupName = GetGroupName();
if(groupName != null) {
hubContext.Clients.Group(GetGroupName()).insert(newAppointment);
}
return Request.CreateResponse(HttpStatusCode.Created);
}
[HttpPut]
public HttpResponseMessage Put(FormDataCollection form) {
var key = Convert.ToInt32(form.Get("key"));
var values = form.Get("values");
var appointment = _data.Appointments.First(a => a.AppointmentId == key);
JsonConvert.PopulateObject(values, appointment);
Validate(appointment);
if(!ModelState.IsValid)
return Request.CreateErrorResponse(HttpStatusCode.BadRequest, ModelState.GetFullErrorMessage());
_data.SaveChanges();
var groupName = GetGroupName();
if(groupName != null) {
hubContext.Clients.Group(GetGroupName()).update(key, appointment);
}
return Request.CreateResponse(HttpStatusCode.OK);
}
[HttpDelete]
public void Delete(FormDataCollection form) {
var key = Convert.ToInt32(form.Get("key"));
var appointment = _data.Appointments.First(a => a.AppointmentId == key);
_data.Appointments.Remove(appointment);
_data.SaveChanges();
var groupName = GetGroupName();
if(groupName != null) {
hubContext.Clients.Group(GetGroupName()).remove(key);
}
}
string GetGroupName() {
var cookie = Request.Headers.GetCookies(SchedulerSignalRHub.GroupIdKey).FirstOrDefault();
if(cookie != null) {
return cookie[SchedulerSignalRHub.GroupIdKey].Value;
}
return null;
}
}
}
using System;
using System.Threading.Tasks;
using System.Web;
using Microsoft.AspNet.SignalR;
namespace DevExtreme.MVC.Demos.Hubs {
public class SchedulerSignalRHub : Hub {
public static string GroupIdKey = "dx-SchedulerSignalRHub-groupId";
private static readonly Random random = new Random();
public override Task OnConnected() {
Cookie cookie;
Context.RequestCookies.TryGetValue(GroupIdKey, out cookie);
string groupId;
if(cookie != null) {
groupId = cookie.Value;
} else {
groupId = random.Next(0, int.MaxValue).ToString();
var newCookie = new HttpCookie(GroupIdKey, groupId);
Context.Request.GetHttpContext().Response.Cookies.Add(newCookie);
}
Groups.Add(Context.ConnectionId, groupId);
return base.OnConnected();
}
}
}