• Use

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

    • Write Plugins
    • Write Protocols

1

2

  • Essentials
  • Error Handling
    • Events
      • Classes
      • Kuzzle
        • Kuzzle
        • addListener
        • checkToken
        • collection
        • connect
        • createIndex
        • createMyCredentials
        • deleteMyCredentials
        • disconnect
        • flushQueue
        • getAllStatistics
        • getAutoRefresh
        • getJwtToken
        • getMyCredentials
        • getMyRights
        • getServerInfo
        • getStatistics
        • listCollections
        • listIndexes
        • login
        • logout
        • memoryStorage
        • now
        • query
        • refreshIndex
        • removeAllListeners
        • removeListener
        • replayQueue
        • security
        • setAutoRefresh
        • setDefaultIndex
        • setHeaders
        • setJwtToken
        • startQueuing
        • stopQueuing
        • unsetJwtToken
        • updateMyCredentials
        • updateSelf
        • validateMyCredentials
        • whoAmI
      • Collection
        • constructor
        • collectionMapping
        • count
        • create
        • createDocument
        • deleteDocument
        • deleteSpecifications
        • document
        • fetchDocument
        • getMapping
        • getSpecifications
        • mcreateDocument
        • mcreateOrReplaceDocument
        • mdeleteDocument
        • mgetDocument
        • mreplaceDocument
        • mupdateDocument
        • publishMessage
        • replaceDocument
        • scroll
        • scrollSpecifications
        • search
        • searchSpecifications
        • setHeaders
        • truncate
        • updateDocument
        • updateSpecifications
        • validateSpecifications
      • CollectionMapping
        • constructor
        • apply
        • refresh
        • set
        • setHeaders
      • Document
        • constructor
        • delete
        • exists
        • publish
        • refresh
        • save
        • setContent
        • setHeaders
      • MemoryStorage
        • constructor
        • append
        • bitcount
        • bitop
        • bitpos
        • dbsize
        • decr
        • decrby
        • del
        • exists
        • expire
        • expireat
        • flushdb
        • geoadd
        • geodist
        • geohash
        • geopos
        • georadius
        • georadiusbymember
        • get
        • getbit
        • getrange
        • getset
        • hdel
        • hexists
        • hget
        • hgetall
        • hincrby
        • hincrbyfloat
        • hkeys
        • hlen
        • hmget
        • hmset
        • hscan
        • hset
        • hsetnx
        • hstrlen
        • hvals
        • incr
        • incrby
        • incrbyfloat
        • keys
        • lindex
        • linsert
        • llen
        • lpop
        • lpush
        • lpushx
        • lrange
        • lrem
        • lset
        • ltrim
        • mget
        • mset
        • msetnx
        • object
        • persist
        • pexpire
        • pexpireat
        • pfadd
        • pfcount
        • pfmerge
        • ping
        • psetex
        • pttl
        • randomkey
        • rename
        • renamenx
        • rpop
        • rpoplpush
        • rpush
        • rpushx
        • sadd
        • scan
        • scard
        • sdiff
        • sdiffstore
        • set
        • setex
        • setnx
        • sinter
        • sinterstore
        • sismember
        • smembers
        • smove
        • sort
        • spop
        • srandmember
        • srem
        • sscan
        • strlen
        • sunion
        • sunionstore
        • time
        • touch
        • ttl
        • type
        • zadd
        • zcard
        • zcount
        • zincrby
        • zinterstore
        • zlexcount
        • zrange
        • zrangebylex
        • zrangebyscore
        • zrank
        • zrem
        • zremrangebylex
        • zremrangebyrank
        • zremrangebyscore
        • zrevrange
        • zrevrangebylex
        • zrevrangebyscore
        • zrevrank
        • zscan
        • zscore
        • zunionstore
      • Profile
        • constructor
        • addPolicy
        • delete
        • getPolicies
        • save
        • setContent
        • setPolicies
        • update
      • Role
        • constructor
        • delete
        • save
        • setContent
        • update
      • SearchResult
        • constructor
        • fetchNext
      • Security
        • constructor
        • createCredentials
        • createProfile
        • createRestrictedUser
        • createRole
        • createUser
        • deleteCredentials
        • deleteProfile
        • deleteRole
        • deleteUser
        • fetchProfile
        • fetchRole
        • fetchUser
        • getAllCredentialFields
        • getCredentials
        • getCredentialsFields
        • getUserRights
        • hasCredentials
        • isActionAllowed
        • profile
        • replaceUser
        • role
        • scrollProfiles
        • scrollUsers
        • searchProfiles
        • searchRoles
        • searchUsers
        • updateCredentials
        • updateProfile
        • updateRole
        • updateUser
        • user
        • validateCredentials
      • User
        • constructor
        • addProfile
        • create
        • delete
        • getProfileids
        • getProfiles
        • replace
        • save
        • saveRestricted
        • setContent
        • setCredentials
        • setProfiles
        • update
      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