Release Notes

5.0.1 - 2022-09-29

Fixed

• Socket handshake config cleared on logout

5.0.0 - 2022-09-01

Added

• Support for XCFrameworks for M1

4.3.2 - 2022-07-01

Fix

• Fix transition from mute to unmute on media object
• Fix event parsing for NXMCustomEvent.customType

4.3.1 - 2022-05-09

Fix

• Fix [NXMConversation sendMessage:message completionHandler:handler] for NXMMessageTypeImage, NXMMessageTypeAudio, NXMMessageTypeVideo and NXMMessageTypeFile message types.

4.3.0 - 2022-04-28

Added

• pushNotificationTTL property added to NXMClientConfig to set TTL for push notifications.
• [NXMConversation sendMarkDeliveredMessage:message completionHandler:handler] method added to send delivery receipts.
• [NXMConversation sendMarkSeenMessage] now supports seen status for all messages.
• NXMMessageStatusTypeSubmitted, NXMMessageStatusTypeRejected, NXMMessageStatusTypeUndeliverable states added to NXMMessageStatusEvent

4.2.1 - 2022-04-06

Fixed

• [NXMClient uploadAttachmentWithType:name:data:completionHandler:] method to upload attachments returns with image data

4.2.0 - 2022-03-24

Added

• Support for call:transfer within NXMCall
• [NXMCallDelegate call:didTransfer:event:] to receive new call transfer event when call transferred to a new conversation.

Enhancements

• WebRTC dependency upgraded to version 84.0.22.

4.1.0 - 2022-02-25

Added

• [NXMClient getDeviceId] to retrieve device identifier.

4.0.6 - 2022-02-15

Fixed

• Fix DSYM Warnings

4.0.5 - 2022-02-15

Added

• Bitcode Support

4.0.4 - 2022-01-14

Fixed

• Inbound call event processing queue defaults to non suspended

4.0.3 - 2021-12-13

Fixed

• Umbrella header.

4.0.2 - 2021-12-07

Fixed

• CocoaPods dependencies.

4.0.0 - 2021-12-06

Added

• [NXMConversation sendMessage:completionHandler:] method to send NXMMessage.
• [NXMClient uploadAttachmentWithType:name:data:completionHandler:] method to upload attachments.
• NXMMessage represents a message to send.
• NXMMessageType for messages of type text, image, audio, video, file, template, vcard and custom.
• NXMEventTypeMemberMessageStatus, a new NXMEventType case, represents a member message status event that can be received on an NXMConversation.

Enhancements

• WebRTC dependency upgraded to version 84.0.0.
• Enforce direction for NXMCallMemberStatus during calls.

Changed

• NXMDirectionType renamed to NXMChannelType.

Deprecated

• [NXMConversation sendText:completionHandler:] method.
• [NXMConversation sendAttachmentWithType:name:data:completionHandler:] method.

3.3.0 - 2021-11-22

Added

• NXMClientConfig's apiPinning and websocketPinning optional fields to enable HTTP and web-socket SSL pinning.
• [NXMPinningConfig fromPublicKeys:] method to create a public-key-based pinning configuration.
• NXMConnectionStatusReasonSSLPinningError describing a client connection update due to an SSL pinning error.

Changed

• Minimum supported iOS version (IPHONEOS_DEPLOYMENT_TARGET) bumped to 10.3.

3.2.1 - 2021-11-08

Fixed

• Stash events while conversation is downloading to avoid missed events

3.2.0 - 2021-10-19

Added

• NXMClientConfig.autoMediaReoffer to allow to automatically reconnect media when network interfaces changes.
• [NXMClientConfig description] for a quick NXMClientConfig's instance description.
• NXMMediaConnectionStatus enumerate.
• [NXMConversationDelegate conversation:onMediaConnectionStateChange:legId:] to receive media connection state changed notification.
• [NXMConversation reconnectMedia] to trigger a media reconnection.
• [NXMClient reconnectCallWithConversationId:andLegId:completionHandler:] to reconnect a call given a conversation id and a leg id.
• NXMCall.conversation to get the conversation associated to a call.

Deprecated

