DoneJS StealJS jQuery++ FuncUnit DocumentJS
3.14.1
5.0.0 4.3.0 2.3.35
  • About
  • Guides
  • API Docs
  • Community
  • Contributing
  • Bitovi
    • Bitovi.com
    • Blog
    • Design
    • Development
    • Training
    • Open Source
    • About
    • Contact Us
  • About
  • Guides
  • API Docs
    • Observables
      • can-compute
      • can-define
      • can-define/list/list
      • can-define/map/map
      • can-define-stream
      • can-define-stream-kefir
      • can-event
      • can-event/async/async
      • can-event/batch/batch
      • can-event/lifecycle/lifecycle
      • can-kefir
      • can-list
      • can-map
      • can-map-backup
      • can-map-define
      • can-observation
      • can-observe
      • can-simple-map
      • can-simple-observable
      • can-stream
      • can-stream-kefir
    • Data Modeling
      • can-connect
      • can-connect-cloneable
      • can-connect-feathers
      • can-connect-ndjson
      • can-connect-signalr
        • options
          • signalR
        • methods
          • init
        • data interface
          • createData
          • destroyData
          • getData
          • getListData
          • updateData
      • can-fixture
      • can-fixture-socket
      • can-ndjson-stream
      • can-set
    • Views
      • can-component
      • can-ejs
      • can-element
      • can-react-component
      • can-stache
      • can-stache/helpers/route
      • can-stache-bindings
      • can-stache-converters
      • can-view-autorender
      • can-view-callbacks
      • can-view-href
      • can-view-import
      • can-view-live
      • can-view-model
      • can-view-nodelist
      • can-view-parser
      • can-view-scope
      • can-view-target
      • react-view-model
      • react-view-model/component
      • steal-stache
    • Routing
      • can-deparam
      • can-param
      • can-route
      • can-route-pushstate
    • JS Utilities
      • can-assign
      • can-define-lazy-value
      • can-globals
      • can-key-tree
      • can-make-map
      • can-parse-uri
      • can-string
      • can-string-to-any
      • can-util
      • can-zone
      • can-zone-storage
    • DOM Utilities
      • can-ajax
      • can-attribute-encoder
      • can-control
      • can-dom-events
      • can-event-dom-enter
      • can-event-dom-radiochange
      • can-jquery
    • Data Validation
      • can-define-validate-validatejs
      • can-validate
      • can-validate-interface
      • can-validate-legacy
      • can-validate-validatejs
    • Typed Data
      • can-cid
      • can-construct
      • can-construct-super
      • can-namespace
      • can-reflect
      • can-reflect-promise
      • can-types
    • Polyfills
      • can-symbol
      • can-vdom
    • Core
    • Infrastructure
      • can-global
      • can-test-helpers
    • Ecosystem
    • Legacy
  • Community
  • Contributing
  • GitHub
  • Twitter
  • Chat
  • Forum
  • News
Bitovi

signalR

  • Edit on GitHub

The options object passed to the can-connect factory function that generates the can-connect-signalr connection.

Object

Below is an example of a fully configured signalR options object:

signalR: {
    url: 'http://test.com',
    name: 'MessageHub',
    createName: 'postMessage', 
    createdName: 'messagePosted',
    updateName: 'updateThis',
    updatedName: 'thingUpdated',
    destroyName: 'obliterateIt',
    destroyedName: 'itIsGone',
    getListName: 'gimmeGimme',
    listDataName: 'gotEmAll',
    getName: 'wannaWanna',
    dataName: 'gotIt'
}

Options

  • url {String}:

    The url of your SignalR hub.

  • name {String}:

    The name of your SignalR hub.

  • createName {String}:

    The name of the method on your SignalR hub you will use to create object instances. can-connect-signalr provides a default name for this method (hub name + "Create"). Use this property to overwrite that name.

  • createdName {String}:

    The name of the RPC listener your SignalR proxy you will use to listen for objects created on your hub. can-connect-signalr provides a default name for this method (hub name + "Created"). Use this property to overwrite that name.

  • updateName {String}:

    The name of the method on your SignalR hub you will use to update object instances. can-connect-signalr provides a default name for this method (hub name + "Update"). Use this property to overwrite that name.

  • updatedName {String}:

    The name of the RPC listener your SignalR proxy you will use to listen for objects updated on your hub. can-connect-signalr provides a default name for this method (hub name + "Updated"). Use this property to overwrite that name.

  • destroyName {String}:

    The name of the method on your SignalR hub you will use to destroy object instances. can-connect-signalr provides a default name for this method (hub name + "Destroy"). Use this property to overwrite that name.

  • destroyedName {String}:

    The name of the RPC listener your SignalR proxy you will use to listen for objects deleted from your hub. can-connect-signalr provides a default name for this method (hub name + "Destroyed"). Use this property to overwrite that name.

  • getListName {String}:

    The name of the method on your SignalR hub you will use to get a list of object instances. can-connect-signalr provides a default name for this method (hub name + "GetList"). Use this property to overwrite that name.

  • listDataName {String}:

    The name of the RPC listener your SignalR proxy you will use to listen for object lists retrieved from your hub. can-connect-signalr provides a default name for this method (hub name + "ListData"). Use this property to overwrite that name.

  • getName {String}:

    The name of the method on your SignalR hub you will use to get object instances. can-connect-signalr provides a default name for this method (hub name + "Get"). Use this property to overwrite that name.

  • dataName {String}:

    The name of the RPC listener your SignalR proxy you will use to listen for objects retrieved from your hub. can-connect-signalr provides a default name for this method (hub name + "Data"). Use this property to overwrite that name.

CanJS is part of DoneJS. Created and maintained by the core DoneJS team and Bitovi. Currently 3.14.1.

On this page

Get help

  • Chat with us
  • File an issue
  • Ask questions
  • Read latest news