Sanity Library Reference Docs
Preparing search index...
@sanity/sdk
index
Module index
AuthStateType
ActionErrorEvent
ActionsResult
ApplicationAccess
ApplicationBase
ApplicationsOptions
ApplicationsResponse
ApplicationStudioConfig
ApplicationWorkspace
ApplyDocumentActionsOptions
ArchiveReleaseAction
AuthConfig
AuthProvider
AuthStoreState
ClientOptions
ClientState
Comment
CommentReaction
CommentsOptions
CommentTextSelection
CommentTextSelectionItem
CommentThread
CreateCommentOptions
CreateDocumentAction
CreateReleaseAction
DatasetHandle
DeleteDocumentAction
DeleteReleaseAction
DiscardDocumentAction
DisconnectEvent
DocumentCreatedEvent
DocumentDeletedEvent
DocumentDiscardedEvent
DocumentEditedEvent
DocumentHandle
DocumentOptions
DocumentPresence
DocumentPresenceOptions
DocumentPublishedEvent
DocumentRemotePatchesEvent
DocumentTypeHandle
DocumentUnpublishedEvent
EditDocumentAction
EditDocumentOptions
EditReleaseAction
FavoriteDocumentContext
FavoriteStatusResponse
GetUserOptions
GetUsersOptions
InstallationAccess
InstallationActiveConfig
InstallationBase
InstallationsOptions
InstallationsResponse
LoggerConfig
Membership
OAuthTokens
OrganizationBase
OrganizationMember
OrganizationOptions
OrganizationsOptions
OrgVerificationResult
PermissionDeniedReason
PerspectiveHandle
PresenceLocation
PresencePerspectiveOptions
PresenceSelectionPoint
PreviewMedia
PreviewValue
ProjectBase
ProjectHandle
ProjectionValuePending
ProjectMember
ProjectMemberRole
ProjectMetadata
ProjectOptions
ProjectsOptions
PublishDocumentAction
PublishReleaseAction
QueryOptions
ReleaseHandle
RemoveCommentOptions
ReplyToCommentOptions
ReportPresenceOptions
ResolveCommentsOptions
ResolveUserOptions
ResolveUsersOptions
RollCallEvent
SanityConfig
SanityInstance
SanityUser
SanityUserResponse
ScheduleReleaseAction
SetCommentStatusOptions
StateEvent
StateSource
StudioConfig
TokenSource
TransactionAcceptedEvent
TransactionRevertedEvent
TransactionSubmissionFailedEvent
UnarchiveReleaseAction
UnpublishDocumentAction
UnscheduleReleaseAction
UpdateCommentOptions
UserPresence
UserProfile
UsersGroupState
UsersStoreState
AccessResourceType
Action
Application
ApplicationDeployment
ApplicationInclude
ApplicationInterface
ApplicationInterfacePlacementMetadata
AuthState
CanvasResource
CommentLocalState
CommentMessage
CommentStatus
DatasetResource
DocumentAction
DocumentEvent
DocumentPermissionsResult
DocumentResource
DocumentSet
DocumentTransactionSubmissionResult
ErrorAuthState
Installation
InstallationInclude
JsonMatch
LoggedInAuthState
LoggedOutAuthState
LoggingInAuthState
LogLevel
MediaLibraryResource
Organization
Organizations
PresenceSelection
Project
ReleaseAction
ReleasePerspective
ReleaseState
ResolveDocument
ResolveProjectionResult
ResolveQueryResult
SanityProject
Selector
SetFavoriteInput
TransportEvent
createComment
getAuthState
getClient
getClientState
getCommentsState
getCommentThreadsState
getCurrentUserState
getDocumentSyncStatus
getIsInDashboardState
getLoginUrlState
getOAuthTokensState
getPermissionsState
getPerspectiveState
getTokenState
getUsersState
getUserState
handleAuthCallback
handleOAuthCallback
loadMoreUsers
logout
refreshOAuthTokens
removeComment
replyToComment
resolveComments
resolveCommentThreads
resolvePermissions
resolveUser
resolveUsers
revokeOAuthTokens
setCommentStatus
startOAuthAuthorization
subscribeDocumentEvents
updateComment
applyDocumentActions
archiveRelease
configureLogging
createDatasetHandle
createDocument
createDocumentHandle
createDocumentTypeHandle
createProjectHandle
createRelease
createSanityInstance
defineProjection
deleteDocument
deleteRelease
discardDocument
editDocument
editRelease
getCorsErrorProjectId
getDashboardOrganizationId
getDocumentPresence
getDocumentState
getPresence
getProjectionState
getQueryState
getReleaseDocumentId
isCanvasResource
isDatasetResource
isImportError
isMediaLibraryResource
observeOrganizationVerificationState
publishDocument
publishRelease
reportPresence
resolveDocument
resolveProjection
resolveQuery
scheduleRelease
unarchiveRelease
unpublishDocument
unscheduleRelease
Authentication
getProjectAccessErrorProjectId
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Auth
State
Type
Action
Error
Event
Actions
Result
Application
Access
Application
Base
Applications
Options
Applications
Response
Application
Studio
Config
Application
Workspace
Apply
Document
Actions
Options
Archive
Release
Action
Auth
Config
Auth
Provider
Auth
Store
State
Client
Options
Client
State
Comment
Comment
Reaction
Comments
Options
Comment
Text
Selection
Comment
Text
Selection
Item
Comment
Thread
Create
Comment
Options
Create
Document
Action
Create
Release
Action
Dataset
Handle
Delete
Document
Action
Delete
Release
Action
Discard
Document
Action
Disconnect
Event
Document
Created
Event
Document
Deleted
Event
Document
Discarded
Event
Document
Edited
Event
Document
Handle
Document
Options
Document
Presence
Document
Presence
Options
Document
Published
Event
Document
Remote
Patches
Event
Document
Type
Handle
Document
Unpublished
Event
Edit
Document
Action
Edit
Document
Options
Edit
Release
Action
Favorite
Document
Context
Favorite
Status
Response
Get
User
Options
Get
Users
Options
Installation
Access
Installation
Active
Config
Installation
Base
Installations
Options
Installations
Response
Logger
Config
Membership
OAuth
Tokens
Organization
Base
Organization
Member
Organization
Options
Organizations
Options
Org
Verification
Result
Permission
Denied
Reason
Perspective
Handle
Presence
Location
Presence
Perspective
Options
Presence
Selection
Point
Preview
Media
Preview
Value
Project
Base
Project
Handle
Projection
Value
Pending
Project
Member
Project
Member
Role
Project
Metadata
Project
Options
Projects
Options
Publish
Document
Action
Publish
Release
Action
Query
Options
Release
Handle
Remove
Comment
Options
Reply
To
Comment
Options
Report
Presence
Options
Resolve
Comments
Options
Resolve
User
Options
Resolve
Users
Options
Roll
Call
Event
Sanity
Config
Sanity
Instance
Sanity
User
Sanity
User
Response
Schedule
Release
Action
Set
Comment
Status
Options
State
Event
State
Source
Studio
Config
Token
Source
Transaction
Accepted
Event
Transaction
Reverted
Event
Transaction
Submission
Failed
Event
Unarchive
Release
Action
Unpublish
Document
Action
Unschedule
Release
Action
Update
Comment
Options
User
Presence
User
Profile
Users
Group
State
Users
Store
State
Access
Resource
Type
Action
Application
Application
Deployment
Application
Include
Application
Interface
Application
Interface
Placement
Metadata
Auth
State
Canvas
Resource
Comment
Local
State
Comment
Message
Comment
Status
Dataset
Resource
Document
Action
Document
Event
Document
Permissions
Result
Document
Resource
Document
Set
Document
Transaction
Submission
Result
Error
Auth
State
Installation
Installation
Include
Json
Match
Logged
In
Auth
State
Logged
Out
Auth
State
Logging
In
Auth
State
Log
Level
Media
Library
Resource
Organization
Organizations
Presence
Selection
Project
Release
Action
Release
Perspective
Release
State
Resolve
Document
Resolve
Projection
Result
Resolve
Query
Result
Sanity
Project
Selector
Set
Favorite
Input
Transport
Event
create
Comment
get
Auth
State
get
Client
get
Client
State
get
Comments
State
get
Comment
Threads
State
get
Current
User
State
get
Document
Sync
Status
get
Is
In
Dashboard
State
get
Login
Url
State
getOAuth
Tokens
State
get
Permissions
State
get
Perspective
State
get
Token
State
get
Users
State
get
User
State
handle
Auth
Callback
handleOAuth
Callback
load
More
Users
logout
refreshOAuth
Tokens
remove
Comment
reply
To
Comment
resolve
Comments
resolve
Comment
Threads
resolve
Permissions
resolve
User
resolve
Users
revokeOAuth
Tokens
set
Comment
Status
startOAuth
Authorization
subscribe
Document
Events
update
Comment
apply
Document
Actions
archive
Release
configure
Logging
create
Dataset
Handle
create
Document
create
Document
Handle
create
Document
Type
Handle
create
Project
Handle
create
Release
create
Sanity
Instance
define
Projection
delete
Document
delete
Release
discard
Document
edit
Document
edit
Release
get
Cors
Error
Project
Id
get
Dashboard
Organization
Id
get
Document
Presence
get
Document
State
get
Presence
get
Projection
State
get
Query
State
get
Release
Document
Id
is
Canvas
Resource
is
Dataset
Resource
is
Import
Error
is
Media
Library
Resource
observe
Organization
Verification
State
publish
Document
publish
Release
report
Presence
resolve
Document
resolve
Projection
resolve
Query
schedule
Release
unarchive
Release
unpublish
Document
unschedule
Release
Authentication
get
Project
Access
Error
Project
Id
Sanity Library Reference Docs
Loading...