import ZohoDeskPortalLiveChat

import ZohoDeskPortalAPIKit

@import ZohoDeskPortalAPIKit;

JWTToken

ZohoDeskPortalSDK.logout { (isSuccess: Bool ) in 
    // isSuccess shows whether the logout attempt was successful 
    // any errors will be logged 
}

[ZohoDeskPortalSDK logoutOnCompletion:^(BOOL isSuccess) { 
     // isSuccess shows whether the logout attempt was successful 
     // any errors will be logged 
}];

ZohoDeskPortalSDK.clearAllLocalData()

[ZohoDeskPortalSDK clearAllLocalData];

import ZohoDeskPortalConfiguration

@import ZohoDeskPortalConfiguration;

ZDPThemeManager.setTheme(type: .light)

[ZDPThemeManager setThemeWithType:ZDPThemeTypeLight];

ZDPThemeManager.setTheme(type: .dark)

[ZDPThemeManager setThemeWithType:ZDPThemeTypeDark];

ZDPThemeManager.setTheme(type: .system)

[ZDPThemeManager setThemeWithType:ZDPThemeTypeSystem];

ZDPThemeManager.updateLightTheme(theme: <#ZDPThemeProtocol#>)

[ZDPThemeManager updateLightThemeWithTheme:<#ZDPThemeProtocol#>];

ZDPThemeManager.updateDarkTheme(theme: <#ZDPThemeProtocol#>)

[ZDPThemeManager updateDarkThemeWithTheme:<#ZDPThemeProtocol#>];

ZDPortalConfiguration.customFontName = <#String#>

ZDPortalConfiguration.customFontName = <#NSString#>;

ZDPortalConfiguration.setSDKLanguage(<#String#>)

[ZDPortalConfiguration setSDKLanguage:<#NSString#>];

Customizing UI Strings

func application
(_ application: UIApplication,
didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) 
{ 
let token = deviceToken.reduce
("", {$0 + String(format: "%02X", $1)}).uppercased() 
ZohoDeskPortalSDK.enablePushNotification
(deviceToken:token, mode: .production) 
}

- (void)application:(UIApplication *)application
didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken
{
   NSString * token = [[[[deviceToken description]
   stringByReplacingOccurrencesOfString: @"<" withString: @""]
   stringByReplacingOccurrencesOfString: @">" withString: @""]
   stringByReplacingOccurrencesOfString: @" " withString: @""];
   [ZohoDeskPortalSDK enablePushNotificationWithDeviceToken:<#(NSString * _Nonnull)#> isTestDevice:<#(BOOL)#> mode:<#(enum APNSmode)#>];
}

import ZohoDeskPortalConfiguration 
... 
func application(_ application: UIApplication, 
didReceiveRemoteNotification userInfo: [AnyHashable : Any]) 
{ 
   ZDPortalConfiguration.processRemoteNotification(userInfo: userInfo) 
}

@import ZohoDeskPortalConfiguration; 
... 
- (void)application:(UIApplication *)application 
didReceiveRemoteNotification:(NSDictionary *)userInfo 
fetchCompletionHandler:(void (^)
(UIBackgroundFetchResult))completionHandler
{ 
[ZDPortalConfiguration processRemoteNotificationWithUserInfo:userInfo];
}

import ZohoDeskPortalChat 
   ... 
   ZDPortalChat.setGuestUser(email:<#Guest_User_Email#>, 
   displayName:<#Guest_User_DisplayName#>", 
   phoneNumber: <#Guest_User_PhoneNumber#>")

@import ZohoDeskPortalChat; 
... 
    [ZDPortalChat setGuestUserWithEmail:<#Guest_User_Email#>
    displayName:<#Guest_User_DisplayName#>
    phoneNumber:<#Guest_User_PhoneNumber#>];  

import ZohoDeskPortalAPIKit

@import ZohoDeskPortalAPIKit;

ZohoDeskPortalSDK.getDepartments(onCompletion: 
{ (departments, error) in 
 // on success, departments will return an array, error will return nil 
 // on failure, error will return a value, departments will return nil 
}

[ZohoDeskPortalSDK getDepartmentsOnCompletion:^
(NSArray * departments, NSError * error) 
{ 
 // on success, departments will return an array, error will return nil 
 // on failure, error will return a value, departments will return nil 
}];

ZohoDeskPortalSDK.getProducts(inDepartmentID: <#T##String#>, params: <#T##[String : Any]?#>) 
{ products, error in
// on success, products will return an array, error will return nil
// on failure, error will return a value, products will return nil
}

[ZohoDeskPortalSDK getProductsInDepartmentID:<#NSString#>
params:<#NSDictionary#>onCompletion:^
(NSArray * products, NSError * error) 
{ 
 // on success, products will return an array, error will return nil 
 // on failure, error will return a value, products will return nil 
}];

ZohoDeskPortalSDK.Ticket.getFields(<#T##params: [String : Any]?##[String : Any]?#>) 
{ fields, error in
// on success, fields will return an array, error will return nil
// on failure, error will return a value, products will return nil
}

[ZohoDeskPortalSDKTicket getFields:
<#(NSDictionary * _Nullable)#>onCompletion:^
(NSArray * fields, NSError * error) 
{ 
 // on success, fields will return an array, error will return nil 
 // on failure, error will return a value, fields will return nil 
}];

ZohoDeskPortalSDK.Ticket.addAttachment(with:<#Data#>, 
andName:<#String#>, using: <#ZDPUploaderDelegate?#>) 
{ (attachment, error) in 
 // on success, attachment will return a value, error will return nil 
 // on failure, error will return a value, attachment will return nil 
}

[ZohoDeskPortalSDKTicket addAttachmentWith:
<#NSData#>andName:<#NSString#>using:
<#(id _Nullable)#>onCompletion:^
(ZDPortalAttachment * attachment, NSError * error) 
{ 
// on success, attachment will return a value, error will return nil 
// on failure, error will return a value, attachment will return nil 
}];

if ZohoDeskPortalSDK.isUserLoggedIn 
{ 
    ZohoDeskPortalSDK.Ticket.add(withFields:<#T##[String : Any]#>)
    { (ticket, error) in 
   // on success, ticket will return an object, 
		error will return nil 
   // on failure, error will return a value, 
		ticket will return nil 
    } 
} else 
{ 
    ZohoDeskPortalSDK.Ticket.addAsGuest
	(withFields: <#T##[String : Any]#>) 
    { (ticketNumber, error) in 
    // on success, ticketNumber will return a string value, 
		error will return nil 
    // on failure, error will return a value, 
		ticketNumber will return nil 
    } 
}

if (ZohoDeskPortalSDK.isUserLoggedIn)
{
        [ZohoDeskPortalSDKTicket addWithFields:<#(NSDictionary * _Nonnull)#> onCompletion:^(ZDPTicket * ticket, NSError * error)
    {
        	// on success, ticket will return an object, error will return nil
        	// on failure, error will return a value, ticket will return nil
        }];
}
else
{
        [ZohoDeskPortalSDKTicket addAsGuestWithFields:
        <#(NSDictionary * _Nonnull)#> onCompletion:^(NSString * ticketNumber, NSError * error)
        {
        	// on success, ticketNumber will return a string value, error will return nil
        	// on failure, error will return a value, ticketNumber will return nil
        }]
}

ZDPCommunityConfiguration.isTopicEditAllowed = <#Bool#> 
ZDPCommunityConfiguration.isTopicDeleteAllowed = <#Bool#> 
ZDPCommunityConfiguration.isReplyAllowed = <#Bool#> 
ZDPCommunityConfiguration.iReplyEditAllowed = <#Bool#> 
ZDPCommunityConfiguration.isReplyDeleteAllowed = <#Bool#>

ZDPCommunityConfiguration.isTopicEditAllowed = <#Bool#>; 
    ZDPCommunityConfiguration.isTopicDeleteAllowed = <#Bool#>; 
    ZDPCommunityConfiguration.isReplyAllowed = <#Bool#>; 
    ZDPCommunityConfiguration.isReplyEditAllowed = <#Bool#>; 
    ZDPCommunityConfiguration.isReplyDeleteAllowed = <#Bool#>;

ZohoDeskPortalSDK.Community.getMostPopularTopics(<#T##params: [String : Any]?##[String : Any]?#>)
{ topics, error in
// switch on result to get array of topics on success 
}

[ZohoDeskPortalSDKCommunity getMostPopularTopics:
    <#(NSDictionary * _Nullable)#> onCompletion:^(NSArray * topics, NSError * error)
{
// on success, topics will return an array, error will return nil
// on failure, error will return a value, topics will return nil
}];

ZohoDeskPortalSDK.Community.getMostDisuccedTopics(<#T##params: [String : Any]?##[String : Any]?#>) 
{ topics, error in
// on success, topics will return an array, error will return nil
// on failure, error will return a value, products will return nil 
}

[ZohoDeskPortalSDKCommunity getMostDisuccedTopics:
    <#(NSDictionary * _Nullable)#> onCompletion:^(NSArray * topics, NSError * error)
{
// on success, topics will return an array, error will return nil
// on failure, error will return a value, topics will return nil
}];

ZDPortalSubmitTicket.setFieldsListTobeShown
(fields: <#[ZDVisibleTicketField]#>)

[ZDPortalSubmitTicket setFieldsListTobeShownWithFields:
<#(NSArray * _Nonnull)#>];

ZDPortalSubmitTicket.preFillTicketFields(forForms: <#[ZDCustomizedTicketForm]#>)

[ZDPortalSubmitTicket preFillTicketFieldsForForms:<#[ZDCustomizedTicketForm]#>];

ZDPTicketConfiguration.configure.isAddTicketAllowed = <#Bool#>
ZDPTicketConfiguration.configure.isReplyAllowed = <#Bool#>
ZDPTicketConfiguration.configure.isCommentAllowed = <#Bool#>
ZDPTicketConfiguration.configure.isCommentEditAllowed = <#Bool#>
ZDPTicketConfiguration.configure.isTicketUpdateAllowed = <#Bool#>
ZDPTicketConfiguration.configure.isCommentDeleteAllowed = <#Bool#>
ZDPTicketConfiguration.configure.isCustomerHappinessThreadAllowed = <#Bool#>

import ZohoDeskPortalAPIKit 
    ... 
    var body = [String : Any]() 
    body["displayName"] = "displayName" 
    body["mobile"] = "123456" 

ZohoDeskPortalSDK.updateUserInformation(with: body) 
{ profile, error in
// on success only profile will return a value, error will return nil
// on failure only error will return a value, profile will return nil
}

NSMutableDictionary * body = [NSMutableDictionary new]; 
    [body setObject:@"displayName" forKey:@"displayName"]; 
    [body setObject:@"123456" forKey:@"mobile"]; 
    [ZohoDeskPortalSDK updateUserInformationWith:body onCompletion:
	^(Profile * profile, NSError * error) 
{ 
    // on success only profile will return a value, error will return nil 
    // on failure only error will return a value, profile will return nil 
}];

ASAP configuration

let configuration = ZDPConfiguration()
configuration.disableSidemenu = true
configuration.disableLanguageChooser = true
configuration.disablePoweredByZoho = true
ZDPortalConfiguration.set(configuration: configuration)

ZDPConfiguration * configuration = [ZDPConfiguration init];
configuration.disableSidemenu = YES;
configuration.disableLanguageChooser = YES;
configuration.disablePoweredByZoho = YES;
[ZDPortalConfiguration setWithConfiguration:configuration];

SDK Logging

import ZohoDeskPortalAPIKit 
    ... 
    ZohoDeskPortalSDK.enableLogs()

@import ZohoDeskPortalAPIKit;
...

[ZohoDeskPortalSDK enableLogs];

Release Notes

3.0.0-beta-17

1. We implemented the Text-To-Speech and the In-Article Search features for the KB Articles.
   

3.0.0-beta-16

• We handled the Nested pick list in the ASAP SDK Tickets module.

3.0.0-beta-15

• We have provided module-level configuration; you can now easily enable or disable modules throughout the mobile SDK.

3.0.0-beta-14

• Handled the miscellaneous bug issue in the SalesIQ Livechat for a single department.

3.0.0-beta-13

• We integrated the latest SalesIQ SDK version 5.4.1.
• Highlighted the search text.
  

3.0.0-beta-12

• Supported the theme APIs in Objective-C language.

3.0.0-beta-11

1. Provided an option to edit the Ticket Properties within the ASAP SDK.
   

3.0.0-beta-10

1. Implemented login support with JWT token in Objective-C language. For more information, refer "JWTToken " under Authenticating Users in the SDK

3.0.0-beta-9

1. Included arm64 architecture for simulator.
   

3.0.0-beta-8

1. Handled issues faced in the dark theme for the Article detail, Topic detail, and conversation screens.
2. Handled the issue with the bot's customised name reflection in Guided Conversation.
3. Error logs are disabled by default. To enable the error log, refer SDK Logging.
   

3.0.0-beta-7

1. Performance tuning. 
   

3.0.0-beta-6

1. A new independent method has been introduced to receive a callback on create ticket. The old call method has been deprecated. For more information, refer "Submit Ticket event with subscription" under Customizing the Tickets module.
2. Provided an option to disable the side-menu, language chooser, and Zoho footer, "powered by ASAP label." For more information, refer ASAP configuration.

3.0.0-beta-5

• Fixed the problem of uploading attachments faced in iOS 13.
  

• Resolved the problem with the custom title in the Community module.
  

• Handled Configuration for customer happiness thread. For more information, refer "Custom-Configuring Ticket Actions" under Customizing the Tickets module.

• Handled the miscellaneous bug fixes.

3.0.0-beta-4      

• Fixed the navigation issue in Submit Ticket case.

3.0.0-beta-3

1. Supported ASAP switch within your application: While switching to a new ASAP, the customer initializes a new session with a new set of ASAP keys (OrgID, AppID). The new session is established by killing the current session and initialize a new one based on the new keys(OrgID, AppID).
   
2. Supported login using JWT token: You can now allow users to log in using a JWT token in the new authentication flow. For more information, refer "JWTToken " under Authenticating Users in the SDK.
3. UI enhancement and performance tuning.

Migrating from v2.x to v3.0  

The following tables list the changes you need to make to ensure a smooth migration.

Added separate method to set Home configuration 

Theme API changes