Skip to content

Candidate methods: screen

The Candidate Verbs screen as typed SDK methods, with inputs, result, refusals and an example.

Reference for Candidate, one group of Candidate methods.

Candidate.screen

Screen asks a Candidate only what the Opening’s Hypothesis still lacks, in writing, and grades each answer as Evidence. Verb page.

TypeScript
interface CandidateVerbs {
  screen(input: CandidateScreenInput, options?: SB.CallOptions): SB.Call<Candidate>
}

Emits Candidate.screened.

Inputs

InputTypeRequiredDescription
candidateCandidaterequiredThe Candidate to screen.

Returns

OutputTypeRequiredDescription
candidateCandidaterequiredThe Candidate, with graded Evidence attached.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

TypeScript
import { $ } from 'startup-builder'

const candidate = await $.Candidate.screen({ candidate: 'candidate_CR5hpwMwhW' })