OBJECT
Document

A document, typically corresponding to USFM for one book
GraphQL Schema definition

type Document {
#   The id of the document
id: String! 
#   A parsed version of the id header
idParts: idParts! 
#   The id of the docSet to which this document belongs
docSetId: String! 
#   USFM header information such as TOC
headers: [KeyValue!]! 
#   One USFM header
# 
# Arguments
#   id: The header id, corresponding to the tag name minus any 
#   trailing '1'
header(id: String!): String 
#   The main sequence
mainSequence: Sequence! 
#   The number of sequences
nSequences: Int! 
#   A list of sequences for this document
# 
# Arguments
#   ids: ids of sequences to include, if found
#   types: types of sequences to include, if found
#   withTags: Only return sequences with all the specified tags
#   withoutTags: Only return sequences with none of the specified 
#   tags
sequences(
ids: [String!],
types: [String!],
withTags: [String!],
withoutTags: [String!]
): [Sequence!]! 
#   A list of table sequences for this document
# 
# Arguments
#   ids: ids of sequences to include, if found
#   withTags: Only return sequences with all the specified tags
#   withoutTags: Only return sequences with none of the specified 
#   tags
tableSequences(
ids: [String!],
withTags: [String!],
withoutTags: [String!]
): [tableSequence!]! 
#   A list of tree sequences for this document
# 
# Arguments
#   ids: ids of sequences to include, if found
#   withTags: Only return sequences with all the specified tags
#   withoutTags: Only return sequences with none of the specified 
#   tags
treeSequences(
ids: [String!],
withTags: [String!],
withoutTags: [String!]
): [treeSequence!]! 
#   A list of key-value sequences for this document
# 
# Arguments
#   ids: ids of sequences to include, if found
#   withTags: Only return sequences with all the specified tags
#   withoutTags: Only return sequences with none of the specified 
#   tags
kvSequences(ids: [String!], withTags: [String!], withoutTags: [String!]): [kvSequence!]! 
#   A list of text (ie non-table, non-tree, non-kv) sequences for this document
# 
# Arguments
#   ids: ids of sequences to include, if found
#   withTags: Only return sequences with all the specified tags
#   withoutTags: Only return sequences with none of the specified 
#   tags
textSequences(
ids: [String!],
withTags: [String!],
withoutTags: [String!]
): [Sequence!]! 
#   The sequence with the specified id
# 
# Arguments
#   id: id of the sequence
sequence(id: String!): Sequence 
#   The table sequence with the specified id
# 
# Arguments
#   id: id of the sequence
tableSequence(id: String!): tableSequence 
#   The tree sequence with the specified id
# 
# Arguments
#   id: id of the sequence
treeSequence(id: String!): treeSequence 
#   The key-value sequence with the specified id
# 
# Arguments
#   id: id of the sequence
kvSequence(id: String!): kvSequence 
#   The blocks of the main sequence
mainBlocks: [Block!]! 
#   The items for each block of the main sequence
mainBlocksItems: [[Item!]!]! 
#   The tokens for each block of the main sequence
mainBlocksTokens: [[Item!]!]! 
#   The text for each block of the main sequence
# 
# Arguments
#   normalizeSpace: If true, converts each whitespace character to 
#   a single space
mainBlocksText(normalizeSpace: Boolean): [String!]! 
#   The text for the main sequence
# 
# Arguments
#   normalizeSpace: If true, converts each whitespace character to 
#   a single space
mainText(normalizeSpace: Boolean): String! 
#   A list of the tags of this document
tags: [String!]! 
#   A list of the tags of this document as key/value tuples
tagsKv: [KeyValue!]! 
#   'Whether or not the document has the specified tag
# 
# Arguments
#   tagName: [Not documented]
hasTag(tagName: String!): Boolean! 
#   Content for a Scripture reference within this document, using local 
#   versification
# 
# Arguments
#   chapter: The chapter number (as a string)
#   verses: 'A list of verse numbers (as strings)
#   chapterVerses: A chapterVerse Reference (ch:v-ch:v)
#   includeContext: If true, adds scope and nextToken information 
#   to each token
cv(
chapter: String,
verses: [String!],
chapterVerses: String,
includeContext: Boolean
): [ItemGroup!]! 
#   Content for a Scripture reference within this document, using the versification 
#   of the specified docSet
# 
# Arguments
#   chapter: The chapter number (as a string)
#   mappedDocSetId: The id of the mapped docSet
#   verses: A list of verse numbers (as strings)
#   includeContext: If true, adds scope and nextToken information 
#   to each token
mappedCv(
chapter: String!,
mappedDocSetId: String!,
verses: [String!]!,
includeContext: Boolean
): [ItemGroup!]! 
#   Content for each verse of a chapter within this document, using the 
#   versification of the specified docSet
# 
# Arguments
#   chapter: The chapter number (as a string)
#   mappedDocSetId: The id of the mapped docSet
#   includeContext: If true, adds scope and nextToken information 
#   to each token
mappedCvs(
chapter: String!,
mappedDocSetId: String!,
includeContext: Boolean
): [[ItemGroup!]!]! 
#   What's previous and next with respect to the specified verse
# 
# Arguments
#   chapter: The chapter number (as a string)
#   verse: A verse number (as a string)
cvNavigation(chapter: String!, verse: String!): cvNavigation 
#   The content of the main sequence indexed by chapterVerse
cvIndexes: [cvIndex]! 
#   The content of the specified chapter indexed by chapterVerse
# 
# Arguments
#   chapter: The chapter number
cvIndex(chapter: Int!): cvIndex! 
#   The content of the main sequence indexed by chapter
cIndexes: [cIndex]! 
#   The content of a chapter
# 
# Arguments
#   chapter: 'The chapter number
cIndex(chapter: Int!): cIndex! 
#   Verses matching the arguments
# 
# Arguments
#   withChars: Return verses containing a token whose payload is an 
#   exact match to one of the specified strings
#   withMatchingChars: Return verses containing a token whose 
#   payload matches the specified regexes
#   withScopes: Only return blocks where the list of scopes is open
#   allChars: If true, verses where all regexes match will be 
#   included
#   allScopes: If true, verses where all scopes match will be 
#   included
cvMatching(
withChars: [String!],
withMatchingChars: [String!],
withScopes: [String!],
allChars: Boolean,
allScopes: Boolean
): [ItemGroup!]! 
}
Document

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
