Code Examples‎ > ‎HV2 API Explore‎ > ‎

Topics

Contents

    No headings.

    The Topics page demonstrates the remaining couple of help API calls. You can explore the code for yourself. Here are just a few notes.

    IStream GetIndexedTopic(ICatalog catalog, string topicId, IHelpFilter filter)
    • Given a topic ID returns a stream for the matching catalog topic. You can filter but we leave this null for the demo.
    ITopic GetIndexedTopicDetails(ICatalog catalog, string topicId, IHelpFilter filter)
    • Given a topic ID returns a Topic object for the matching catalog topic. The Topic Object also contains a FetchContent() method that returns the topic stream.
    IStream GetLinkedAsset(ICatalog catalog, string packageName, string path, string locale)
    • Here you can get the stream to any file in a catalog help file.
    • Note that Get Asset call is not effected by the 2 radio buttons above the entry fields.
    IStream GetTopicForF1Keyword(ICatalog catalog, string[] prioritizedF1Keywords, IHelpFilter filter)
    • Given a valid F1 keyword (or list of F1 keywords) returns a stream for the best matching catalog topic.
    ITopic GetTopicDetailsForF1Keyword(ICatalog catalog, string[] prioritizedF1Keywords, IHelpFilter filter)
    • Given a valid F1 keyword (or list of F1 kewords) returns a Topic object for the best matching catalog topic.


    Comments