Skip to content

Main Navigation Docs

Appearance

Sidebar Navigation

Getting Started

Overview

Starting with the Template App

Deploying to Production

Example Apps

Users and Auth

Authentication

Users and Groups

Data Persistence

Choosing Your Data Model

Defining Your Models

Working with Documents

Working with Databases

Blobs and Files

Platform Services

Workflows and Prompts

API Integrations

Analytics

Tools

Admin Console

Primitive CLI

Dev Tools

Changelog

Reference

primitive-app

JsBaoClientService

js-bao-wss-client

Client Setup

JsBaoClientOptions

JsBaoEvents

Documents

aliases

addTag()

approveAccessRequest()

blobs()

cancelPendingCreate()

close()

commitOfflineCreate()

create()

createWithAlias()

delete()

denyAccessRequest()

evict()

evictAll()

for()

get()

getAwarenessStates()

getDocumentPermission()

getLocalMetadata()

getOrCreateWithAlias()

getPermissions()

getRoot()

getUploadConcurrency()

grantGroupPermission()

hasLocalCopy()

includesWrites()

inSync()

isOpen()

isPendingCreate()

isReadOnly()

isSynced()

list()

listAccessRequests()

listGroupPermissions()

listOpen()

listPendingCreates()

listPendingInvitations()

open()

openAlias()

openRoot()

pauseAllUploads()

pauseUpload()

removeAwareness()

removePermission()

removeTag()

requestAccess()

resumeAllUploads()

resumeUpload()

revokeGroupPermission()

setAwareness()

setUploadConcurrency()

transferOwnership()

update()

updatePermissions()

uploads()

validateAccess()

waitForInSync()

waitForWriteConfirmation()

blobs()

delete()

get()

getLocalMetadata()

getPermissions()

getUploadConcurrency()

grantGroupPermission()

isReadOnly()

isRoot()

listGroupPermissions()

pauseAllUploads()

pauseUpload()

resumeAllUploads()

resumeUpload()

revokeGroupPermission()

setUploadConcurrency()

transferOwnership()

update()

uploads()

Types

DocumentInfo

DocumentPermissionEntry

DocumentGroupPermissionEntry

DocumentInvitation

DocumentInvitationResponse

DocumentAccessResult

DocumentCollectionInfo

Databases

addManager()

connect()

create()

createOperation()

delete()

deleteOperation()

describe()

executeBatch()

executeOperation()

get()

getCelContext()

getOperation()

grantGroupPermission()

importCsv()

list()

listGroupPermissions()

listOperations()

listPermissions()

removeManager()

revokeGroupPermission()

subscribe()

transferOwnership()

update()

updateCelContext()

updateOperation()

Types

DatabaseInfo

DatabasePermissionEntry

DatabaseOwnershipTransferResult

DatabaseOperationInfo

CsvImportOptions

CsvImportProgress

CsvImportResult

Collections

addDocument()

addMember()

create()

delete()

get()

getAccess()

grantGroupPermission()

list()

listAll()

listCollectionsForDocument()

listDocuments()

removeDocument()

removeMember()

revokeGroupPermission()

update()

Types

CollectionInfo

CollectionDocumentInfo

CollectionGroupPermissionInfo

CollectionMemberInfo

CollectionAccessInfo

Users & Groups

getBasic()

getProfiles()

lookup()

bookmarks

cacheInfo()

clearCache()

get()

pendingDocumentInvitations()

sharedDocuments()

update()

uploadAvatar()

get()

addMember()

create()

delete()

get()

list()

listDatabases()

listDocuments()

listMembers()

listPendingInvitations()

listUserMemberships()

removeMember()

update()

create()

delete()

get()

list()

update()

Types

BasicUserInfo

UserProfile

SessionInfo

GroupInfo

GroupMemberInfo

GroupMembershipInfo

GroupDocumentInfo

GroupTypeConfigInfo

Authentication

checkOAuthAvailable()

getAppConfig()

getAuthConfig()

getAuthPersistenceInfo()

getAuthState()

getRootDocId()

getToken()

getUserId()

handleOAuthCallback()

isAuthenticated()

logout()

magicLinkRequest()

magicLinkVerify()

otpRequest()

otpVerify()

passkeyAuthFinish()

passkeyAuthStart()

passkeyDelete()

passkeyList()

passkeyRegisterFinish()

passkeyRegisterStart()

passkeyUpdate()

setToken()

startOAuthFlow()

waitForAuthBootstrap()

waitForAuthReady()

waitForUserId()

exchangeOAuthCode()

Types

AuthError

AuthStateEvent

JsBaoError

Workflows

claimApply()

confirmApply()

define()

getPendingApplies()

getStatus()

listRuns()

listStepRuns()

releaseApply()

start()

terminate()

Types

StartWorkflowOptions

StartWorkflowResult

GetWorkflowStatusOptions

WorkflowStatusResult

WorkflowRun

ListWorkflowRunsOptions

ListWorkflowRunsResult

TerminateWorkflowOptions

WorkflowDefineOptions

ClaimApplyOptions

ClaimApplyResult

ConfirmApplyOptions

ConfirmApplyResult

ReleaseApplyOptions

ReleaseApplyResult

WorkflowStatusEvent

WorkflowStartedEvent

Prompts

execute()

Types

ExecutePromptOptions

ExecutePromptResult

AI / LLM

countTokens()

generate()

generateRaw()

models()

chat()

models()

Types

LlmChatOptions

GeminiPromptOptions

GeminiGenerateResult

GeminiModelSummary

GeminiMessage

GeminiStructuredOutput

GeminiGenerateRawOptions

Integrations

call()

Types

IntegrationCallRequest