• [NXMClientConfig initWithApiUrl:websocketUrl:ipsUrl:].
• [NXMClientConfig initWithApiUrl:websocketUrl:ipsUrl:iceServerUrls:].
• [NXMClientConfig initWithApiUrl:websocketUrl:ipsUrl:useFirstIceCandidate:].
• [NXMClientConfig initWithApiUrl:websocketUrl:ipsUrl:iceServerUrls:useFirstIceCandidate].

3.1.0 - 2021-09-06

Added

• [NXMClient inAppCallWithCallee:completionHandler:] method to perform in-app calls.
• [NXMClient serverCallWithCallee:customData:completionHandler:] method to perform server calls, optionally specifying customData.

Enhancements

• Internal API calls optimized for conversation creation.

Deprecated

• [NXMClient call:callHandler:completionHandler:] method.
• NXMCallHandler enumerate.
• [NXMLogger getLogFileNames] method.

3.0.1 - 2021-07-12

Fixed

• Sending DTMF during calls.
• Prewarmed media termination.

Changed

• NXMMemberEvent's member substituted with memberId.

3.0.0 - 2021-07-01

Added

• Added NXMMemberSummary returned by [NXMConversation getMembersPageWithPageSize:order:completion:] (paginated), representing a subset of member's information.
• Added NXMMemberEvent's invitedBy that represents the inviter name, if exists.
• Added NXMEventEmbeddedInfo to all events returned by NXMEvent's embeddedInfo and containing the NXMUser linked to the event.
• Added [NXMConversation getMemberWithMemberUuid:completion:] returning the member given its identifier.

Enhancements

• Allow 1K members on a conversation.
• Improved callServer setup time by pre-warming leg.
• Disabled media after RTC hangup event.
• Fixed text typing events handling.

Breaking changes

• Removed NXMCallMember, replaced with NXMMember.
• Removed NXMCallMember's status, moved to [NXMCall callStatusForMember:member:].
• Removed [NXMCallMember mute:] converted into [NXMMember enableMute] and [NXMMember disableMute].
• Removed NXMConversation's allMembers (replaced with [NXMConversation getMembersPageWithPageSize:order:completion:] (paginated)).
• Removed [NXMConversationUpdateDelegate conversation:didUpdateMember:withType:], replaced with [NXMConversationDelegate conversation:didReceiveMemberEvent:] with the following possible states: NXMMemberStateInvited, NXMMemberStateJoined and NXMMemberStateLeft. Can be subscribed to using NXMConversation's delegate.
• Renamed NXMCall's otherCallMembers to allMembers.
• Renamed NXMCall's myCallMember to myMember.
• The legs endpoint should be included in acl paths on JWT token creation.

2.5.0 - 2020-11-23

Changed

• Renamed NXMCallMemberStatusCanceled to NXMCallMemberStatusCancelled.
• Renamed NXMLegStatusCanceled to NXMLegStatusCancelled.

Enhancements

• Notified with NXMCallMemberStatusCancelled on NXMCallDelegate for call hang up.

2.4.0 - 2020-09-24

Added

• Expose the reason NXMConnectionStatusReasonTokenExpired on connection status NXMConnectionStatusDisconnected for the NXMClientDelegate.

2.3.0 - 2020-08-17

Added

• [NXMClientConfig AMS] static method.

Fixed

• Custom events parsing.

2.2.2 - 2020-07-20

Fixed

• Event syncing after socket disconnection.

2.2.1 - 2020-07-06

Fixed

• Server-call error reported by NXMCallDelegate on call completion.

Enhancements

• Improved call events handling.
• Improved conversation expiration handling.

2.2.0 - 2020-04-22

Added

• Added isConnected method to NXMClient to show current connection state.

Fixed

• API Event client_ref handling.

2.1.10 - 2020-04-16

Enhancements

• Improved single ICE candidate gathering implementation.

2.1.9 - 2020-04-14

Fixed

• NXMClientConfig convenience initializer implementations.

2.1.8 - 2020-04-02

Added

• Add useFirstIceCandidate parameters to NXMClientConfig

2.1.5 - 2020-03-18

Enhancements

• Updated Device Registration format for production environments.

2.1.1 - 2020-03-05

Added

• NXMClient's getConversationsPageWithSize:order:filter:completionHandler: method to get conversations with paging.

Deprecated

• NXMClient's getConversationsPageWithSize:order:completionHandler: method to get conversations with paging.

Enhancements

• The Client SDK is now built with Xcode 11.

