AccessibilityNodeInfoCompat.PublicationInfoCompat


@PreviewAccessibilityApi
class AccessibilityNodeInfoCompat.PublicationInfoCompat : AccessibilityNodeInfoCompat.StructuredDataInfoCompat


Holds information about a node that represents a part of a digital publication, such as a chapter, footnote, or glossary entry.

An accessibility service can use this information to provide a richer experience for users reading digital publications, such as ebooks, articles, and long-form documents. For example, a screen reader could announce when a user enters a chapter or footnote and allow jumping between publication sections.

To add publication information to a node, create an instance of PublicationInfoCompat and call setStructuredDataInfo.

On all API levels, this information is currently stored in the node's extras, where accessibility services can read it with getStructuredDataInfo. See StructuredDataInfoCompat.

Summary

Constants

const String!
PUBLICATION_TAG_ABSTRACT = "doc-abstract"

A short summary of the work, or of a section or excerpt of it.

const String!
PUBLICATION_TAG_ACKNOWLEDGMENTS = "doc-acknowledgments"

A section that acknowledges contributions to the work.

const String!
PUBLICATION_TAG_AFTERWORD = "doc-afterword"

A closing statement, typically about how the work came to be or what followed it.

const String!
PUBLICATION_TAG_APPENDIX = "doc-appendix"

Supplemental information placed after the main content.

const String!
PUBLICATION_TAG_BACK_LINK = "doc-backlink"

A link back to a related location, such as from a note to where it's referenced.

const String!
PUBLICATION_TAG_BIBLIOGRAPHY = "doc-bibliography"

A list of external sources cited in the work.

const String!

A reference to a bibliography entry.

const String!
PUBLICATION_TAG_CHAPTER = "doc-chapter"

A major thematic section of the work.

const String!
PUBLICATION_TAG_COLOPHON = "doc-colophon"

Production notes for the edition, such as the typeface used.

const String!
PUBLICATION_TAG_CONCLUSION = "doc-conclusion"

A section that summarizes the work or wraps up its narrative.

const String!
PUBLICATION_TAG_COVER = "doc-cover"

A cover image, typically showing the title and author.

const String!
PUBLICATION_TAG_CREDIT = "doc-credit"

An acknowledgment of the source of third-party content, such as a photo.

const String!
PUBLICATION_TAG_CREDITS = "doc-credits"

A collection of credits.

const String!
PUBLICATION_TAG_DEDICATION = "doc-dedication"

An inscription dedicating the work to one or more people.

const String!
PUBLICATION_TAG_ENDNOTES = "doc-endnotes"

A collection of notes at the end of the work or of a section.

const String!
PUBLICATION_TAG_EPIGRAPH = "doc-epigraph"

A quotation at the start of the work or a section that sets its theme or mood.

const String!
PUBLICATION_TAG_EPILOGUE = "doc-epilogue"

A concluding section of narrative that comments on the work's events, typically from a later time.

const String!
PUBLICATION_TAG_ERRATA = "doc-errata"

A list of corrections made after publication.

const String!
PUBLICATION_TAG_EXAMPLE = "doc-example"

An illustration of a key concept, such as a code listing or case study.

const String!
PUBLICATION_TAG_FOOTNOTE = "doc-footnote"

Ancillary information, such as a citation or comment, about a referenced passage.

const String!
PUBLICATION_TAG_FOREWORD = "doc-foreword"

An introductory section, typically written by someone other than the author.

const String!
PUBLICATION_TAG_GLOSSARY = "doc-glossary"

A list of terms used in the work, with their definitions.

const String!

A reference to a glossary definition.

const String!
PUBLICATION_TAG_INDEX = "doc-index"

A detailed list of links to the subjects, names and topics in the work.

const String!
PUBLICATION_TAG_INTRODUCTION = "doc-introduction"

A section that introduces the scope or nature of the work.

const String!

A reference to a footnote or endnote, typically a superscript number or symbol.

const String!
PUBLICATION_TAG_NOTICE = "doc-notice"

A warning about the consequences of an action or event.

const String!
PUBLICATION_TAG_PAGE_BREAK = "doc-pagebreak"

The point where one page of a paginated edition ends and the next begins.

const String!
PUBLICATION_TAG_PAGE_FOOTER = "doc-pagefooter"

Text at the bottom of a page that gives context about the work and the reader's place in it.

const String!
PUBLICATION_TAG_PAGE_HEADER = "doc-pageheader"

Text at the top of a page that gives context about the work and the reader's place in it.

