@flashphoner/sfusdk 2.0.289 → 2.0.294

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (245) hide show
  1. package/dist/client.version +1 -1
  2. package/dist/sdk/attachments-transfer-client.d.ts +9 -0
  3. package/dist/sdk/attachments-transfer-client.js +130 -0
  4. package/dist/sdk/attachments-transfer-client.js.map +1 -0
  5. package/dist/sdk/attachments-transfer-manager.d.ts +8 -0
  6. package/dist/sdk/attachments-transfer-manager.js +29 -0
  7. package/dist/sdk/attachments-transfer-manager.js.map +1 -0
  8. package/dist/sdk/connection.d.ts +1 -0
  9. package/dist/sdk/connection.js +7 -3
  10. package/dist/sdk/connection.js.map +1 -1
  11. package/dist/sdk/constants.d.ts +34 -4
  12. package/dist/sdk/constants.js +17 -0
  13. package/dist/sdk/constants.js.map +1 -1
  14. package/dist/sdk/room-extended.d.ts +2 -0
  15. package/dist/sdk/room-extended.js +22 -0
  16. package/dist/sdk/room-extended.js.map +1 -1
  17. package/dist/sdk/sfu-extended.d.ts +46 -6
  18. package/dist/sdk/sfu-extended.js +123 -59
  19. package/dist/sdk/sfu-extended.js.map +1 -1
  20. package/docs/assets/navigation.js +1 -1
  21. package/docs/assets/search.js +1 -1
  22. package/docs/classes/attachments_transfer_client.AttachmentsTransferClient.html +10 -0
  23. package/docs/classes/attachments_transfer_manager.AttachmentsTransferManager.html +4 -0
  24. package/docs/classes/connection.Connection.html +2 -1
  25. package/docs/classes/room_extended.RoomExtended.html +7 -5
  26. package/docs/classes/sfu_extended.SfuExtended.html +93 -80
  27. package/docs/enums/constants.AttachmentState.html +2 -2
  28. package/docs/enums/constants.AuthenticationStatus.html +2 -2
  29. package/docs/enums/constants.ChannelSendPolicy.html +2 -2
  30. package/docs/enums/constants.ChatError.html +3 -2
  31. package/docs/enums/constants.ChatReceivePolicy.html +2 -2
  32. package/docs/enums/constants.ChatSectionsError.html +2 -2
  33. package/docs/enums/constants.ChatType.html +2 -2
  34. package/docs/enums/constants.ConferenceType.html +2 -2
  35. package/docs/enums/constants.ConnectionType.html +2 -2
  36. package/docs/enums/constants.ContactError.html +2 -2
  37. package/docs/enums/constants.DeliveryStatus.html +2 -2
  38. package/docs/enums/constants.ExamplesError.html +2 -2
  39. package/docs/enums/constants.ExamplesEvent.html +2 -2
  40. package/docs/enums/constants.InternalApi.html +8 -2
  41. package/docs/enums/constants.MeetingSyncEvent.html +10 -10
  42. package/docs/enums/constants.MessageAttachmentMediaType.html +2 -2
  43. package/docs/enums/constants.MessageAttachmentType.html +2 -2
  44. package/docs/enums/constants.MessageState.html +2 -2
  45. package/docs/enums/constants.MessageTargetEntityType.html +2 -2
  46. package/docs/enums/constants.Operations.html +2 -2
  47. package/docs/enums/constants.ParticipantRole.html +2 -2
  48. package/docs/enums/constants.PresenceStatus.html +2 -2
  49. package/docs/enums/constants.RemoteSdpType.html +2 -2
  50. package/docs/enums/constants.RoomError.html +2 -2
  51. package/docs/enums/constants.RoomEvent.html +6 -2
  52. package/docs/enums/constants.RoomState.html +2 -2
  53. package/docs/enums/constants.SortOrder.html +2 -2
  54. package/docs/enums/constants.SpaceError.html +2 -2
  55. package/docs/enums/constants.SpaceEvent.html +31 -27
  56. package/docs/enums/constants.State.html +2 -2
  57. package/docs/enums/constants.StatsType.html +2 -2
  58. package/docs/enums/constants.TrackType.html +2 -2
  59. package/docs/enums/constants.UserInfoError.html +2 -2
  60. package/docs/enums/constants.UserManagementError.html +3 -2
  61. package/docs/modules/attachments_transfer_client.html +2 -0
  62. package/docs/modules/attachments_transfer_manager.html +2 -0
  63. package/docs/modules/constants.html +2 -0
  64. package/docs/modules/sfu_extended.html +2 -0
  65. package/docs/types/constants.AddRemoveTracks.html +1 -1
  66. package/docs/types/constants.AddRemoveTracksSync.html +1 -1
  67. package/docs/types/constants.AddedMembersToThread.html +1 -0
  68. package/docs/types/constants.AddedRemovedReactionOnMessage.html +1 -1
  69. package/docs/types/constants.AddedRoleToMember.html +1 -1
  70. package/docs/types/constants.Attachment.html +1 -1
  71. package/docs/types/constants.AttachmentInfo.html +1 -1
  72. package/docs/types/constants.AttachmentRequest.html +1 -1
  73. package/docs/types/constants.AttachmentRequestAck.html +1 -1
  74. package/docs/types/constants.AttachmentStatus.html +1 -1
  75. package/docs/types/constants.AttachmentStatusEvent.html +1 -1
  76. package/docs/types/constants.AuthenticationStatusEvent.html +1 -1
  77. package/docs/types/constants.BannedContact.html +1 -1
  78. package/docs/types/constants.BitrateTestStatus.html +1 -1
  79. package/docs/types/constants.BooleanEvent.html +1 -1
  80. package/docs/types/constants.Calendar.html +1 -1
  81. package/docs/types/constants.CalendarEvent.html +1 -1
  82. package/docs/types/constants.CalendarEventEvent.html +1 -1
  83. package/docs/types/constants.Chat.html +1 -1
  84. package/docs/types/constants.ChatLoadedEvent.html +1 -1
  85. package/docs/types/constants.ChatMap.html +1 -1
  86. package/docs/types/constants.ChatMessagesCount.html +1 -1
  87. package/docs/types/constants.ChatMessagesEvent.html +1 -1
  88. package/docs/types/constants.ChatSearchResultEvent.html +1 -1
  89. package/docs/types/constants.ChatsEvent.html +1 -1
  90. package/docs/types/constants.ConnectionDetails.html +1 -1
  91. package/docs/types/constants.ConnectionFailedEvent.html +1 -1
  92. package/docs/types/constants.Contact.html +1 -1
  93. package/docs/types/constants.ContactDeleted.html +1 -1
  94. package/docs/types/constants.ContactUpdated.html +1 -1
  95. package/docs/types/constants.ControlMessage.html +1 -1
  96. package/docs/types/constants.ControlMessageEvent.html +1 -1
  97. package/docs/types/constants.CreatedRoom.html +1 -1
  98. package/docs/types/constants.EvictedFromRoom.html +1 -1
  99. package/docs/types/constants.EvictedSync.html +1 -1
  100. package/docs/types/constants.ExamplesUser.html +1 -1
  101. package/docs/types/constants.ExamplesUserEvent.html +1 -1
  102. package/docs/types/constants.FirstAndLastChatMessage.html +1 -1
  103. package/docs/types/constants.FragmentedMessage.html +1 -1
  104. package/docs/types/constants.FriendInvite.html +1 -1
  105. package/docs/types/constants.FriendInviteDeleted.html +1 -1
  106. package/docs/types/constants.InternalMessage.html +1 -1
  107. package/docs/types/constants.JoinedRoom.html +1 -1
  108. package/docs/types/constants.JoinedRoomSync.html +1 -1
  109. package/docs/types/constants.LastReadMessageUpdate.html +1 -1
  110. package/docs/types/constants.LastReadMessageUpdated.html +1 -1
  111. package/docs/types/constants.LeftMeetingSync.html +1 -1
  112. package/docs/types/constants.LeftRoom.html +1 -1
  113. package/docs/types/constants.LoadMessagesWithMentionsResult.html +1 -1
  114. package/docs/types/constants.MeetingEndedSync.html +1 -1
  115. package/docs/types/constants.MeetingNameUpdatedSync.html +1 -1
  116. package/docs/types/constants.MeetingsPreviewEvent.html +1 -1
  117. package/docs/types/constants.Message.html +1 -1
  118. package/docs/types/constants.MessageAttachment.html +1 -1
  119. package/docs/types/constants.MessageAttachmentData.html +1 -1
  120. package/docs/types/constants.MessageAttachmentsSearchResult.html +1 -1
  121. package/docs/types/constants.MessageDeleted.html +1 -1
  122. package/docs/types/constants.MessageDeliveryStatus.html +1 -1
  123. package/docs/types/constants.MessageEdited.html +1 -1
  124. package/docs/types/constants.MessageInfo.html +1 -1
  125. package/docs/types/constants.MessageReaction.html +1 -1
  126. package/docs/types/constants.MessageStatus.html +1 -1
  127. package/docs/types/constants.MessageStatusEvent.html +1 -1
  128. package/docs/types/constants.MessageStatusUpdate.html +1 -1
  129. package/docs/types/constants.MessageTargetEntityId.html +1 -1
  130. package/docs/types/constants.MessageWithUploadingAttachments.html +1 -1
  131. package/docs/types/constants.NewChatEvent.html +1 -1
  132. package/docs/types/constants.NewContact.html +1 -1
  133. package/docs/types/constants.NewFriendInvite.html +1 -1
  134. package/docs/types/constants.NewMeeting.html +1 -1
  135. package/docs/types/constants.NewSpaceCategoryEvent.html +1 -1
  136. package/docs/types/constants.NewSpaceChannelEvent.html +1 -1
  137. package/docs/types/constants.NewSpaceEvent.html +1 -1
  138. package/docs/types/constants.NewSpaceRoleAdded.html +1 -1
  139. package/docs/types/constants.NewSpaceThreadEvent.html +1 -1
  140. package/docs/types/constants.OperationFailed.html +1 -1
  141. package/docs/types/constants.OperationFailedEvent.html +1 -1
  142. package/docs/types/constants.Participant.html +1 -1
  143. package/docs/types/constants.ParticipantAVSMutedEvent.html +1 -1
  144. package/docs/types/constants.ParticipantConfigEvent.html +1 -1
  145. package/docs/types/constants.ParticipantRenamed.html +1 -1
  146. package/docs/types/constants.ParticipantsListEvent.html +1 -1
  147. package/docs/types/constants.ParticipantsListSyncEvent.html +1 -1
  148. package/docs/types/constants.PlacedInLobbyEvent.html +1 -1
  149. package/docs/types/constants.PlacedInWaitingRoomEvent.html +1 -1
  150. package/docs/types/constants.PublicChannelsEvent.html +1 -1
  151. package/docs/types/constants.Quality.html +1 -1
  152. package/docs/types/constants.RemoteSdp.html +1 -1
  153. package/docs/types/constants.RemoteSdpInfo.html +1 -1
  154. package/docs/types/constants.RemovedChatEvent.html +1 -1
  155. package/docs/types/constants.RemovedMemberFromThread.html +1 -0
  156. package/docs/types/constants.RemovedRoleFromMember.html +1 -1
  157. package/docs/types/constants.ResetPasswordRequestStatus.html +1 -1
  158. package/docs/types/constants.RoleAssigned.html +1 -1
  159. package/docs/types/constants.RolePermissionSectionsEvent.html +1 -1
  160. package/docs/types/constants.RolesListEvent.html +1 -1
  161. package/docs/types/constants.RoomAvailable.html +1 -1
  162. package/docs/types/constants.RoomConfigEvent.html +1 -1
  163. package/docs/types/constants.RoomExtendedConfig.html +1 -1
  164. package/docs/types/constants.RoomExtendedParticipantConfig.html +1 -1
  165. package/docs/types/constants.RoomExtendedParticipantsConfig.html +1 -1
  166. package/docs/types/constants.RoomExtendedScreenSharingConfig.html +1 -1
  167. package/docs/types/constants.RoomInfo.html +1 -1
  168. package/docs/types/constants.RoomMessage.html +1 -1
  169. package/docs/types/constants.RoomNameUpdated.html +1 -1
  170. package/docs/types/constants.RoomScreenSharingConfigEvent.html +1 -1
  171. package/docs/types/constants.SFUMeetingParticipantPreview.html +1 -1
  172. package/docs/types/constants.SFUMeetingPreview.html +1 -1
  173. package/docs/types/constants.SfuMessageEvent.html +1 -1
  174. package/docs/types/constants.SfuSpace.html +1 -1
  175. package/docs/types/constants.SfuSpaceCategory.html +1 -1
  176. package/docs/types/constants.SfuSpaceChannel.html +1 -1
  177. package/docs/types/constants.SfuSpaceChannelAccessRights.html +1 -1
  178. package/docs/types/constants.SfuSpaceInvite.html +1 -1
  179. package/docs/types/constants.SfuSpaceMember.html +1 -1
  180. package/docs/types/constants.SfuSpaceRole.html +1 -1
  181. package/docs/types/constants.SfuSpaceRolePermission.html +1 -1
  182. package/docs/types/constants.SfuSpaceRolePermissionSection.html +1 -1
  183. package/docs/types/constants.SfuSpaceThread.html +1 -1
  184. package/docs/types/constants.SfuSpaceUserBan.html +1 -1
  185. package/docs/types/constants.SignUpStatus.html +1 -1
  186. package/docs/types/constants.SpaceCategoryDeleted.html +1 -1
  187. package/docs/types/constants.SpaceCategoryUpdated.html +1 -1
  188. package/docs/types/constants.SpaceChannelDeleted.html +1 -1
  189. package/docs/types/constants.SpaceChannelMoved.html +1 -1
  190. package/docs/types/constants.SpaceChannelUpdated.html +1 -1
  191. package/docs/types/constants.SpaceCreatedEvent.html +1 -1
  192. package/docs/types/constants.SpaceDeletedEvent.html +1 -1
  193. package/docs/types/constants.SpaceInviteCreated.html +1 -1
  194. package/docs/types/constants.SpaceInviteRevoked.html +1 -1
  195. package/docs/types/constants.SpaceOverviewUpdated.html +1 -1
  196. package/docs/types/constants.SpaceRoleDeleted.html +1 -1
  197. package/docs/types/constants.SpaceRoleUpdated.html +1 -1
  198. package/docs/types/constants.SpaceThreadDeleted.html +1 -1
  199. package/docs/types/constants.SpaceThreadUpdated.html +1 -1
  200. package/docs/types/constants.StopScreenSharingEvent.html +1 -1
  201. package/docs/types/constants.StopTrackEvent.html +1 -1
  202. package/docs/types/constants.TracksQualityState.html +1 -1
  203. package/docs/types/constants.UnreadMessagesCountEvent.html +1 -1
  204. package/docs/types/constants.UnreadMessagesCountUpdate.html +1 -1
  205. package/docs/types/constants.UpdateChatEvent.html +1 -1
  206. package/docs/types/constants.UpdateMessagesDeliveryStatusEvent.html +1 -1
  207. package/docs/types/constants.UploadingAttachmentInfo.html +1 -1
  208. package/docs/types/constants.UserCalendarEvent.html +1 -1
  209. package/docs/types/constants.UserChatEncryptedPassword.html +1 -1
  210. package/docs/types/constants.UserContacts.html +1 -1
  211. package/docs/types/constants.UserContactsEvent.html +1 -1
  212. package/docs/types/constants.UserEmail.html +1 -1
  213. package/docs/types/constants.UserEncryptionInfo.html +1 -1
  214. package/docs/types/constants.UserEncryptionInfoEvent.html +1 -1
  215. package/docs/types/constants.UserHostKey.html +1 -1
  216. package/docs/types/constants.UserHostKeyChangedEvent.html +1 -1
  217. package/docs/types/constants.UserId.html +1 -1
  218. package/docs/types/constants.UserInfo.html +1 -1
  219. package/docs/types/constants.UserInfoChangedEvent.html +1 -1
  220. package/docs/types/constants.UserInfoEvent.html +1 -1
  221. package/docs/types/constants.UserJoinedToSpaceEvent.html +1 -1
  222. package/docs/types/constants.UserLeftSpace.html +1 -1
  223. package/docs/types/constants.UserNickname.html +1 -1
  224. package/docs/types/constants.UserNicknameChangedEvent.html +1 -1
  225. package/docs/types/constants.UserPassword.html +1 -1
  226. package/docs/types/constants.UserPhoneNumber.html +1 -1
  227. package/docs/types/constants.UserPhoneNumberChangedEvent.html +1 -1
  228. package/docs/types/constants.UserPmiSettings.html +1 -1
  229. package/docs/types/constants.UserPresenceStatusUpdated.html +1 -1
  230. package/docs/types/constants.UserRoomsEvent.html +1 -1
  231. package/docs/types/constants.UserSpacesEvent.html +1 -1
  232. package/docs/types/constants.UserSpecificChatInfo.html +1 -1
  233. package/docs/types/constants.UserTimezone.html +1 -1
  234. package/docs/types/constants.UserTimezoneChangedEvent.html +1 -1
  235. package/docs/types/constants.WaitingListEvent.html +1 -1
  236. package/docs/types/constants.WaitingParticipant.html +1 -1
  237. package/docs/types/constants.WaitingRoomUpdate.html +1 -1
  238. package/docs/types/sfu_extended.EventUnion.html +1 -0
  239. package/docs/types/sfu_extended.NotifyUnion.html +1 -0
  240. package/docs/variables/constants.ATTACHMENT_CHUNK_SIZE.html +1 -1
  241. package/docs/variables/constants.ATTACHMENT_ID_LENGTH.html +1 -1
  242. package/docs/variables/constants.WS_CONNECTION_TIMEOUT.html +1 -1
  243. package/docs/variables/constants.WS_PINGS_MISSING_THRESHOLD.html +1 -1
  244. package/docs/variables/constants.WS_PING_INTERVAL_MS.html +1 -1
  245. package/package.json +1 -1
