15.2

In December, 2022, Help Lightning released 15.2 of its server and client SDKs. The changes were minor, but the client SDKs bring new bug fixed and UI/UX enhancements, and the server API has some additional features.

Server Changes

The primary changes in the server are:

Alternate IDS can be added to calls
The ability to impersonate an employee
The ability to set a partner key at the site level

API Changes

Help Lightning always attempts to keep our APIs backward compatible. However, some APIs may be updated to included additional keys in the response. In this release, the Server has several new APIs along with some updated response.

Alternate IDs

A User can add Alternate IDs to a call they are a participant in: PUT /v1/calls/:call_id
When a User gets a call, the Alternate IDs are now included in the response
An Admin can Add Alternate IDs to any call in the enterprise: PUT /v1/enterprise/calls/:call_id
When an Admin gets a call, the Alternate IDs are now included in the response.

Impersonation

Previously an Admin could get a token as user to perform basic operations, but that token did not represent a user as if they had logged in. In this release, a new impersonate API has been added, allowing an administrator to fully impersonate one of their users.

The token returned by the impersonate API has a limited lifespan (< 4 hours) and cannot be refreshed. When a user is impersonated, and audit log is generated.

The impersonate API allows allows dynamically elevating or demoting permissions on the fly. This can be useful to temporarily allow a user to access resources they wouldn’t normally be allowed to (a call they are not a participant in) or to return a token limited to only certain resources.

For more information, please see the API documentation.

Client SDK Changes

The 15.2 Client SDK is a minor release over the 15.0 SDK. This release primarily focuses on bugfixes and the refinement of the Audio+ mode UI.

WEB SDK

The 15.2 SDK for the web is versioned as 4.50.x with the latest version being 4.50.1.

    <!-- Load help lightning JS SDK -->
    <script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>
    <script src="https://helplightning.net/sdk/4.50.1/helplightning.min.js"></script>
    <script src="https://helplightning.net/sdk/4.50.1/opentok-enterprise/opentok.min.js"></script>
    <script src="https://helplightning.net/sdk/4.50.1/pdf_viewer/build/pdf.min.js"></script>
    <script src="https://helplightning.net/sdk/4.50.1/opencv/opencv.js" async></script>

Icon Changes

The watermark feature introduced a new button. If you use custom icons to theme your interface, you will want to consider overriding the following:

The watermark feature is not available to all customers

IMAGE_MAINMENU_WATERMARK
IMAGE_MAINMENU_WATERMARK_OFF

iOS SDK

The latest 15.2 SDK for the iOS is 15.2.3.

source 'https://github.com/VIPAAR/Specs.git'
pod 'HLSDK', '15.2.3'

There are no API changes or new custom icons from the 15.0 SDK.

Android SDK

The 15.2 SDK for Android is versioned as 1.16.x with the latest version being 1.16.2.

To use the new version, you should update the Android Target SDK to at least version 33.

There are no API changes or new custom icons from the 15.0 SDK.

Xamarin SDK

The 15.2.0 SDK for Xamarin is available here.

Changes since 14.6.0

The following are the changes since the previous Xamarin SDK (14.6.0) on each platform:

Xamarin iOS Changes

Support iOS 13+
Enable Swift Support

HL iOS SDK of 15.2.x utilizes Swift components. Xamarin Swift Binding isn’t as mature as Xamarin ObjC Binding. Please see this doc: - Walkthrough: Bind an iOS Swift library .

It is required to make changes to the project of the host apps. Some some compilation flags should be added to Project Options -> iOS Build -> Additional mtouch arguments (for both Debug and Release builds)

Platform: iPhoneSimulator

--gcc_flags -L/usr/lib/swift --gcc_flags -L/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/swift/iphonesimulator --gcc_flags "-Wl,-rpath -Wl,@executable_path/Frameworks"

Platform: iPhone

--gcc_flags -L/usr/lib/swift --gcc_flags -L/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/swift/iphoneos --gcc_flags "-Wl,-rpath -Wl,@executable_path/Frameworks"

/Applications/Xcode.app/ is the default installation path of Xcode. If the Xcode is installed to anther location, please update the Xcode path.

Xamarin Android

Target Android 12S

Icon Changes

If using a custom theme, the following are the new icons that should be overridden:

// 15.2 Android Icons
public const string ImageMessageChatAndroid = "image_message_chat_android";
public const string ImageMessageSendAndroid = "image_message_send_android";
public const string ImageMessagePaperClipAndroid = "image_message_paper_clip_android";
public const string ImageMessagePhotoFilmAndroid = "image_message_photo_film_android";
public const string ImageMessageFolderOpenAndroid = "image_message_folder_open_android";
public const string ImageMessageCameraAndroid = "image_message_camera_android";
public const string ImageMessageGroupAndroid = "image_message_group_android";
public const string ImageMessageXmarkAndroid = "image_message_xmark_android";
public const string ImageMessageFileAndroid = "image_message_file_android";
public const string ImageMessageVideoAndroid = "image_message_video_android";
public const string ImageMessagePDFAndroid = "image_message_pdf_android";
public const string ImageCallQualityHDAndroid = "image_call_quality_hd";
public const string ImageCallQualitySDAndroid = "image_call_quality_sd";
public const string ImageCallQualityAudioPlusAndroid = "image_call_quality_audio_plus";
public const string ImageCameraDisabledAndroid = "image_camera_disabled";

// 15.2 iOS Icons
public const string ImageAudioPlusModeIOS = "image_audio_plus_mode";
public const string ImageCallQualityHDIOS = "image_call_quality_HD";
public const string ImageCallQualitySDIOS = "image_call_quality_SD";
public const string ImageCallQualityAudioPlusIOS = "image_call_quality_audio";
public const string ImageCameraDisabledIOS = "image_camera_disabled";

public const string ImageChatGroupAvatarIOS = "image_chat_group_avatar";
public const string ImageChatMoreActionIOS = "image_chat_more_action";
public const string ImageChatSendIOS = "image_chat_send";
public const string ImageChatPlaceholderIOS = "image_chat_placeholder";
public const string ImageChatMenuIOS = "image_chat_menu";
public const string ImageChatAttachmentIOS = "image_chat_attachment";
public const string ImageChatCameraIOS = "image_chat_camera";