const String!
PUBLICATION_TAG_PAGE_LIST = "doc-pagelist"

A list of links to the page breaks in the content.

const String!

A major division of the work that groups related sections, such as several chapters.

const String!
PUBLICATION_TAG_PREFACE = "doc-preface"

An introductory section, typically written by the author.

const String!
PUBLICATION_TAG_PROLOGUE = "doc-prologue"

An introductory section that sets the background, typically as part of the narrative.

const String!
PUBLICATION_TAG_PULL_QUOTE = "doc-pullquote"

A quotation from the content, set apart to draw attention to it.

const String!

Content structured as questions and answers, such as an interview or FAQ.

const String!
PUBLICATION_TAG_SUBTITLE = "doc-subtitle"

An explanatory or alternate title for the work or a section.

const String!

An ordered list of links to the major headings in the content.

const String!

Helpful information that clarifies the content.

Public constructors

Instantiates a new PublicationInfoCompat.

Public functions

String

Inherited functions

From androidx.core.view.accessibility.AccessibilityNodeInfoCompat.StructuredDataInfoCompat
Boolean
equals(obj: Any?)
String?
getAttribute(attributeKey: String)

Gets the value of an attribute.

(Mutable)Map<String!, String!>

Returns an unmodifiable map of attributes.

Int
Unit
putAttribute(attributeKey: String, value: String)

Adds an attribute.

Unit
removeAttribute(attributeKey: String)

Removes an attribute.

String

Constants

PUBLICATION_TAG_ABSTRACT

const val PUBLICATION_TAG_ABSTRACT = "doc-abstract": String!

A short summary of the work, or of a section or excerpt of it.

PUBLICATION_TAG_ACKNOWLEDGMENTS

const val PUBLICATION_TAG_ACKNOWLEDGMENTS = "doc-acknowledgments": String!

A section that acknowledges contributions to the work.

PUBLICATION_TAG_AFTERWORD

const val PUBLICATION_TAG_AFTERWORD = "doc-afterword": String!

A closing statement, typically about how the work came to be or what followed it.

PUBLICATION_TAG_APPENDIX

const val PUBLICATION_TAG_APPENDIX = "doc-appendix": String!

Supplemental information placed after the main content.

PUBLICATION_TAG_BACK_LINK

const val PUBLICATION_TAG_BACK_LINK = "doc-backlink": String!

A link back to a related location, such as from a note to where it's referenced.

PUBLICATION_TAG_BIBLIOGRAPHY

const val PUBLICATION_TAG_BIBLIOGRAPHY = "doc-bibliography": String!

A list of external sources cited in the work.

PUBLICATION_TAG_BIBLIOGRAPHY_REFERENCE

const val PUBLICATION_TAG_BIBLIOGRAPHY_REFERENCE = "doc-biblioref": String!

A reference to a bibliography entry.

PUBLICATION_TAG_CHAPTER

const val PUBLICATION_TAG_CHAPTER = "doc-chapter": String!

A major thematic section of the work.

PUBLICATION_TAG_COLOPHON

const val PUBLICATION_TAG_COLOPHON = "doc-colophon": String!

Production notes for the edition, such as the typeface used.

PUBLICATION_TAG_CONCLUSION

const val PUBLICATION_TAG_CONCLUSION = "doc-conclusion": String!

A section that summarizes the work or wraps up its narrative.

PUBLICATION_TAG_COVER

const val PUBLICATION_TAG_COVER = "doc-cover": String!

A cover image, typically showing the title and author.

PUBLICATION_TAG_CREDIT

const val PUBLICATION_TAG_CREDIT = "doc-credit": String!

An acknowledgment of the source of third-party content, such as a photo.

PUBLICATION_TAG_CREDITS

const val PUBLICATION_TAG_CREDITS = "doc-credits": String!

A collection of credits.

PUBLICATION_TAG_DEDICATION

const val PUBLICATION_TAG_DEDICATION = "doc-dedication": String!

An inscription dedicating the work to one or more people.

PUBLICATION_TAG_ENDNOTES

const val PUBLICATION_TAG_ENDNOTES = "doc-endnotes": String!

A collection of notes at the end of the work or of a section.

PUBLICATION_TAG_EPIGRAPH

const val PUBLICATION_TAG_EPIGRAPH = "doc-epigraph": String!

A quotation at the start of the work or a section that sets its theme or mood.

PUBLICATION_TAG_EPILOGUE

const val PUBLICATION_TAG_EPILOGUE = "doc-epilogue": String!