package/docs/classes/connection.Connection.html CHANGED
@@ -10,6 +10,7 @@
10
10
  <a href="connection.Connection.html#ws" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ws</span></a>
11
11
  </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="connection.Connection.html#close" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>close</span></a>
12
12
  <a href="connection.Connection.html#connect" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>connect</span></a>
13
+ <a href="connection.Connection.html#resetPingChecker" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reset<wbr/>Ping<wbr/>Checker</span></a>
13
14
  <a href="connection.Connection.html#send" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send</span></a>
14
15
  <a href="connection.Connection.html#sendBinaryData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Binary<wbr/>Data</span></a>
15
- </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_Connection" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Connection</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">onMessage</span>, <span class="tsd-kind-parameter">onBinaryData</span>, <span class="tsd-kind-parameter">onError</span>, <span class="tsd-kind-parameter">onClose</span>, <span class="tsd-kind-parameter">logger</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="connection.Connection.html" class="tsd-signature-type tsd-kind-class">Connection</a><a href="#constructor.new_Connection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">onMessage</span>: <span class="tsd-signature-type">OnMessageCallback</span></span></li><li><span><span class="tsd-kind-parameter">onBinaryData</span>: <span class="tsd-signature-type">OnBinaryDataCallback</span></span></li><li><span><span class="tsd-kind-parameter">onError</span>: <span class="tsd-signature-type">Function</span></span></li><li><span><span class="tsd-kind-parameter">onClose</span>: <span class="tsd-signature-type">Function</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">logger</span>: <a href="logger.default.html" class="tsd-signature-type tsd-kind-class">default</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="connection.Connection.html" class="tsd-signature-type tsd-kind-class">Connection</a></h4><aside class="tsd-sources"><ul><li>Defined in connection.ts:93</li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="connected" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>connected</span><a href="#connected" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">connected</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in connection.ts:88</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="connectionTimeout" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>connection<wbr/>Timeout</span><a href="#connectionTimeout" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">connection<wbr/>Timeout</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in connection.ts:89</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="logger" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>logger</span><a href="#logger" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">logger</span><span class="tsd-signature-symbol">:</span> <a href="logger.default.html" class="tsd-signature-type tsd-kind-class">default</a></div><aside class="tsd-sources"><ul><li>Defined in connection.ts:90</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="onBinaryData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>on<wbr/>Binary<wbr/>Data</span><a href="#onBinaryData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">on<wbr/>Binary<wbr/>Data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">OnBinaryDataCallback</span></div><aside class="tsd-sources"><ul><li>Defined in connection.ts:87</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="onClose" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>on<wbr/>Close</span><a href="#onClose" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">on<wbr/>Close</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span></div><aside class="tsd-sources"><ul><li>Defined in connection.ts:85</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="onError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>on<wbr/>Error</span><a href="#onError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">on<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span></div><aside class="tsd-sources"><ul><li>Defined in connection.ts:84</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="onMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>on<wbr/>Message</span><a href="#onMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">on<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">OnMessageCallback</span></div><aside class="tsd-sources"><ul><li>Defined in connection.ts:86</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="pingChecker" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>ping<wbr/>Checker</span><a href="#pingChecker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ping<wbr/>Checker</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">WSPingReceiver</span></div><aside class="tsd-sources"><ul><li>Defined in connection.ts:91</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="ws" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>ws</span><a href="#ws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ws</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">WebSocket</span></div><aside class="tsd-sources"><ul><li>Defined in connection.ts:83</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="close" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>close</span><a href="#close" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="close.close-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">close</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#close.close-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">error</span>: <a href="../types/constants.ConnectionFailedEvent.html" class="tsd-signature-type tsd-kind-type-alias">ConnectionFailedEvent</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in connection.ts:221</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="connect" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>connect</span><a href="#connect" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="connect.connect-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">connect</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">InitialUserData</span><span class="tsd-signature-symbol">&gt;</span><a href="#connect.connect-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">appName</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">authToken</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">custom</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">failedProbesThreshold</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">pingInterval</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">app<wbr/>Name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">auth<wbr/>Token</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">custom</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">failed<wbr/>Probes<wbr/>Threshold</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">ping<wbr/>Interval</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">InitialUserData</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in connection.ts:107</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="send" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send</span><a href="#send" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="send.send-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">send</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span>, <span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#send.send-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in connection.ts:203</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sendBinaryData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>Binary<wbr/>Data</span><a href="#sendBinaryData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="sendBinaryData.sendBinaryData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">send<wbr/>Binary<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#sendBinaryData.sendBinaryData-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in connection.ts:213</li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#connected" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>connected</span></a><a href="#connectionTimeout" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>connection<wbr/>Timeout</span></a><a href="#logger" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>logger</span></a><a href="#onBinaryData" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Binary<wbr/>Data</span></a><a href="#onClose" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Close</span></a><a href="#onError" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Error</span></a><a href="#onMessage" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Message</span></a><a href="#pingChecker" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ping<wbr/>Checker</span></a><a href="#ws" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ws</span></a><a href="#close" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>close</span></a><a href="#connect" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>connect</span></a><a href="#send" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send</span></a><a href="#sendBinaryData" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Binary<wbr/>Data</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@flashphoner/sfusdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
16
+ </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_Connection" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Connection</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">onMessage</span>, <span class="tsd-kind-parameter">onBinaryData</span>, <span class="tsd-kind-parameter">onError</span>, <span class="tsd-kind-parameter">onClose</span>, <span class="tsd-kind-parameter">logger</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="connection.Connection.html" class="tsd-signature-type tsd-kind-class">Connection</a><a href="#constructor.new_Connection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">onMessage</span>: <span class="tsd-signature-type">OnMessageCallback</span></span></li><li><span><span class="tsd-kind-parameter">onBinaryData</span>: <span class="tsd-signature-type">OnBinaryDataCallback</span></span></li><li><span><span class="tsd-kind-parameter">onError</span>: <span class="tsd-signature-type">Function</span></span></li><li><span><span class="tsd-kind-parameter">onClose</span>: <span class="tsd-signature-type">Function</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">logger</span>: <a href="logger.default.html" class="tsd-signature-type tsd-kind-class">default</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="connection.Connection.html" class="tsd-signature-type tsd-kind-class">Connection</a></h4><aside class="tsd-sources"><ul><li>Defined in connection.ts:93</li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="connected" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>connected</span><a href="#connected" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">connected</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in connection.ts:88</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="connectionTimeout" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>connection<wbr/>Timeout</span><a href="#connectionTimeout" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">connection<wbr/>Timeout</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in connection.ts:89</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="logger" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>logger</span><a href="#logger" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">logger</span><span class="tsd-signature-symbol">:</span> <a href="logger.default.html" class="tsd-signature-type tsd-kind-class">default</a></div><aside class="tsd-sources"><ul><li>Defined in connection.ts:90</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="onBinaryData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>on<wbr/>Binary<wbr/>Data</span><a href="#onBinaryData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">on<wbr/>Binary<wbr/>Data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">OnBinaryDataCallback</span></div><aside class="tsd-sources"><ul><li>Defined in connection.ts:87</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="onClose" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>on<wbr/>Close</span><a href="#onClose" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">on<wbr/>Close</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span></div><aside class="tsd-sources"><ul><li>Defined in connection.ts:85</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="onError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>on<wbr/>Error</span><a href="#onError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">on<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span></div><aside class="tsd-sources"><ul><li>Defined in connection.ts:84</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="onMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>on<wbr/>Message</span><a href="#onMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">on<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">OnMessageCallback</span></div><aside class="tsd-sources"><ul><li>Defined in connection.ts:86</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="pingChecker" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>ping<wbr/>Checker</span><a href="#pingChecker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ping<wbr/>Checker</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">WSPingReceiver</span></div><aside class="tsd-sources"><ul><li>Defined in connection.ts:91</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="ws" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>ws</span><a href="#ws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ws</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">WebSocket</span></div><aside class="tsd-sources"><ul><li>Defined in connection.ts:83</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="close" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>close</span><a href="#close" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="close.close-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">close</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#close.close-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">error</span>: <a href="../types/constants.ConnectionFailedEvent.html" class="tsd-signature-type tsd-kind-type-alias">ConnectionFailedEvent</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in connection.ts:219</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="connect" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>connect</span><a href="#connect" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="connect.connect-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">connect</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">InitialUserData</span><span class="tsd-signature-symbol">&gt;</span><a href="#connect.connect-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">appName</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">authToken</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">custom</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">failedProbesThreshold</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">pingInterval</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">app<wbr/>Name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">auth<wbr/>Token</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">custom</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">failed<wbr/>Probes<wbr/>Threshold</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">ping<wbr/>Interval</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">InitialUserData</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in connection.ts:107</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="resetPingChecker" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>reset<wbr/>Ping<wbr/>Checker</span><a href="#resetPingChecker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="resetPingChecker.resetPingChecker-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">reset<wbr/>Ping<wbr/>Checker</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#resetPingChecker.resetPingChecker-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in connection.ts:244</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="send" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send</span><a href="#send" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="send.send-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">send</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span>, <span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#send.send-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in connection.ts:201</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sendBinaryData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>Binary<wbr/>Data</span><a href="#sendBinaryData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="sendBinaryData.sendBinaryData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">send<wbr/>Binary<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#sendBinaryData.sendBinaryData-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in connection.ts:211</li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#connected" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>connected</span></a><a href="#connectionTimeout" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>connection<wbr/>Timeout</span></a><a href="#logger" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>logger</span></a><a href="#onBinaryData" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Binary<wbr/>Data</span></a><a href="#onClose" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Close</span></a><a href="#onError" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Error</span></a><a href="#onMessage" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Message</span></a><a href="#pingChecker" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ping<wbr/>Checker</span></a><a href="#ws" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ws</span></a><a href="#close" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>close</span></a><a href="#connect" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>connect</span></a><a href="#resetPingChecker" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reset<wbr/>Ping<wbr/>Checker</span></a><a href="#send" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send</span></a><a href="#sendBinaryData" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Binary<wbr/>Data</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@flashphoner/sfusdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>