Skip to content

Commit 573f96e

Browse files
Release 10.0.0
1 parent cf2b262 commit 573f96e

File tree

201 files changed

+5584
-266
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

201 files changed

+5584
-266
lines changed

CHANGELOG.md

Lines changed: 17 additions & 0 deletions

Intercom.podspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Pod::Spec.new do |s|
22
s.name = 'Intercom'
3-
s.version = '9.3.6'
3+
s.version = '10.0.0'
44
s.summary = 'The Intercom iOS SDK, for integrating Intercom into your iOS application.'
55
s.license = { :type => "Apache 2.0", :file => "LICENSE" }
66
s.authors = {"Brian Boyle"=>"[email protected]", "Mike McNamara"=>"[email protected]", "Katherine Brennan"=>"[email protected]", "Himanshi Goyal"=>"[email protected]"}
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
//
2+
// ICMHelpCenterArticle.h
3+
// IntercomSDK-Dynamic
4+
//
5+
// Created by Michael McNamara on 03/06/2021.
6+
// Copyright © 2021 Intercom. All rights reserved.
7+
//
8+
9+
#import <Foundation/Foundation.h>
10+
11+
NS_ASSUME_NONNULL_BEGIN
12+
13+
/**
14+
ICMHelpCenterArticle represents a Help Center article.
15+
*/
16+
NS_SWIFT_NAME(HelpCenterArticle)
17+
@interface ICMHelpCenterArticle : NSObject
18+
19+
/**
20+
The id of this article.
21+
*/
22+
@property (nonatomic, copy) NSString *articleId;
23+
24+
/**
25+
The title of this article.
26+
*/
27+
@property (nonatomic, copy) NSString *title;
28+
29+
- (instancetype)initWithArticleId:(NSString *)articleId
30+
title:(NSString *)title;
31+
32+
@end
33+
34+
NS_ASSUME_NONNULL_END
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
//
2+
// ICMHelpCenterArticleSearchResult.h
3+
// IntercomSDK-Dynamic
4+
//
5+
// Created by Michael McNamara on 04/06/2021.
6+
// Copyright © 2021 Intercom. All rights reserved.
7+
//
8+
9+
#import <Foundation/Foundation.h>
10+
11+
NS_ASSUME_NONNULL_BEGIN
12+
13+
/**
14+
ICMHelpCenterArticleSearchResult represents the result of a Help Center search.
15+
*/
16+
NS_SWIFT_NAME(HelpCenterArticleSearchResult)
17+
@interface ICMHelpCenterArticleSearchResult : NSObject
18+
19+
/**
20+
The id of this article.
21+
*/
22+
@property (nonatomic, copy) NSString *articleId;
23+
24+
/**
25+
The title of this article.
26+
*/
27+
@property (nonatomic, copy) NSString *title;
28+
29+
/**
30+
The summary of this article.
31+
*/
32+
@property (nonatomic, copy) NSString *summary;
33+
34+
/**
35+
A snippet of this article that matches the search term.
36+
*/
37+
@property (nonatomic, copy) NSString *matchingSnippet;
38+
39+
- (instancetype)initWithArticleId:(NSString *)articleId
40+
title:(NSString *)title
41+
summary:(nullable NSString *)summary
42+
matchingSnippet:(nullable NSString *)matchingSnippet;
43+
44+
@end
45+
46+
NS_ASSUME_NONNULL_END
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
//
2+
// ICMHelpCenterCollection.h
3+
// IntercomSDK-Dynamic
4+
//
5+
// Created by Michael McNamara on 26/05/2021.
6+
// Copyright © 2021 Intercom. All rights reserved.
7+
//
8+
9+
#import <Foundation/Foundation.h>
10+
11+
NS_ASSUME_NONNULL_BEGIN
12+
13+
/**
14+
ICMHelpCenterCollection represents a Help Center collection.
15+
*/
16+
NS_SWIFT_NAME(HelpCenterCollection)
17+
@interface ICMHelpCenterCollection : NSObject
18+
19+
/**
20+
The id of this collection.
21+
*/
22+
@property (nonatomic, copy) NSString *collectionId;
23+
24+
/**
25+
The title of this collection.
26+
*/
27+
@property (nonatomic, copy) NSString *title;
28+
29+
/**
30+
A summary of this collection.
31+
*/
32+
@property (nonatomic, copy, nullable) NSString *summary;
33+
34+
- (instancetype)initWithCollectionId:(NSString *)collectionId
35+
title:(NSString *)title
36+
summary:(nullable NSString *)summary;
37+
38+
@end
39+
40+
NS_ASSUME_NONNULL_END
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
//
2+
// ICMHelpCenterCollectionContent.h
3+
// IntercomSDK-Dynamic
4+
//
5+
// Created by Michael McNamara on 03/06/2021.
6+
// Copyright © 2021 Intercom. All rights reserved.
7+
//
8+
9+
#import <Foundation/Foundation.h>
10+
@class ICMHelpCenterArticle;
11+
@class ICMHelpCenterSection;
12+
13+
NS_ASSUME_NONNULL_BEGIN
14+
15+
/**
16+
ICMHelpCenterCollection represents a Help Center collection and its contents.
17+
*/
18+
NS_SWIFT_NAME(HelpCenterCollectionContent)
19+
@interface ICMHelpCenterCollectionContent : NSObject
20+
21+
/**
22+
The id of this collection.
23+
*/
24+
@property (nonatomic, copy) NSString *collectionId;
25+
26+
/**
27+
The title of this collection.
28+
*/
29+
@property (nonatomic, copy) NSString *title;
30+
31+
/**
32+
A summary of this collection.
33+
*/
34+
@property (nonatomic, copy, nullable) NSString *summary;
35+
36+
/**
37+
The articles contained in this collection.
38+
*/
39+
@property (nonatomic, strong) NSArray<ICMHelpCenterArticle *> *articles;
40+
41+
/**
42+
The sections contained in this collection.
43+
*/
44+
@property (nonatomic, strong) NSArray<ICMHelpCenterSection *> *sections;
45+
46+
- (instancetype)initWithCollectionId:(NSString *)collectionId
47+
title:(NSString *)title
48+
summary:(nullable NSString *)summary
49+
articles:(NSArray<ICMHelpCenterArticle *> *)articles
50+
sections:(NSArray<ICMHelpCenterSection *> *)sections;
51+
52+
53+
@end
54+
55+
NS_ASSUME_NONNULL_END
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
//
2+
// ICMHelpCenterDataError.h
3+
// IntercomSDK-Dynamic
4+
//
5+
// Created by Michael McNamara on 08/06/2021.
6+
// Copyright © 2021 Intercom. All rights reserved.
7+
//
8+
9+
#import <Foundation/Foundation.h>
10+
11+
NS_ASSUME_NONNULL_BEGIN
12+
13+
extern NSErrorDomain const ICMHelpCenterDataErrorDomain;
14+
15+
typedef NS_ERROR_ENUM(ICMHelpCenterDataErrorDomain, ICMHelpCenterDataError) {
16+
contentNotAvailable = 1,
17+
networkError,
18+
somethingWentWrong,
19+
noUserRegistered,
20+
noAppRegistered
21+
};
22+
23+
NS_ASSUME_NONNULL_END
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
//
2+
// ICMHelpCenterSection.h
3+
// IntercomSDK-Dynamic
4+
//
5+
// Created by Michael McNamara on 03/06/2021.
6+
// Copyright © 2021 Intercom. All rights reserved.
7+
//
8+
9+
#import <Foundation/Foundation.h>
10+
@class ICMHelpCenterArticle;
11+
12+
NS_ASSUME_NONNULL_BEGIN
13+
14+
/**
15+
ICMHelpCenterSection represents a Help Center section.
16+
*/
17+
NS_SWIFT_NAME(HelpCenterSection)
18+
@interface ICMHelpCenterSection : NSObject
19+
20+
/**
21+
The title of this section.
22+
*/
23+
@property (nonatomic, copy) NSString *title;
24+
25+
/**
26+
The articles contained in this section.
27+
*/
28+
@property (nonatomic, strong) NSArray<ICMHelpCenterArticle *> *articles;
29+
30+
- (instancetype)initWithTitle:(NSString *)title
31+
articles:(NSArray<ICMHelpCenterArticle *> *)articles;
32+
33+
@end
34+
35+
NS_ASSUME_NONNULL_END

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

