Kuzzle v1.x
Kuzzle v2.x
Use
Guides
API
SDK
Plugins
How to
Extend
Write Plugins
Write Protocols
Kuzzle Documentation
1
2
Getting Started
Node.js
Browser (Vanilla)
Webpack
React
React with Redux
VueJS
Standalone
Essentials
Error Handling
Events
Realtime notifications
Offline Tools
Extends the SDK
Core Classes
BaseController
Introduction
Properties
query
Kuzzle
Introduction
Properties
constructor
connect
disconnect
flushQueue
playQueue
query
startQueuing
stopQueuing
useController
KuzzleError
Introduction
Properties
KuzzleEventEmitter
Introduction
addListener
addOnceListener
emit
listeners
on
once
prependListener
prependOnceListener
removeAllListeners
removeListener
Profile
Introduction
Properties
getRoles
Role
Introduction
Properties
SearchResult
Properties
next
User
Introduction
Properties
getProfiles
Protocols
Http
Introduction
Properties
constructor
SocketIO
Introduction
Properties
constructor
WebSocket
Introduction
Properties
constructor
Controllers
auth
checkToken
createMyCredentials
credentialsExist
deleteMyCredentials
getCurrentUser
getMyCredentials
getMyRights
getStrategies
login
logout
refreshToken
updateMyCredentials
updateSelf
validateMyCredentials
bulk
import
mWrite
write
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
ms
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
realtime
count
publish
subscribe
unsubscribe
security
createCredentials
createFirstAdmin
createOrReplaceProfile
createOrReplaceRole
createProfile
createRestrictedUser
createRole
createUser
deleteCredentials
deleteProfile
deleteRole
deleteUser
getAllCredentialFields
getCredentialFields
getCredentials
getCredentialsById
getProfile
getProfileMapping
getProfileRights
getRole
getRoleMapping
getUser
getUserMapping
getUserRights
hasCredentials
mDeleteProfiles
mDeleteRoles
mDeleteUsers
mGetProfiles
mGetRoles
replaceUser
searchProfiles
searchRoles
searchUsers
updateCredentials
updateProfile
updateProfileMapping
updateRole
updateRoleMapping
updateUser
updateUserMapping
validateCredentials
server
adminExists
getAllStats
getConfig
getLastStats
getStats
info
now
Select an SDK
API 2.x
Javascript 7.x
C# 2.x
on
Alias for
addListener
.
Select an SDK Select an SDK Select an SDK