SCSArticle Class Reference

Inherits from NSObject
Declared in SCSArticle.h

Overview

A SCSArticle object represents a knowledge base article.

This article may or may not already be downloaded locally. Use the [SCSArticle isArticleContentDownloaded] property to check whether it is downloaded. You can download the article with the [SCSArticle downloadContentWithOptions:completion:] method.

  articleId

Unique article ID.

@property (nonatomic, copy, readonly) NSString *articleId

Declared In

SCSArticle.h

  articleNumber

Article number.

@property (nonatomic, copy, readonly) NSString *articleNumber

Declared In

SCSArticle.h

  summary

Summary text for the article.

@property (nonatomic, copy, readonly) NSString *summary

Declared In

SCSArticle.h

  title

Article title.

@property (nonatomic, copy, readonly) NSString *title

Declared In

SCSArticle.h

  lastPublishedDate

Last published date for this article.

@property (nonatomic, strong, readonly) NSDate *lastPublishedDate

Declared In

SCSArticle.h

  storageUsed

Amount of local storage (in bytes) used for this article.

@property (nonatomic, assign, readonly) NSUInteger storageUsed

Declared In

SCSArticle.h

  lastAccessedDate

Date article was last accessed.

@property (nonatomic, copy, readonly) NSDate *lastAccessedDate

Declared In

SCSArticle.h

  manager

Knowledge manager instance this article belongs to

@property (nonatomic, weak, readonly) SCSKnowledgeManager *manager

Declared In

SCSArticle.h

  stale

Returns true if the article details stored in local storage gets stale

@property (nonatomic, readonly, getter=isStale) BOOL stale

Declared In

SCSArticle.h

– downloadContentWithOptions:completion:

Downloads article contents.

- (void)downloadContentWithOptions:(SCSArticleDownloadOption)options completion:(nullable void ( ^ ) ( NSError *__nullable error ))completionBlock

Parameters

options

Cache options defining exactly what content to download. See SCSArticleDownloadOption.

completionBlock

The block to execute after download completes. You may specify nil for this parameter.

Declared In

SCSArticle.h

– isArticleContentDownloaded

Whether article content has been downloaded.

- (BOOL)isArticleContentDownloaded

Declared In

SCSArticle.h

– isAssociatedContentDownloaded

Whether associated article content (such as images) have been downloaded

- (BOOL)isAssociatedContentDownloaded

Declared In

SCSArticle.h

– deleteCache:

Delete the cache for the article.

- (BOOL)deleteCache:(NSError *_Nullable *_Nullable)error

Parameters

error

Error that occurs during deletion, if applicable.

Return Value

YES if the article has been deleted. *

Declared In

SCSArticle.h