Lines changed: 41 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@
99
#import <Foundation/Foundation.h>
1010
#import <UIKit/UIKit.h>
1111
#import <Intercom/ICMUserAttributes.h>
12+
#import <Intercom/ICMHelpCenterCollection.h>
13+
#import <Intercom/ICMHelpCenterSection.h>
14+
#import <Intercom/ICMHelpCenterArticle.h>
15+
#import <Intercom/ICMHelpCenterCollectionContent.h>
16+
#import <Intercom/ICMHelpCenterArticleSearchResult.h>
17+
#import <Intercom/ICMHelpCenterDataError.h>
1218

1319
NS_ASSUME_NONNULL_BEGIN
1420

@@ -244,21 +250,50 @@ NS_ASSUME_NONNULL_BEGIN
244250
*/
245251
+ (void)presentConversationList __attribute((deprecated("'+[Intercom presentConversationList]' is deprecated. 'Use +[Intercom presentMessenger]' instead.")));;
246252

247-
#pragma mark - Help Center
253+
#pragma mark - Help Center UI
248254

249255
/*!
250-
Present the help center.
256+
Present the Help Center.
251257
*/
252258
+ (void)presentHelpCenter;
253259

254-
#pragma mark - Articles
260+
/*!
261+
Present the Help Center with specific collections only.
262+
- Note: If the requested collections cannot be found, the full Help Center will be shown instead.
263+
@param collectionIds The ID of the collections to be presented.
264+
*/
265+
+ (void)presentHelpCenterCollections:(nonnull NSArray<NSString *> *)collectionIds;
255266