A concluding section of narrative that comments on the work's events, typically from a later time.

PUBLICATION_TAG_ERRATA

const val PUBLICATION_TAG_ERRATA = "doc-errata": String!

A list of corrections made after publication.

PUBLICATION_TAG_EXAMPLE

const val PUBLICATION_TAG_EXAMPLE = "doc-example": String!

An illustration of a key concept, such as a code listing or case study.

PUBLICATION_TAG_FOOTNOTE

const val PUBLICATION_TAG_FOOTNOTE = "doc-footnote": String!

Ancillary information, such as a citation or comment, about a referenced passage.

PUBLICATION_TAG_FOREWORD

const val PUBLICATION_TAG_FOREWORD = "doc-foreword": String!

An introductory section, typically written by someone other than the author.

PUBLICATION_TAG_GLOSSARY

const val PUBLICATION_TAG_GLOSSARY = "doc-glossary": String!

A list of terms used in the work, with their definitions.

PUBLICATION_TAG_GLOSSARY_REFERENCE

const val PUBLICATION_TAG_GLOSSARY_REFERENCE = "doc-glossref": String!

A reference to a glossary definition.

PUBLICATION_TAG_INDEX

const val PUBLICATION_TAG_INDEX = "doc-index": String!

A detailed list of links to the subjects, names and topics in the work.

PUBLICATION_TAG_INTRODUCTION

const val PUBLICATION_TAG_INTRODUCTION = "doc-introduction": String!

A section that introduces the scope or nature of the work.

PUBLICATION_TAG_NOTE_REFERENCE

const val PUBLICATION_TAG_NOTE_REFERENCE = "doc-noteref": String!

A reference to a footnote or endnote, typically a superscript number or symbol.

PUBLICATION_TAG_NOTICE

const val PUBLICATION_TAG_NOTICE = "doc-notice": String!

A warning about the consequences of an action or event.

PUBLICATION_TAG_PAGE_BREAK

const val PUBLICATION_TAG_PAGE_BREAK = "doc-pagebreak": String!

The point where one page of a paginated edition ends and the next begins. Its accessible name is normally the number of the page that follows.

PUBLICATION_TAG_PAGE_FOOTER

const val PUBLICATION_TAG_PAGE_FOOTER = "doc-pagefooter": String!

Text at the bottom of a page that gives context about the work and the reader's place in it.

PUBLICATION_TAG_PAGE_HEADER

const val PUBLICATION_TAG_PAGE_HEADER = "doc-pageheader": String!

Text at the top of a page that gives context about the work and the reader's place in it.

PUBLICATION_TAG_PAGE_LIST

const val PUBLICATION_TAG_PAGE_LIST = "doc-pagelist": String!

A list of links to the page breaks in the content.

PUBLICATION_TAG_PART

const val PUBLICATION_TAG_PART = "doc-part": String!

A major division of the work that groups related sections, such as several chapters.

PUBLICATION_TAG_PREFACE

const val PUBLICATION_TAG_PREFACE = "doc-preface": String!

An introductory section, typically written by the author.

PUBLICATION_TAG_PROLOGUE

const val PUBLICATION_TAG_PROLOGUE = "doc-prologue": String!

An introductory section that sets the background, typically as part of the narrative.

PUBLICATION_TAG_PULL_QUOTE

const val PUBLICATION_TAG_PULL_QUOTE = "doc-pullquote": String!

A quotation from the content, set apart to draw attention to it.

PUBLICATION_TAG_QUESTIONS_AND_ANSWERS

const val PUBLICATION_TAG_QUESTIONS_AND_ANSWERS = "doc-qna": String!

Content structured as questions and answers, such as an interview or FAQ.

PUBLICATION_TAG_SUBTITLE

const val PUBLICATION_TAG_SUBTITLE = "doc-subtitle": String!

An explanatory or alternate title for the work or a section.

PUBLICATION_TAG_TABLE_OF_CONTENTS

const val PUBLICATION_TAG_TABLE_OF_CONTENTS = "doc-toc": String!

An ordered list of links to the major headings in the content.

PUBLICATION_TAG_TIP

const val PUBLICATION_TAG_TIP = "doc-tip": String!

Helpful information that clarifies the content.

Public constructors

PublicationInfoCompat

PublicationInfoCompat(tag: String)

Instantiates a new PublicationInfoCompat.

Parameters
tag: String

The publication tag for this node.

Throws
java.lang.IllegalArgumentException

if tag is empty.

Public functions

getTag

fun getTag(): String