Release 10.0.0

CHANGELOG.md

@@ -1,3 +1,20 @@
+## 10.0.0 
+###### Release Date: 16-06-2021
+
+### Enhancements
+We have redesigned the Help Center for mobile apps. ✨
+* New UI, optimized specifically for mobile apps and small screens
+* Type-ahead search to help users find answers quicker than ever
+* Control whether users open up a specific collection of articles, a group of collections, or specific search results
+* Localization - with right to left language display
+* Accessibility support: screen readers, dynamic font sizes, and keyboard navigation - to support all end users
+* New Help Center Data API that enables you to build your own help center UI, enabling a much deeper and custom integration into your app.
+
+### Bug Fixes
+* Fixed a bug that was preventing the contents of a Post message from rendering correctly in a conversation.
+
+![ios_-_help_center](https://user-images.githubusercontent.com/3185423/122072764-c7ece100-cdef-11eb-93bb-52e38c168c18.gif)
+
 ## 9.3.6 
 ###### Release Date: 06-05-2021
 

Intercom.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name                = 'Intercom'
-  s.version             = '9.3.6'
+  s.version             = '10.0.0'
   s.summary             = 'The Intercom iOS SDK, for integrating Intercom into your iOS application.'
   s.license             = { :type => "Apache 2.0", :file => "LICENSE" }
   s.authors             = {"Brian Boyle"=>"brian.boyle@intercom.io", "Mike McNamara"=>"mike.mcnamara@intercom.io", "Katherine Brennan"=>"katherine.brennan@intercom.io", "Himanshi Goyal"=>"himanshi.goyal@intercom.io"}

Intercom.xcframework/ios-arm64_armv7/Intercom.framework/Headers/ICMHelpCenterArticle.h

@@ -0,0 +1,34 @@
+//
+//  ICMHelpCenterArticle.h
+//  IntercomSDK-Dynamic
+//
+//  Created by Michael McNamara on 03/06/2021.
+//  Copyright © 2021 Intercom. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ ICMHelpCenterArticle represents a Help Center article.
+*/
+NS_SWIFT_NAME(HelpCenterArticle)
+@interface ICMHelpCenterArticle : NSObject
+
+/**
+ The id of this article.
+ */
+@property (nonatomic, copy) NSString *articleId;
+
+/**
+ The title of this article.
+ */
+@property (nonatomic, copy) NSString *title;
+
+- (instancetype)initWithArticleId:(NSString *)articleId
+                          title:(NSString *)title;
+
+@end
+
+NS_ASSUME_NONNULL_END

Intercom.xcframework/ios-arm64_armv7/Intercom.framework/Headers/ICMHelpCenterArticleSearchResult.h

@@ -0,0 +1,46 @@
+//
+//  ICMHelpCenterArticleSearchResult.h
+//  IntercomSDK-Dynamic
+//
+//  Created by Michael McNamara on 04/06/2021.
+//  Copyright © 2021 Intercom. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ ICMHelpCenterArticleSearchResult represents the result of a Help Center search.
+*/
+NS_SWIFT_NAME(HelpCenterArticleSearchResult)
+@interface ICMHelpCenterArticleSearchResult : NSObject
+
+/**
+ The id of this article.
+ */
+@property (nonatomic, copy) NSString *articleId;
+
+/**
+ The title of this article.
+ */
+@property (nonatomic, copy) NSString *title;
+
+/**
+ The summary of this article.
+ */
+@property (nonatomic, copy) NSString *summary;
+
+/**
+ A snippet of this article that matches the search term.
+ */
+@property (nonatomic, copy) NSString *matchingSnippet;
+
+- (instancetype)initWithArticleId:(NSString *)articleId
+                            title:(NSString *)title
+                          summary:(nullable NSString *)summary
+                  matchingSnippet:(nullable NSString *)matchingSnippet;
+
+@end
+
+NS_ASSUME_NONNULL_END

Intercom.xcframework/ios-arm64_armv7/Intercom.framework/Headers/ICMHelpCenterCollection.h

@@ -0,0 +1,40 @@
+//
+//  ICMHelpCenterCollection.h
+//  IntercomSDK-Dynamic
+//
+//  Created by Michael McNamara on 26/05/2021.
+//  Copyright © 2021 Intercom. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ ICMHelpCenterCollection represents a Help Center collection.
+*/
+NS_SWIFT_NAME(HelpCenterCollection)
+@interface ICMHelpCenterCollection : NSObject
+
+/**
+ The id of this collection.
+ */
+@property (nonatomic, copy) NSString *collectionId;
+
+/**
+ The title of this collection.
+ */
+@property (nonatomic, copy) NSString *title;
+
+/**
+ A summary of this collection.
+ */
+@property (nonatomic, copy, nullable) NSString *summary;
+
+- (instancetype)initWithCollectionId:(NSString *)collectionId
+                               title:(NSString *)title
+                             summary:(nullable NSString *)summary;
+
+@end
+
+NS_ASSUME_NONNULL_END

Intercom.xcframework/ios-arm64_armv7/Intercom.framework/Headers/ICMHelpCenterCollectionContent.h

@@ -0,0 +1,55 @@
+//
+//  ICMHelpCenterCollectionContent.h
+//  IntercomSDK-Dynamic
+//
+//  Created by Michael McNamara on 03/06/2021.
+//  Copyright © 2021 Intercom. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+@class ICMHelpCenterArticle;
+@class ICMHelpCenterSection;
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ ICMHelpCenterCollection represents a Help Center collection and its contents. 
+*/
+NS_SWIFT_NAME(HelpCenterCollectionContent)
+@interface ICMHelpCenterCollectionContent : NSObject
+
+/**
+ The id of this collection.
+ */
+@property (nonatomic, copy) NSString *collectionId;
+
+/**
+ The title of this collection.
+ */
+@property (nonatomic, copy) NSString *title;
+
+/**
+ A summary of this collection.
+ */
+@property (nonatomic, copy, nullable) NSString *summary;
+
+/**
+ The articles contained in this collection.
+ */
+@property (nonatomic, strong) NSArray<ICMHelpCenterArticle *> *articles;
+
+/**
+ The sections contained in this collection.
+ */
+@property (nonatomic, strong) NSArray<ICMHelpCenterSection *> *sections;
+
+- (instancetype)initWithCollectionId:(NSString *)collectionId
+                               title:(NSString *)title
+                             summary:(nullable NSString *)summary
+                            articles:(NSArray<ICMHelpCenterArticle *> *)articles
+                            sections:(NSArray<ICMHelpCenterSection *> *)sections;
+
+
+@end
+
+NS_ASSUME_NONNULL_END

Intercom.xcframework/ios-arm64_armv7/Intercom.framework/Headers/ICMHelpCenterDataError.h

@@ -0,0 +1,23 @@
+//
+//  ICMHelpCenterDataError.h
+//  IntercomSDK-Dynamic
+//
+//  Created by Michael McNamara on 08/06/2021.
+//  Copyright © 2021 Intercom. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+extern NSErrorDomain const ICMHelpCenterDataErrorDomain;
+
+typedef NS_ERROR_ENUM(ICMHelpCenterDataErrorDomain, ICMHelpCenterDataError) {
+    contentNotAvailable = 1,
+    networkError,
+    somethingWentWrong,
+    noUserRegistered,
+    noAppRegistered
+};
+
+NS_ASSUME_NONNULL_END

Intercom.xcframework/ios-arm64_armv7/Intercom.framework/Headers/ICMHelpCenterSection.h

@@ -0,0 +1,35 @@
+//
+//  ICMHelpCenterSection.h
+//  IntercomSDK-Dynamic
+//
+//  Created by Michael McNamara on 03/06/2021.
+//  Copyright © 2021 Intercom. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+@class ICMHelpCenterArticle;
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ ICMHelpCenterSection represents a Help Center section.
+*/
+NS_SWIFT_NAME(HelpCenterSection)
+@interface ICMHelpCenterSection : NSObject
+
+/**
+ The title of this section.
+ */
+@property (nonatomic, copy) NSString *title;
+
+/**
+ The articles contained in this section.
+ */
+@property (nonatomic, strong) NSArray<ICMHelpCenterArticle *> *articles;
+
+- (instancetype)initWithTitle:(NSString *)title
+                     articles:(NSArray<ICMHelpCenterArticle *> *)articles;
+
+@end
+
+NS_ASSUME_NONNULL_END

Intercom.xcframework/ios-arm64_armv7/Intercom.framework/Headers/Intercom.h

@@ -9,6 +9,12 @@
 #import <Foundation/Foundation.h>
 #import <UIKit/UIKit.h>
 #import <Intercom/ICMUserAttributes.h>
+#import <Intercom/ICMHelpCenterCollection.h>
+#import <Intercom/ICMHelpCenterSection.h>
+#import <Intercom/ICMHelpCenterArticle.h>
+#import <Intercom/ICMHelpCenterCollectionContent.h>
+#import <Intercom/ICMHelpCenterArticleSearchResult.h>
+#import <Intercom/ICMHelpCenterDataError.h>
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -244,21 +250,50 @@ NS_ASSUME_NONNULL_BEGIN
  */
 + (void)presentConversationList __attribute((deprecated("'+[Intercom presentConversationList]' is deprecated. 'Use +[Intercom presentMessenger]' instead.")));;
 
-#pragma mark - Help Center
+#pragma mark - Help Center UI
 
 /*!
- Present the help center.
+ Present the Help Center.
  */
 + (void)presentHelpCenter;
 
-#pragma mark - Articles
+/*!
+ Present the Help Center with specific collections only.
+ - Note: If the requested collections cannot be found, the full Help Center will be shown instead.
+ @param collectionIds The ID of the collections to be presented.
+ */
++ (void)presentHelpCenterCollections:(nonnull NSArray<NSString *> *)collectionIds;
 
 /*!
  Present an article.
  @param articleId The ID of the article to be presented.
  */
 + (void)presentArticle:(nonnull NSString *)articleId;
 
+#pragma mark - Help Center Data API
+
+/*!
+ Fetch all Help Center collections.
+ @param completion A completion callback with two parameters: an array of collections or an error.
+ */
++ (void)fetchHelpCenterCollectionsWithCompletion:(void (^)(NSArray<ICMHelpCenterCollection *> *_Nullable collections, NSError *_Nullable error))completion NS_REFINED_FOR_SWIFT;
+
+/*!
+ Fetch the contents of a Help Center collection.
+ @param collectionId The ID of the Help Center collection.
+ @param completion A completion callback with two parameters: a collection content object or an error.
+ */
++ (void)fetchHelpCenterCollection:(nonnull NSString *)collectionId
+                   withCompletion:(void (^)(ICMHelpCenterCollectionContent *_Nullable collectionContent, NSError *_Nullable error))completion NS_REFINED_FOR_SWIFT;
+
+/*!
+ Search the Help Center.
+ @param searchTerm The search string.
+ @param completion A completion callback with two parameters: an array of search results or an error.
+ */
++ (void)searchHelpCenter:(nonnull NSString *)searchTerm
+                   withCompletion:(void (^)(NSArray<ICMHelpCenterArticleSearchResult *> *_Nullable articleSearchResults, NSError *_Nullable error))completion NS_REFINED_FOR_SWIFT;
+
 #pragma mark - Mobile Carousels
 
 /*!
@@ -337,10 +372,10 @@ NS_ASSUME_NONNULL_BEGIN
 + (void)setLauncherVisible:(BOOL)visible;
 
 /*!
- Hide the Intercom messenger, if it is on screen.
- This can be useful if your app wishes to get the users attention (e.g. opening an in app link).
+ Hide all Intercom windows that are currently displayed.
+ This will hide the Messenger, Help Center, Articles, and in-product messages (eg. Mobile Carousels, chats, and posts).
  */
-+ (void)hideMessenger;
++ (void)hideIntercom;
 
 #pragma mark - Unread Conversation Count