256267
/*!
257268
Present an article.
258269
@param articleId The ID of the article to be presented.
259270
*/
260271
+ (void)presentArticle:(nonnull NSString *)articleId;
261272

273+
#pragma mark - Help Center Data API
274+
275+
/*!
276+
Fetch all Help Center collections.
277+
@param completion A completion callback with two parameters: an array of collections or an error.
278+
*/
279+
+ (void)fetchHelpCenterCollectionsWithCompletion:(void (^)(NSArray<ICMHelpCenterCollection *> *_Nullable collections, NSError *_Nullable error))completion NS_REFINED_FOR_SWIFT;
280+
281+
/*!
282+
Fetch the contents of a Help Center collection.
283+
@param collectionId The ID of the Help Center collection.
284+
@param completion A completion callback with two parameters: a collection content object or an error.
285+
*/
286+
+ (void)fetchHelpCenterCollection:(nonnull NSString *)collectionId
287+
withCompletion:(void (^)(ICMHelpCenterCollectionContent *_Nullable collectionContent, NSError *_Nullable error))completion NS_REFINED_FOR_SWIFT;
288+
289+
/*!
290+
Search the Help Center.
291+
@param searchTerm The search string.
292+
@param completion A completion callback with two parameters: an array of search results or an error.
293+
*/
294+
+ (void)searchHelpCenter:(nonnull NSString *)searchTerm
295+
withCompletion:(void (^)(NSArray<ICMHelpCenterArticleSearchResult *> *_Nullable articleSearchResults, NSError *_Nullable error))completion NS_REFINED_FOR_SWIFT;
296+
262297
#pragma mark - Mobile Carousels
263298

264299
/*!
@@ -337,10 +372,10 @@ NS_ASSUME_NONNULL_BEGIN
337372
+ (void)setLauncherVisible:(BOOL)visible;
338373

339374
/*!
340-
Hide the Intercom messenger, if it is on screen.
341-
This can be useful if your app wishes to get the users attention (e.g. opening an in app link).
375+
Hide all Intercom windows that are currently displayed.
376+
This will hide the Messenger, Help Center, Articles, and in-product messages (eg. Mobile Carousels, chats, and posts).
342377
*/
343-
+ (void)hideMessenger;
378+
+ (void)hideIntercom;
344379

345380
#pragma mark - Unread Conversation Count
346381

1 Byte
Binary file not shown.

0 commit comments

Comments
 (0)