HSBeaconArticleSuggestion

Objective-C

@interface HSBeaconArticleSuggestion : NSObject <HSBeaconSuggestionItem>

Swift

class HSBeaconArticleSuggestion : NSObject, HSBeaconSuggestionItem

Provide an article id for suggestion overrides. The article title and url is looked up from Help Scout before rendering the suggestion.

  • Initialize with the specified article id.

    Article IDs can be found in Help Scout by navigating to the article and copying the article ID from the URL. The URL is structured like this: https://secure.helpscout.net/docs/[COLLECTION ID]/article/[ARTICLE ID]/

    Declaration

    Objective-C

    - (nonnull instancetype)initWithId:(nonnull NSString *)articleId;

    Swift

    init(id articleId: String)

  • The article id to look up and show in the suggestions table.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSString *_Nonnull articleId;

    Swift

    var articleId: String { get }

  • Unavailable

    HSBeaconArticleSuggestion objects are immutable, so always initialze with the articleId constructor.

    Declaration

    Objective-C

    - (nonnull instancetype)init;