bootdesk/chat-sdk

StateAdapter
in

Table of Contents

Methods

acquireLock()  : Lock|null
appendToList()  : void
connect()  : void
delete()  : void
dequeue()  : QueueEntry|null
disconnect()  : void
enqueue()  : int
extendLock()  : bool
forceReleaseLock()  : void
get()  : mixed
getAndDeleteModalContext()  : array<string|int, mixed>|null
getList()  : array<string|int, mixed>
isSubscribed()  : bool
queueDepth()  : int
releaseLock()  : void
set()  : void
setIfNotExists()  : bool
storeModalContext()  : void
subscribe()  : void
unsubscribe()  : void

Methods

acquireLock()

public acquireLock(string $lockKey, int $ttlMs) : Lock|null
Parameters
$lockKey : string
$ttlMs : int
Return values
Lock|null

appendToList()

public appendToList(string $key, mixed $value[, array<string|int, mixed> $options = [] ]) : void
Parameters
$key : string
$value : mixed
$options : array<string|int, mixed> = []

delete()

public delete(string $key) : void
Parameters
$key : string

enqueue()

public enqueue(string $threadId, QueueEntry $entry, int $maxSize) : int
Parameters
$threadId : string
$entry : QueueEntry
$maxSize : int
Return values
int

extendLock()

public extendLock(Lock $lock, int $ttlMs) : bool
Parameters
$lock : Lock
$ttlMs : int
Return values
bool

forceReleaseLock()

public forceReleaseLock(string $lockKey) : void
Parameters
$lockKey : string

get()

public get(string $key) : mixed
Parameters
$key : string

getAndDeleteModalContext()

public getAndDeleteModalContext(string $adapterName, string $contextId) : array<string|int, mixed>|null
Parameters
$adapterName : string
$contextId : string
Return values
array<string|int, mixed>|null

getList()

public getList(string $key) : array<string|int, mixed>
Parameters
$key : string
Return values
array<string|int, mixed>

isSubscribed()

public isSubscribed(string $threadId) : bool
Parameters
$threadId : string
Return values
bool

queueDepth()

public queueDepth(string $threadId) : int
Parameters
$threadId : string
Return values
int

set()

public set(string $key, mixed $value[, int|null $ttlMs = null ]) : void
Parameters
$key : string
$value : mixed
$ttlMs : int|null = null

setIfNotExists()

public setIfNotExists(string $key, mixed $value[, int|null $ttlMs = null ]) : bool
Parameters
$key : string
$value : mixed
$ttlMs : int|null = null
Return values
bool

storeModalContext()

public storeModalContext(string $adapterName, string $contextId, array<string|int, mixed> $data, int $ttlMs) : void
Parameters
$adapterName : string
$contextId : string
$data : array<string|int, mixed>
$ttlMs : int

subscribe()

public subscribe(string $threadId) : void
Parameters
$threadId : string

unsubscribe()

public unsubscribe(string $threadId) : void
Parameters
$threadId : string
On this page

Search results