• Use

    • Guides
    • API
    • SDK
    • Plugins
    • How to
  • Extend

    • Write Plugins
    • Write Protocols

1

2

  • Essentials
  • Getting started
    • Error Handling
      • Events
        • Offline Tools
          • Realtime notifications
            • Core classes
            • Kuzzle
              • Introduction
              • Constructor
              • Getters
              • Setters
              • addListener
              • connect
              • disconnect
              • flushQueue
              • playQueue
              • query
              • startQueuing
              • stopQueuing
            • SearchResult
              • Introduction
              • Getters
              • Setters
              • next
            • User
              • Introduction
              • Getters
              • Setters
            • UserRight
              • Introduction
              • Getters
              • Setters
            • Protocols
            • WebSocket
              • Constructor
              • Introduction
              • Getters
              • Setters
              • addListener
              • cancelSubs
              • close
              • connect
              • emitEvent
              • getHost
              • getState
              • listenerCount
              • once
              • registerSub
              • removeAllListeners
              • removeListener
              • send
              • unregisterSub
            • Virtual Classes
            • Protocol
              • addListener
              • cancelSubs
              • close
              • connect
              • emitEvent
              • getHost
              • getState
              • listenerCount
              • once
              • registerSub
              • removeAllListeners
              • removeListener
              • send
              • unregisterSub
            • Controllers
            • auth
              • checkToken
              • createMyCredentials
              • credentialsExist
              • deleteMyCredentials
              • getCurrentUser
              • getMyCredentials
              • getMyRights
              • getStrategies
              • login
              • logout
              • updateMyCredentials
              • updateSelf
              • validateMyCredentials
            • collection
              • create
              • deleteSpecifications
              • exists
              • getMapping
              • getSpecifications
              • list
              • searchSpecifications
              • truncate
              • updateMapping
              • updateSpecifications
              • validateSpecifications
            • document
              • count
              • create
              • createOrReplace
              • delete
              • deleteByQuery
              • get
              • mCreate
              • mCreateOrReplace
              • mDelete
              • mGet
              • mReplace
              • mUpdate
              • replace
              • search
              • update
              • validate
            • index
              • create
              • delete_
              • exists
              • getAutoRefresh
              • list
              • mDelete
              • refresh
              • refreshInternal
              • setAutoRefresh
            • realtime
              • count
              • publish
              • subscribe
              • unsubscribe
            • server
              • adminExists
              • getAllStats
              • getConfig
              • getLastStats
              • getStats
              • info
              • now
            Kuzzle logo Select an SDK
            • API 2.x
            • js Javascript 7.x
            • csharp C# 2.x
            • Github
              Contribute to Kuzzle projects
            • Stack Overflow
              Ask a question
            • Gitter
              Chat with the community and Kuzzle developers
            • Youtube
              Check out our tutorial videos
            ©2019 - Kuzzle.io
            Apache 2.0 License