2.1.0 - 2020-01-31

Added

• NXMPushPayload for custom push notifications.

2.0.0 - 2020-01-15

Added

• NXMHelper with descriptionForEventType: method.
• NXMConversation's getEvents: method replaced by getEventsPage:, getEventsPageWithSize:order:completionHandler:, getEventsPageWithSize:order:eventType:completionHandler:.

• NXMConversationsPage's nextPage: and previousPage: completion handlers are now non-null.

Fixed

• Calling conversation.getEvents returned a NXMMemberEvent with the field member set to nil.

1.2.3 - 2019-12-17

Fixed

• conversation.getEvents returned some NXMEvents containing a nil fromMember
• Added descriptive userInfo for NXMErrors.

1.2.2 - 2019-12-12

Fixed

• Added support for DTLS in WebRTC.
• didReceiveCall and didReceiveConversation being called only once for the same call or conversation.
• Added option to enable push notification with only one pushKit or userNotification token.
• Fix for NXMClientConfig region URLs.
• On login with invalid user, return NXMConnectionStatusReasonUserNotFound.
• Added build architectures: armv7 and armv7s.

1.2.1 - 2019-12-05

Added

Configuration for ICE server:

This configuration is optional and a default will be set if not specified.

Fixed

Corrected nil values for fromMember for NXMConversation events.

1.2.0 - 2019-12-03

Added

NXMClient's getConversationsPageWithSize:order:completionHandler: method to get conversations with paging.

NXMConversationsPage, which represents the retrieved page, provides the following instance methods:

• hasNextPage / hasPreviousPage to check if forward/backward page retrieval is possible and
• nextPage: / previousPage: to asynchronously retrieve the next/previous page.

Changed

NXMClient's getConversationWithUUid:completionHandler: method's name typo (now called getConversationWithUuid:completionHandler:).

1.1.1 - 2019-11-21

Added

NXMClientConfig object in order to change data center configuration. How to use:

NXMClient setConfiguration is optional, configuration will set to a default value.

1.1.0 - 2019-11-14

Fixed

• iOS 13 push notifications support.
• Start server call stability.
• Receiving a DTMF event in call and conversation.

Added

NXMConversationDelegate did receive DTMF event method:

Changed

NXMClient - client enable push notifications method changed. param pushKitToken - only for VoIP push (incoming calls). param userNotificationToken - all push types:

1.0.0 - 2019-09-05

Fixed

• NexmoClient when disconnected returns error callback for all function.
• CallMember status calculated by the current leg status.
• CallMember supports failed, busy, timeout and canceled statuses.
• Supports member invited.
• Conversation has media methods.
• NexmoClient is now singleton.
• Call method changed to string instead of array.
• NexmoClient delegate methods renamed.

Added

• Added conversation media:

• Added invite member:

• Added the member state initiator:

• Added NXMConversationUpdateDelegate to notify on member updates like media,leg, and state.
• Added updatesDelegate property to NXMConversation:

Example:

Changed

• NXMClient is now a singleton:

• Renamed:

• NXMClientDelegate renamed:

• NXMConversation otherMembers property renamed to allMembers:

• NXMConversationDelegate renamed methods:

• Use username instead of userId.

• NXMCallDelegate renamed:

• NXMEvent and NXMMemberEvent add member object instead of memberId:

• NXMImageInfo renamed properties:

• NXMMessageStatusEvent renamed property:

• NexmoClient logger exposed - NXMLogger object:

Removed

• NXMLoggerDelegate

0.3.0 - 2019-06-03

Added

• Interoperability with the JS and Android SDKs - Calls can now be placed between apps using the iOS, JS or Android SDKs.

Changed

• NXMCallMember - added member channel with direction data:

Removed

• NXMCallMember's phoneNumber and channelType were removed.

0.2.56 - 2019-01-24

Added

• Change log file.

Changed

• Memory management improvements.
• Fetch missing and new events on network changes.
• Returning User objects instead of Ids.
• Bug fixes.
• Add non-null or nullable to properties.
• Rename call.decline to call.reject.

0.1.52 - 2019-01-01

• Initial beta release with basic call and chat features.

• Please refer to list of features and usage: https://developer.nexmo.com/

• Cocoapods: https://cocoapods.org/pods/nexmoclient