Sanity App SDK
    Preparing search index...

    Module index

    Enumerations

    AuthStateType

    Interfaces

    ActionErrorEvent
    ActionsResult
    ApplyDocumentActionsOptions
    ArchiveReleaseAction
    AuthConfig
    AuthProvider
    AuthStoreState
    ClientOptions
    ClientState
    ComlinkControllerState
    ComlinkNodeState
    CreateDocumentAction
    CreateReleaseAction
    DatasetHandle
    DeleteDocumentAction
    DeleteReleaseAction
    DiscardDocumentAction
    DisconnectEvent
    DocumentCreatedEvent
    DocumentDeletedEvent
    DocumentDiscardedEvent
    DocumentEditedEvent
    DocumentHandle
    DocumentOptions
    DocumentPublishedEvent
    DocumentTypeHandle
    DocumentUnpublishedEvent
    EditDocumentAction
    EditReleaseAction
    FavoriteStatusResponse
    FetcherStore
    FetcherStoreState
    GetUserOptions
    GetUsersOptions
    Intent
    IntentFilter
    LoggerConfig
    Membership
    NodeState
    OrganizationBase
    OrganizationMember
    OrganizationOptions
    OrganizationsOptions
    OrgVerificationResult
    PermissionDeniedReason
    PerspectiveHandle
    PresenceLocation
    PreviewMedia
    PreviewStoreState
    PreviewValue
    ProjectBase
    ProjectHandle
    ProjectionValuePending
    ProjectMember
    ProjectMemberRole
    ProjectMetadata
    ProjectOptions
    ProjectsOptions
    PublishDocumentAction
    PublishReleaseAction
    QueryOptions
    ReleaseHandle
    ResolveUserOptions
    ResolveUsersOptions
    RollCallEvent
    SanityConfig
    SanityInstance
    SanityUser
    SanityUserResponse
    ScheduleReleaseAction
    StateEvent
    StateSource
    StudioConfig
    TokenSource
    TransactionAcceptedEvent
    TransactionRevertedEvent
    UnarchiveReleaseAction
    UnpublishDocumentAction
    UnscheduleReleaseAction
    UserPresence
    UserProfile
    UsersGroupState
    UsersStoreState

    Type Aliases

    Action
    AgentGenerateOptions
    AgentGenerateResult
    AgentPatchOptions
    AgentPatchResult
    AgentPromptOptions
    AgentPromptResult
    AgentTransformOptions
    AgentTransformResult
    AgentTranslateOptions
    AgentTranslateResult
    AuthState
    CanvasResource
    CanvasSource
    DatasetResource
    DatasetSource
    DocumentAction
    DocumentEvent
    DocumentPermissionsResult
    DocumentResource
    DocumentSource
    DocumentTransactionSubmissionResult
    ErrorAuthState
    FrameMessage
    GetPreviewStateOptions
    JsonMatch
    LoggedInAuthState
    LoggedOutAuthState
    LoggingInAuthState
    LogLevel
    MediaLibraryResource
    MediaLibrarySource
    Organization
    Organizations
    Project
    ReleaseAction
    ReleasePerspective
    ReleaseState
    ResolvePreviewOptions
    SanityProject
    Selector
    TransportEvent
    ValidProjection
    ValuePending
    WindowMessage

    Variables

    destroyController
    getAuthState
    getClient
    getClientState
    getCurrentUserState
    getDashboardOrganizationId
    getDatasetsState
    getDocumentSyncStatus
    getFavoritesState
    getIsInDashboardState
    getLoginUrlState
    getNodeState
    getOrCreateChannel
    getOrCreateController
    getOrCreateNode
    getOrganizationsState
    getOrganizationState
    getPermissionsState
    getPerspectiveState
    getProjectsState
    getProjectState
    getTokenState
    getUsersState
    getUserState
    handleAuthCallback
    loadMoreUsers
    logout
    releaseChannel
    releaseNode
    resolveDatasets
    resolveFavoritesState
    resolveOrganization
    resolveOrganizations
    resolvePermissions
    resolveProject
    resolveProjects
    resolveUser
    resolveUsers
    subscribeDocumentEvents

    Functions

    agentGenerate
    agentPatch
    agentPrompt
    agentTransform
    agentTranslate
    applyDocumentActions
    archiveRelease
    configureLogging
    createDatasetHandle
    createDocument
    createDocumentHandle
    createDocumentTypeHandle
    createProjectHandle
    createRelease
    createSanityInstance
    defineIntent
    deleteDocument
    deleteRelease
    discardDocument
    editDocument
    editRelease
    getCorsErrorProjectId
    getDocumentState
    getPresence
    getPreviewState
    getProjectionState
    getQueryState
    getReleaseDocumentId
    isCanvasResource
    isCanvasSource
    isDatasetResource
    isDatasetSource
    isImportError
    isMediaLibraryResource
    isMediaLibrarySource
    observeOrganizationVerificationState
    publishDocument
    publishRelease
    resolveDocument
    resolvePreview
    resolveProjection
    resolveQuery
    scheduleRelease
    unarchiveRelease
    unpublishDocument
    unscheduleRelease

    References

    getQueryKey → getQueryKey
    parseQueryKey → parseQueryKey

    Settings

    Member Visibility

    On This Page

    Enumerations
    Interfaces
    ActionErrorEventActionsResultApplyDocumentActionsOptionsArchiveReleaseActionAuthConfigAuthProviderAuthStoreStateClientOptionsClientStateComlinkControllerStateComlinkNodeStateCreateDocumentActionCreateReleaseActionDatasetHandleDeleteDocumentActionDeleteReleaseActionDiscardDocumentActionDisconnectEventDocumentCreatedEventDocumentDeletedEventDocumentDiscardedEventDocumentEditedEventDocumentHandleDocumentOptionsDocumentPublishedEventDocumentTypeHandleDocumentUnpublishedEventEditDocumentActionEditReleaseActionFavoriteStatusResponseFetcherStoreFetcherStoreStateGetUserOptionsGetUsersOptionsIntentIntentFilterLoggerConfigMembershipNodeStateOrganizationBaseOrganizationMemberOrganizationOptionsOrganizationsOptionsOrgVerificationResultPermissionDeniedReasonPerspectiveHandlePresenceLocationPreviewMediaPreviewStoreStatePreviewValueProjectBaseProjectHandleProjectionValuePendingProjectMemberProjectMemberRoleProjectMetadataProjectOptionsProjectsOptionsPublishDocumentActionPublishReleaseActionQueryOptionsReleaseHandleResolveUserOptionsResolveUsersOptionsRollCallEventSanityConfigSanityInstanceSanityUserSanityUserResponseScheduleReleaseActionStateEventStateSourceStudioConfigTokenSourceTransactionAcceptedEventTransactionRevertedEventUnarchiveReleaseActionUnpublishDocumentActionUnscheduleReleaseActionUserPresenceUserProfileUsersGroupStateUsersStoreState
    Type Aliases
    Variables
    Functions
    References