OBJECT
Sequence

A contiguous flow of content
GraphQL Schema definition

type Sequence {
#   The id of the sequence
id: String! 
#   The type of the sequence (main, heading...)
type: String! 
#   The number of blocks in the sequence
nBlocks: Int! 
#   The blocks in the sequence
# 
# Arguments
#   withScopes: Only return blocks where the list of scopes is open
#   positions: Only return blocks whose zero-indexed position is in 
#   the list
#   withBlockScope: Only return blocks with the specified block 
#   scope (eg 'blockScope/p'
#   withScriptureCV: Only return blocks that contain items within 
#   the specified chapter, verse or chapterVerse range
#   attSpecs: Ordered list of attribute specs whose values must 
#   match those in 'attValues'
#   attValues: Ordered list of attribute values, used in 
#   conjunction with \'attSpecs\'
#   allAtts: If true, blocks where all attSpecs match will be 
#   included
#   withChars: Return blocks containing a token whose payload is an 
#   exact match to one of the specified strings
#   withMatchingChars: Return blocks containing a token whose 
#   payload matches the specified regexes
#   allChars: If true, blocks where all regexes match will be 
#   included
blocks(
withScopes: [String!],
positions: [Int!],
withBlockScope: String,
withScriptureCV: String,
attSpecs: [[AttSpec!]!],
attValues: [[String!]!],
allAtts: Boolean,
withChars: [String!],
withMatchingChars: [String!],
allChars: Boolean
): [Block!]! 
#   The items for each block in the sequence
blocksItems: [[Item!]!] 
#   The tokens for each block in the sequence
blocksTokens: [[Item!]!] 
#   The text for each block in the sequence
# 
# Arguments
#   normalizeSpace: If true, converts each whitespace character to 
#   a single space
blocksText(normalizeSpace: Boolean): [String!] 
#   The text for the sequence
# 
# Arguments
#   normalizeSpace: If true, converts each whitespace character to 
#   a single space
text(normalizeSpace: Boolean): String! 
#   Sequence content grouped by scopes or milestones
# 
# Arguments
#   byScopes: Produce one itemGroup for every different match of 
#   the list of scopes
#   byMilestones: Start a new itemGroup whenever a milestone in the 
#   list is encountered
itemGroups(byScopes: [String!], byMilestones: [String!]): [ItemGroup!]! 
#   A list of the tags of this sequence
tags: [String!]! 
#   A list of the tags of this sequence as key/value tuples
tagsKv: [KeyValue!]! 
#   Whether or not the sequence has the specified tag
# 
# Arguments
#   tagName: The specified tag
hasTag(tagName: String!): Boolean! 
#   A list of wordLike token strings in a main sequence
# 
# Arguments
#   coerceCase: Whether to coerce the strings 
#   (toLower|toUpper|none)
wordLikes(coerceCase: String): [String!]! 
#   Returns true if a main sequence contains the specified tokens
# 
# Arguments
#   chars: Token strings to be matched exactly
#   allChars: If true all tokens must match
hasChars(chars: [String!], allChars: Boolean): Boolean! 
#   Returns true if a main sequence contains a match for specified regexes
# 
# Arguments
#   chars: Regexes to be matched
#   allChars: If true all regexes must match
hasMatchingChars(chars: [String!], allChars: Boolean): Boolean! 
}
Require by

DocumentA document, typically corresponding to USFM for one book
Sequence

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