IntegrationCallResponse

Analytics

flush()

logEvent()

logSnapshot()

setAppVersionOverride()

setPlanOverride()

Types

AnalyticsAutoEventsOptions

AnalyticsEventInput

Blobs & Files

delete()

downloadUrl()

get()

hasServiceWorkerControl()

list()

pauseAll()

pauseUpload()

prefetch()

proxyUrl()

read()

resumeAll()

resumeUpload()

upload()

uploadFile()

uploads()

Types

BlobUploadSourceOptions

BlobUploadResult

BlobListResult

BlobUploadStatus

BlobReadOptions

BlobPrefetchOptions

BlobProxyUrlOptions

BlobUploadProgressEvent

BlobUploadCompletedEvent

BlobUploadFailedEvent

Offline & Cache

clear()

clearAll()

fetchCached()

fetchHttp()

info()

key()

Types

StorageProvider

Rule Sets

create()

debug()

delete()

get()

list()

schema()

test()

update()

Types

RuleSetInfo

RuleSetSchema

RuleSetTestResult

RuleSetDebugResult

TraceEntry

TriggerDefInfo

ModelRulesInfo

Other Types

AcceptInviteResult

AddManagerParams

AppInvitationInfo

BatchUserProfile

BlobBucketInfo

BlobBucketsAPI

BlobInfo

BlobListOptions

BlobSignedUrlResult

BlobUploadParams

BookmarkAddParams

BookmarkAddResult

BookmarkItem

BookmarkListOptions

BookmarkListResult

BookmarkRemoveResult

BookmarkRenameResult

BucketBlobListResult

BucketBlobUploadResult

CollectionTypeConfigInfo

CollectionTypeConfigsAPI

CreateBlobBucketParams

CreateCollectionTypeConfigParams

CreateCronTriggerParams

CreateDatabaseTypeConfigParams

CreateInvitationParams

CronTriggerInfo

CronTriggerListResult

CronTriggersAPI

DatabaseChangeEvent

DatabaseChangePayload

DatabaseConfig

DatabaseGroupPermissionEntry

DatabaseSubscribeOptions

DatabaseTypeConfigInfo

DatabaseTypeConfigsAPI

DeferredDocumentGrant

DeferredGrantListResult

DeferredGrantRevokeResult

DeferredGroupAdd

DeferredGroupGrant

DeferredPermissionGrant

DirectGroupAdd

DirectPermissionGrant

DiscoveredConstraint

DiscoveredField

DiscoveredModel

DiscoveredRelationship

DiscoveredSchema

DocumentAliasesAPI

DocumentAliasInfo

DocumentCreateCommitFailedEvent

DocumentEvent

DocumentMetadataChangedEvent

EnableOfflineAccessOptions

EvictAllLocalOptions

GoOfflineOptions

GrantDatabaseGroupPermissionParams

GrantPermissionParams

GroupDatabaseInfo

InvitationEvent

InvitationListResult

InvitationQuota

ListDatabasesOptions

ListLocalDocumentsOptions

ListUserMembershipsOptions

ListWorkflowStepRunsOptions

ListWorkflowStepRunsResult

LogoutOptions

MeUpdatedEvent

MeUpdateFailedEvent

NetworkModeEvent

OfflineAuthEnabledEvent

OfflineAuthExpiringSoonEvent

OfflineAuthFailedEvent

OfflineAuthRenewedEvent

OfflineAuthUnlockedEvent

PaginatedResult

PaginationOptions

PendingCreateCommittedEvent

PendingCreateFailedEvent

PendingGroupInvitationEntry

PendingInvitationEntry

PermissionEvent

PermissionUpdateResult

ReasoningOptions

RevokeOfflineGrantOptions

SchemaDiscoveredEvent

SharedDocument

SharedDocumentListResult

StatusChangedEvent

UpdateCollectionTypeConfigParams

UpdateCronTriggerParams

UpdateDatabaseTypeConfigParams

WaitForAuthReadyOptions

WaitForUserIdOptions

WorkflowStepRunRecord

YjsPersistenceContext

YjsPersistenceProvider

js-bao

Classes

BaseModel

DatabaseEngine

DocumentClosedError

DocumentResolutionError

Logger

ModelRegistry

RecordNotFoundError

StringSet

UniqueConstraintViolationError

Functions

attachAndRegisterModel

attachSchemaToClass

autoRegisterModel

clearMetaSyncCache

createModelClass

defineModelSchema

discoverModelNames

discoverSchema

dumpYDocToPlain

generateULID

inferFieldType

initJsBao

loadSchemaFromToml

loadSchemaFromTomlString

registerFunctionDefault

resetJsBao

schemaToToml

summarizePlainYDoc

syncInferredMeta

syncModelMeta

Interfaces

ConnectedDocument

DatabaseConfig

DiscoveredConstraint

DiscoveredField

DiscoveredModel

DiscoveredRelationship

DiscoveredSchema

DocumentConnectionEvent

DocumentManager

DumpOptions

DumpSummary

DumpSummaryEntry

FieldOptions

IncludeSpec

InitJsBaoOptions

InitJsBaoResult

ModelOptions

PaginatedResult

PaginationOptions

QueryOptions

SaveOptions

Type Aliases

DocumentConnectionCallback

DocumentFilter

DocumentPermissionHint

InferAttrs

ModelConstructor

PlainYDoc

ProjectionSpec

QueryResult

On this page

js-bao-wss-client

js-bao-wss-client / SharedDocumentListResult

Interface: SharedDocumentListResult

Properties

documents

documents: SharedDocument[]

nextCursor

nextCursor: string | null

Pager

Previous pageSharedDocument

Next pageStatusChangedEvent