@zelloptt/react-native-zello-sdk 2.0.0 → 3.0.0
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.
- package/README.md +58 -15
- package/android/build.gradle +29 -10
- package/android/gradle.properties +4 -4
- package/android/src/main/java/com/zellosdk/ZelloAndroidSdkModule.kt +93 -68
- package/android/src/main/java/com/zellosdk/ZelloAndroidSdkModuleHelper.kt +25 -0
- package/ios/Extensions/ZelloContact+Extension.swift +26 -3
- package/ios/Extensions/ZelloHistoryVoiceMessage+Extension.swift +3 -0
- package/ios/Extensions/ZelloIOSSdkModule+Extension.swift +8 -2
- package/ios/Extensions/ZelloIncomingEmergency+Extension.swift +1 -0
- package/ios/Extensions/ZelloTranscription+Extension.swift +18 -0
- package/ios/ZelloIOSSdkModule.swift +24 -7
- package/ios/ZelloIOSSdkModuleBridge.m +1 -0
- package/ios/ZelloSdkModule.h +8 -0
- package/ios/ZelloSdkModule.mm +189 -0
- package/ios/ZelloSdkModuleImpl.swift +280 -0
- package/lib/commonjs/docs/assets/highlight.css +1 -1
- package/lib/commonjs/docs/assets/icons.js +1 -1
- package/lib/commonjs/docs/assets/icons.js.map +1 -1
- package/lib/commonjs/docs/assets/icons.svg +1 -1
- package/lib/commonjs/docs/assets/main.js +220 -288
- package/lib/commonjs/docs/assets/main.js.map +1 -1
- package/lib/commonjs/docs/assets/navigation.js +1 -1
- package/lib/commonjs/docs/assets/navigation.js.map +1 -1
- package/lib/commonjs/docs/assets/search.js +1 -1
- package/lib/commonjs/docs/assets/search.js.map +1 -1
- package/lib/commonjs/docs/assets/style.css +12 -4
- package/lib/commonjs/docs/classes/sdk.Zello.html +793 -97
- package/lib/commonjs/docs/classes/types.ZelloAlertMessage.html +122 -9
- package/lib/commonjs/docs/classes/types.ZelloChannel.html +155 -10
- package/lib/commonjs/docs/classes/types.ZelloChannelUser.html +86 -4
- package/lib/commonjs/docs/classes/types.ZelloDispatchCall.html +90 -6
- package/lib/commonjs/docs/classes/types.ZelloDispatchChannel.html +163 -11
- package/lib/commonjs/docs/classes/types.ZelloGroupConversation.html +178 -13
- package/lib/commonjs/docs/classes/types.ZelloHistoryAlertMessage.html +131 -10
- package/lib/commonjs/docs/classes/types.ZelloHistoryImageMessage.html +123 -9
- package/lib/commonjs/docs/classes/types.ZelloHistoryLocationMessage.html +155 -13
- package/lib/commonjs/docs/classes/types.ZelloHistoryTextMessage.html +131 -10
- package/lib/commonjs/docs/classes/types.ZelloHistoryVoiceMessage.html +145 -10
- package/lib/commonjs/docs/classes/types.ZelloImageMessage.html +130 -10
- package/lib/commonjs/docs/classes/types.ZelloIncomingEmergency.html +114 -9
- package/lib/commonjs/docs/classes/types.ZelloIncomingVoiceMessage.html +124 -8
- package/lib/commonjs/docs/classes/types.ZelloLocationMessage.html +146 -12
- package/lib/commonjs/docs/classes/types.ZelloOutgoingEmergency.html +98 -7
- package/lib/commonjs/docs/classes/types.ZelloOutgoingVoiceMessage.html +120 -9
- package/lib/commonjs/docs/classes/types.ZelloRecentEntry.html +114 -9
- package/lib/commonjs/docs/classes/types.ZelloTextMessage.html +122 -9
- package/lib/commonjs/docs/classes/types.ZelloTranscription.html +122 -0
- package/lib/commonjs/docs/classes/types.ZelloTranslation.html +91 -0
- package/lib/commonjs/docs/classes/types.ZelloUser.html +142 -11
- package/lib/commonjs/docs/classes/types.ZelloUserSupportedFeatures.html +82 -5
- package/lib/commonjs/docs/enums/events.ZelloEvent.html +563 -95
- package/lib/commonjs/docs/enums/types.ZelloAccountStatus.html +67 -5
- package/lib/commonjs/docs/enums/types.ZelloChannelAlertLevel.html +67 -5
- package/lib/commonjs/docs/enums/types.ZelloChannelConnectionStatus.html +68 -3
- package/lib/commonjs/docs/enums/types.ZelloChannelType.html +84 -0
- package/lib/commonjs/docs/enums/types.ZelloConnectionError.html +68 -3
- package/lib/commonjs/docs/enums/types.ZelloConnectionState.html +73 -3
- package/lib/commonjs/docs/enums/types.ZelloContactType.html +73 -3
- package/lib/commonjs/docs/enums/types.ZelloDispatchCallStatus.html +73 -3
- package/lib/commonjs/docs/enums/types.ZelloOutgoingVoiceMessageError.html +63 -3
- package/lib/commonjs/docs/enums/types.ZelloOutgoingVoiceMessageState.html +78 -3
- package/lib/commonjs/docs/enums/types.ZelloRecentEntryType.html +78 -3
- package/lib/commonjs/docs/enums/types.ZelloUserStatus.html +81 -7
- package/lib/commonjs/docs/hierarchy.html +29 -1
- package/lib/commonjs/docs/index.html +127 -29
- package/lib/commonjs/docs/interfaces/specs_NativeZelloSdk.Spec.html +504 -0
- package/lib/commonjs/docs/modules/events.html +37 -1
- package/lib/commonjs/docs/modules/index.html +37 -1
- package/lib/commonjs/docs/modules/sdk.html +37 -1
- package/lib/commonjs/docs/modules/specs_NativeZelloSdk.html +41 -0
- package/lib/commonjs/docs/modules/types.html +45 -1
- package/lib/commonjs/docs/modules.html +36 -1
- package/lib/commonjs/docs/types/types.ZelloChannelOptions.html +114 -9
- package/lib/commonjs/docs/types/types.ZelloConfig.html +86 -7
- package/lib/commonjs/docs/types/types.ZelloConsoleSettings.html +96 -9
- package/lib/commonjs/docs/types/types.ZelloContact.html +80 -6
- package/lib/commonjs/docs/types/types.ZelloCredentials.html +75 -6
- package/lib/commonjs/docs/types/types.ZelloHistoryMessage.html +97 -8
- package/lib/commonjs/docs/types/types.ZelloMessage.html +91 -7
- package/lib/commonjs/docs/variables/specs_NativeZelloSdk.default.html +34 -0
- package/lib/commonjs/events/index.js +217 -0
- package/lib/commonjs/events/index.js.map +1 -1
- package/lib/commonjs/sdk/index.js +731 -911
- package/lib/commonjs/sdk/index.js.map +1 -1
- package/lib/commonjs/specs/NativeZelloSdk.js +27 -0
- package/lib/commonjs/specs/NativeZelloSdk.js.map +1 -0
- package/lib/commonjs/types/index.js +423 -302
- package/lib/commonjs/types/index.js.map +1 -1
- package/lib/commonjs/utils/index.js +27 -4
- package/lib/commonjs/utils/index.js.map +1 -1
- package/lib/module/docs/assets/highlight.css +1 -1
- package/lib/module/docs/assets/icons.js +1 -1
- package/lib/module/docs/assets/icons.js.map +1 -1
- package/lib/module/docs/assets/icons.svg +1 -1
- package/lib/module/docs/assets/main.js +220 -288
- package/lib/module/docs/assets/main.js.map +1 -1
- package/lib/module/docs/assets/navigation.js +1 -1
- package/lib/module/docs/assets/navigation.js.map +1 -1
- package/lib/module/docs/assets/search.js +1 -1
- package/lib/module/docs/assets/search.js.map +1 -1
- package/lib/module/docs/assets/style.css +12 -4
- package/lib/module/docs/classes/sdk.Zello.html +793 -97
- package/lib/module/docs/classes/types.ZelloAlertMessage.html +122 -9
- package/lib/module/docs/classes/types.ZelloChannel.html +155 -10
- package/lib/module/docs/classes/types.ZelloChannelUser.html +86 -4
- package/lib/module/docs/classes/types.ZelloDispatchCall.html +90 -6
- package/lib/module/docs/classes/types.ZelloDispatchChannel.html +163 -11
- package/lib/module/docs/classes/types.ZelloGroupConversation.html +178 -13
- package/lib/module/docs/classes/types.ZelloHistoryAlertMessage.html +131 -10
- package/lib/module/docs/classes/types.ZelloHistoryImageMessage.html +123 -9
- package/lib/module/docs/classes/types.ZelloHistoryLocationMessage.html +155 -13
- package/lib/module/docs/classes/types.ZelloHistoryTextMessage.html +131 -10
- package/lib/module/docs/classes/types.ZelloHistoryVoiceMessage.html +145 -10
- package/lib/module/docs/classes/types.ZelloImageMessage.html +130 -10
- package/lib/module/docs/classes/types.ZelloIncomingEmergency.html +114 -9
- package/lib/module/docs/classes/types.ZelloIncomingVoiceMessage.html +124 -8
- package/lib/module/docs/classes/types.ZelloLocationMessage.html +146 -12
- package/lib/module/docs/classes/types.ZelloOutgoingEmergency.html +98 -7
- package/lib/module/docs/classes/types.ZelloOutgoingVoiceMessage.html +120 -9
- package/lib/module/docs/classes/types.ZelloRecentEntry.html +114 -9
- package/lib/module/docs/classes/types.ZelloTextMessage.html +122 -9
- package/lib/module/docs/classes/types.ZelloTranscription.html +122 -0
- package/lib/module/docs/classes/types.ZelloTranslation.html +91 -0
- package/lib/module/docs/classes/types.ZelloUser.html +142 -11
- package/lib/module/docs/classes/types.ZelloUserSupportedFeatures.html +82 -5
- package/lib/module/docs/enums/events.ZelloEvent.html +563 -95
- package/lib/module/docs/enums/types.ZelloAccountStatus.html +67 -5
- package/lib/module/docs/enums/types.ZelloChannelAlertLevel.html +67 -5
- package/lib/module/docs/enums/types.ZelloChannelConnectionStatus.html +68 -3
- package/lib/module/docs/enums/types.ZelloChannelType.html +84 -0
- package/lib/module/docs/enums/types.ZelloConnectionError.html +68 -3
- package/lib/module/docs/enums/types.ZelloConnectionState.html +73 -3
- package/lib/module/docs/enums/types.ZelloContactType.html +73 -3
- package/lib/module/docs/enums/types.ZelloDispatchCallStatus.html +73 -3
- package/lib/module/docs/enums/types.ZelloOutgoingVoiceMessageError.html +63 -3
- package/lib/module/docs/enums/types.ZelloOutgoingVoiceMessageState.html +78 -3
- package/lib/module/docs/enums/types.ZelloRecentEntryType.html +78 -3
- package/lib/module/docs/enums/types.ZelloUserStatus.html +81 -7
- package/lib/module/docs/hierarchy.html +29 -1
- package/lib/module/docs/index.html +127 -29
- package/lib/module/docs/interfaces/specs_NativeZelloSdk.Spec.html +504 -0
- package/lib/module/docs/modules/events.html +37 -1
- package/lib/module/docs/modules/index.html +37 -1
- package/lib/module/docs/modules/sdk.html +37 -1
- package/lib/module/docs/modules/specs_NativeZelloSdk.html +41 -0
- package/lib/module/docs/modules/types.html +45 -1
- package/lib/module/docs/modules.html +36 -1
- package/lib/module/docs/types/types.ZelloChannelOptions.html +114 -9
- package/lib/module/docs/types/types.ZelloConfig.html +86 -7
- package/lib/module/docs/types/types.ZelloConsoleSettings.html +96 -9
- package/lib/module/docs/types/types.ZelloContact.html +80 -6
- package/lib/module/docs/types/types.ZelloCredentials.html +75 -6
- package/lib/module/docs/types/types.ZelloHistoryMessage.html +97 -8
- package/lib/module/docs/types/types.ZelloMessage.html +91 -7
- package/lib/module/docs/variables/specs_NativeZelloSdk.default.html +34 -0
- package/lib/module/events/index.js +217 -0
- package/lib/module/events/index.js.map +1 -1
- package/lib/module/sdk/index.js +730 -912
- package/lib/module/sdk/index.js.map +1 -1
- package/lib/module/specs/NativeZelloSdk.js +25 -0
- package/lib/module/specs/NativeZelloSdk.js.map +1 -0
- package/lib/module/types/index.js +378 -301
- package/lib/module/types/index.js.map +1 -1
- package/lib/module/utils/index.js +27 -5
- package/lib/module/utils/index.js.map +1 -1
- package/lib/typescript/commonjs/src/events/index.d.ts +9 -0
- package/lib/typescript/commonjs/src/events/index.d.ts.map +1 -1
- package/lib/typescript/commonjs/src/sdk/index.d.ts +10 -0
- package/lib/typescript/commonjs/src/sdk/index.d.ts.map +1 -1
- package/lib/typescript/commonjs/src/specs/NativeZelloSdk.d.ts +55 -0
- package/lib/typescript/commonjs/src/specs/NativeZelloSdk.d.ts.map +1 -0
- package/lib/typescript/commonjs/src/types/index.d.ts +106 -4
- package/lib/typescript/commonjs/src/types/index.d.ts.map +1 -1
- package/lib/typescript/commonjs/src/utils/index.d.ts +2 -1
- package/lib/typescript/commonjs/src/utils/index.d.ts.map +1 -1
- package/lib/typescript/module/src/events/index.d.ts +9 -0
- package/lib/typescript/module/src/events/index.d.ts.map +1 -1
- package/lib/typescript/module/src/index.d.ts +4 -4
- package/lib/typescript/module/src/index.d.ts.map +1 -1
- package/lib/typescript/module/src/sdk/index.d.ts +11 -1
- package/lib/typescript/module/src/sdk/index.d.ts.map +1 -1
- package/lib/typescript/module/src/specs/NativeZelloSdk.d.ts +55 -0
- package/lib/typescript/module/src/specs/NativeZelloSdk.d.ts.map +1 -0
- package/lib/typescript/module/src/types/index.d.ts +106 -4
- package/lib/typescript/module/src/types/index.d.ts.map +1 -1
- package/lib/typescript/module/src/utils/algorithms/index.d.ts +1 -1
- package/lib/typescript/module/src/utils/algorithms/index.d.ts.map +1 -1
- package/lib/typescript/module/src/utils/index.d.ts +2 -1
- package/lib/typescript/module/src/utils/index.d.ts.map +1 -1
- package/package.json +31 -15
- package/react-native-zello-sdk.podspec +26 -1
- package/src/events/index.ts +9 -0
- package/src/sdk/index.ts +106 -226
- package/src/specs/NativeZelloSdk.ts +89 -0
- package/src/types/index.ts +153 -6
- package/src/utils/index.ts +50 -3
|
@@ -1,11 +1,85 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ZelloUserStatus | @zelloptt/react-native-zello-sdk</title><meta name="description" content="Documentation for @zelloptt/react-native-zello-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"
|
|
2
|
-
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ZelloUserStatus | @zelloptt/react-native-zello-sdk</title><meta name="description" content="Documentation for @zelloptt/react-native-zello-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@zelloptt/react-native-zello-sdk</a>
|
|
3
|
+
<div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
|
|
4
|
+
<ul role="listbox" id="tsd-search-results"></ul>
|
|
5
|
+
<div id="tsd-search-status" aria-live="polite" aria-atomic="true">
|
|
6
|
+
<div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
|
|
7
|
+
<div class="container container-main">
|
|
8
|
+
<div class="col-content">
|
|
9
|
+
<div class="tsd-page-title">
|
|
10
|
+
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
|
+
<li><a href="../modules/types.html">types</a></li>
|
|
12
|
+
<li><a href="" aria-current="page">ZelloUserStatus</a></li></ul>
|
|
13
|
+
<h1>Enumeration ZelloUserStatus</h1></div>
|
|
14
|
+
<section class="tsd-panel tsd-comment">
|
|
15
|
+
<div class="tsd-comment tsd-typography"><p>The status of a <a href="../classes/types.ZelloUser.html" class="tsd-kind-class">ZelloUser</a>.</p>
|
|
16
|
+
</div></section><aside class="tsd-sources">
|
|
17
|
+
<ul>
|
|
18
|
+
<li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/a8e6918ca77e5e671290d7234c3a6ef937d161d5/src/types/index.ts#L58">src/types/index.ts:58</a></li></ul></aside>
|
|
19
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
20
|
+
<section class="tsd-panel tsd-index-panel">
|
|
21
|
+
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
22
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
23
|
+
<div class="tsd-accordion-details">
|
|
24
|
+
<section class="tsd-index-section">
|
|
25
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="enumeration-members">Enumeration Members<a href="#enumeration-members" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
26
|
+
<div class="tsd-index-list"><a href="#available" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>Available</span></a>
|
|
3
27
|
<a href="#busy" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>Busy</span></a>
|
|
4
28
|
<a href="#offline" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>Offline</span></a>
|
|
5
29
|
<a href="#standby" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>Standby</span></a>
|
|
6
|
-
</div></section></div></details></section></section
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
30
|
+
</div></section></div></details></section></section>
|
|
31
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Enumeration Members"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
32
|
+
<h2 class="tsd-anchor-link" id="enumeration-members-1">Enumeration Members<a href="#enumeration-members-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
33
|
+
<section>
|
|
34
|
+
<section class="tsd-panel tsd-member">
|
|
35
|
+
<h3 class="tsd-anchor-link" id="available"><span>Available</span><a href="#available" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
36
|
+
<div class="tsd-signature"><span class="tsd-kind-enum-member">Available</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"available"</span></div>
|
|
37
|
+
<div class="tsd-comment tsd-typography"><p>The user is connected. Messages will play live.</p>
|
|
38
|
+
</div><aside class="tsd-sources">
|
|
39
|
+
<ul>
|
|
40
|
+
<li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/a8e6918ca77e5e671290d7234c3a6ef937d161d5/src/types/index.ts#L62">src/types/index.ts:62</a></li></ul></aside></section>
|
|
41
|
+
<section class="tsd-panel tsd-member">
|
|
42
|
+
<h3 class="tsd-anchor-link" id="busy"><span>Busy</span><a href="#busy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
43
|
+
<div class="tsd-signature"><span class="tsd-kind-enum-member">Busy</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"busy"</span></div>
|
|
44
|
+
<div class="tsd-comment tsd-typography"><p>The user is connected. Messages will not play live.</p>
|
|
45
|
+
</div><aside class="tsd-sources">
|
|
46
|
+
<ul>
|
|
47
|
+
<li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/a8e6918ca77e5e671290d7234c3a6ef937d161d5/src/types/index.ts#L66">src/types/index.ts:66</a></li></ul></aside></section>
|
|
48
|
+
<section class="tsd-panel tsd-member">
|
|
49
|
+
<h3 class="tsd-anchor-link" id="offline"><span>Offline</span><a href="#offline" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
50
|
+
<div class="tsd-signature"><span class="tsd-kind-enum-member">Offline</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"offline"</span></div>
|
|
51
|
+
<div class="tsd-comment tsd-typography"><p>The user is disconnected and cannot receive messages.</p>
|
|
52
|
+
</div><aside class="tsd-sources">
|
|
53
|
+
<ul>
|
|
54
|
+
<li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/a8e6918ca77e5e671290d7234c3a6ef937d161d5/src/types/index.ts#L75">src/types/index.ts:75</a></li></ul></aside></section>
|
|
55
|
+
<section class="tsd-panel tsd-member">
|
|
56
|
+
<h3 class="tsd-anchor-link" id="standby"><span>Standby</span><a href="#standby" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
57
|
+
<div class="tsd-signature"><span class="tsd-kind-enum-member">Standby</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"standby"</span></div>
|
|
58
|
+
<div class="tsd-comment tsd-typography"><p>The user is disconnected. Messages will not play live.
|
|
10
59
|
The user will download messages sent to them when they reconnect.</p>
|
|
11
|
-
</div><
|
|
60
|
+
</div><aside class="tsd-sources">
|
|
61
|
+
<ul>
|
|
62
|
+
<li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/a8e6918ca77e5e671290d7234c3a6ef937d161d5/src/types/index.ts#L71">src/types/index.ts:71</a></li></ul></aside></section></section></details></div>
|
|
63
|
+
<div class="col-sidebar">
|
|
64
|
+
<div class="page-menu">
|
|
65
|
+
<div class="tsd-navigation settings">
|
|
66
|
+
<details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
67
|
+
<h3>Settings</h3></summary>
|
|
68
|
+
<div class="tsd-accordion-details">
|
|
69
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
70
|
+
<ul id="tsd-filter-options">
|
|
71
|
+
<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>
|
|
72
|
+
<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>
|
|
73
|
+
<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></div>
|
|
74
|
+
<div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
75
|
+
<details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
76
|
+
<h3>On This Page</h3></summary>
|
|
77
|
+
<div class="tsd-accordion-details">
|
|
78
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Enumeration Members"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Enumeration Members</summary>
|
|
79
|
+
<div><a href="#available"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>Available</span></a><a href="#busy"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>Busy</span></a><a href="#offline"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>Offline</span></a><a href="#standby"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>Standby</span></a></div></details></div></details></div>
|
|
80
|
+
<div class="site-menu">
|
|
81
|
+
<nav class="tsd-navigation"><a href="../modules.html">@zelloptt/react-native-zello-sdk</a>
|
|
82
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
83
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
84
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
85
|
+
<div class="overlay"></div></body></html>
|
|
@@ -1 +1,29 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@zelloptt/react-native-zello-sdk</title><meta name="description" content="Documentation for @zelloptt/react-native-zello-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@zelloptt/react-native-zello-sdk</title><meta name="description" content="Documentation for @zelloptt/react-native-zello-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container"><a href="index.html" class="title">@zelloptt/react-native-zello-sdk</a>
|
|
3
|
+
<div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
|
|
4
|
+
<ul role="listbox" id="tsd-search-results"></ul>
|
|
5
|
+
<div id="tsd-search-status" aria-live="polite" aria-atomic="true">
|
|
6
|
+
<div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header>
|
|
7
|
+
<div class="container container-main">
|
|
8
|
+
<div class="col-content">
|
|
9
|
+
<div class="tsd-page-title">
|
|
10
|
+
<h1>@zelloptt/react-native-zello-sdk</h1></div>
|
|
11
|
+
<h2>Hierarchy Summary</h2></div>
|
|
12
|
+
<div class="col-sidebar">
|
|
13
|
+
<div class="page-menu">
|
|
14
|
+
<div class="tsd-navigation settings">
|
|
15
|
+
<details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>
|
|
16
|
+
<h3>Settings</h3></summary>
|
|
17
|
+
<div class="tsd-accordion-details">
|
|
18
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
19
|
+
<ul id="tsd-filter-options">
|
|
20
|
+
<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>
|
|
21
|
+
<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>
|
|
22
|
+
<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></div>
|
|
23
|
+
<div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div>
|
|
24
|
+
<div class="site-menu">
|
|
25
|
+
<nav class="tsd-navigation"><a href="modules.html">@zelloptt/react-native-zello-sdk</a>
|
|
26
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
27
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
28
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
29
|
+
<div class="overlay"></div></body></html>
|
|
@@ -1,52 +1,109 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@zelloptt/react-native-zello-sdk</title><meta name="description" content="Documentation for @zelloptt/react-native-zello-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"
|
|
2
|
-
<
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@zelloptt/react-native-zello-sdk</title><meta name="description" content="Documentation for @zelloptt/react-native-zello-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container"><a href="index.html" class="title">@zelloptt/react-native-zello-sdk</a>
|
|
3
|
+
<div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
|
|
4
|
+
<ul role="listbox" id="tsd-search-results"></ul>
|
|
5
|
+
<div id="tsd-search-status" aria-live="polite" aria-atomic="true">
|
|
6
|
+
<div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header>
|
|
7
|
+
<div class="container container-main">
|
|
8
|
+
<div class="col-content">
|
|
9
|
+
<div class="tsd-page-title">
|
|
10
|
+
<h1>@zelloptt/react-native-zello-sdk</h1></div>
|
|
11
|
+
<div class="tsd-panel tsd-typography"><h1 id="react-native-zello-sdk" class="tsd-anchor-link">react-native-zello-sdk<a href="#react-native-zello-sdk" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1>
|
|
12
|
+
<p>Zello SDK for React Native.</p>
|
|
13
|
+
<p>Our React Native SDK offers itself as a thin wrapper around our native iOS and Android SDK’s. It is built with TypeScript, and communicates with the native SDK’s via a <a href="https://reactnative.dev/docs/turbo-native-modules-introduction">Turbo Native Module</a> on React Native’s New Architecture.</p>
|
|
3
14
|
<p>This repository contains both the React Native Bridge, as well as an example app to demonstrate usage.</p>
|
|
4
15
|
<p>To see an example of the React Native SDK, check out <a href="https://github.com/zelloptt/react-native-zello-sdk/tree/master/example">the example folder</a>.</p>
|
|
5
16
|
<p>The following instructions are for the installation of the SDK into your application - <strong>not</strong> for the example app.</p>
|
|
6
|
-
<h2 id="prerequisites" class="tsd-anchor-link">Prerequisites<a href="#prerequisites" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2
|
|
17
|
+
<h2 id="prerequisites" class="tsd-anchor-link">Prerequisites<a href="#prerequisites" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
|
|
18
|
+
<p>A React Native application and environment.</p>
|
|
19
|
+
<ul>
|
|
20
|
+
<li><strong>React Native 0.86+</strong> with the <strong>New Architecture enabled</strong> (the default since 0.76). This SDK is a Turbo Native Module and does not support the legacy architecture.</li>
|
|
21
|
+
<li><strong>Node 20+</strong> (Node 22+ recommended, matching the React Native 0.86 toolchain).</li>
|
|
22
|
+
</ul>
|
|
7
23
|
<p>A thorough understanding of Zello. The best place to get started is our <a href="https://sdk.zello.com/">documentation</a>.</p>
|
|
8
|
-
<h2 id="installation" class="tsd-anchor-link">Installation<a href="#installation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2
|
|
24
|
+
<h2 id="installation" class="tsd-anchor-link">Installation<a href="#installation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
|
|
25
|
+
<p>Install the package via NPM:</p>
|
|
9
26
|
<pre><code class="sh"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">install</span><span class="hl-1"> </span><span class="hl-2">@zelloptt/react-native-zello-sdk</span>
|
|
10
27
|
</code><button type="button">Copy</button></pre>
|
|
11
28
|
|
|
12
|
-
<h3 id="ios" class="tsd-anchor-link">iOS<a href="#ios" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3
|
|
13
|
-
<p>
|
|
14
|
-
<h4 id="
|
|
29
|
+
<h3 id="ios" class="tsd-anchor-link">iOS<a href="#ios" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
30
|
+
<p>Before getting started, please reference the <a href="https://developers.zello.com/sdk/latest/ios/documentation/zellosdk/getting-started">iOS Installation Guide</a>. There is no need to add the native <code>ZelloSDK</code> to your project directly — this library declares it for you.</p>
|
|
31
|
+
<h4 id="native-zellosdk-cocoapods-default-or-swift-package-manager" class="tsd-anchor-link">Native ZelloSDK: CocoaPods (default) or Swift Package Manager<a href="#native-zellosdk-cocoapods-default-or-swift-package-manager" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4>
|
|
32
|
+
<p>The native ZelloSDK can be consumed two ways. <strong>Full CocoaPods removal is not yet possible</strong> because React Native itself still requires CocoaPods for its core (Swift-Package-Manager-only React Native is an <a href="https://github.com/react-native-community/discussions-and-proposals/pull/994">in-progress RN proposal</a>). So, like <a href="https://github.com/getsentry/sentry-react-native/issues/5780"><code>sentry-react-native</code></a>, the React Native layer stays on CocoaPods while the native ZelloSDK can opt into SPM.</p>
|
|
33
|
+
<div class="tsd-alert tsd-alert-note"><div class="tsd-alert-title"><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 16 16" aria-hidden="true"><use href="assets/icons.svg#icon-alertNote"></use></svg><span>Note</span></div><p>
|
|
34
|
+
CocoaPods support for the native ZelloSDK is <strong>deprecated</strong> (still supported); Swift Package Manager is the recommended path going forward.</p>
|
|
35
|
+
</div>
|
|
36
|
+
<ul>
|
|
37
|
+
<li><strong>CocoaPods (default):</strong> just <code>bundle exec pod install</code> — the <code>ZelloSDK</code> pod is pulled automatically.</li>
|
|
38
|
+
<li><strong>Swift Package Manager (recommended):</strong> set <code>ZELLO_USE_SPM=1</code> before installing pods:<pre><code class="sh"><span class="hl-3">ZELLO_USE_SPM</span><span class="hl-1">=</span><span class="hl-2">1</span><span class="hl-1"> </span><span class="hl-0">bundle</span><span class="hl-1"> </span><span class="hl-2">exec</span><span class="hl-1"> </span><span class="hl-2">pod</span><span class="hl-1"> </span><span class="hl-2">install</span>
|
|
39
|
+
</code><button type="button">Copy</button></pre>
|
|
40
|
+
|
|
41
|
+
This pulls ZelloSDK from <a href="https://github.com/zelloptt/ios-mobile-sdk"><code>github.com/zelloptt/ios-mobile-sdk</code></a> (product <code>ZelloSDKUmbrella</code>, up to the next major from <code>2.0.0</code>) as prebuilt XCFrameworks. Also add the <code>ZelloSDKUmbrella</code> package product to your <strong>Notification Service Extension</strong> target.</li>
|
|
42
|
+
</ul>
|
|
43
|
+
<h4 id="cocoapods-required-build-setting-xcode-1626" class="tsd-anchor-link">CocoaPods: required build setting (Xcode 16/26+)<a href="#cocoapods-required-build-setting-xcode-1626" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4>
|
|
44
|
+
<p>When using the <strong>CocoaPods</strong> path, ZelloSDK's prebuilt binary links library-evolution ("resilient") symbols from its Swift dependencies. You must build those pods for distribution in your <code>Podfile</code> <code>post_install</code>, or the app will crash at launch with <code>dyld: Symbol not found</code>:</p>
|
|
45
|
+
<pre><code class="ruby">post_install do |installer|
|
|
46
|
+
installer.pods_project.targets.each do |target|
|
|
47
|
+
if %w[PhoneNumberKit SnowplowTracker CocoaLumberjack PromisesSwift].include?(target.name)
|
|
48
|
+
target.build_configurations.each do |config|
|
|
49
|
+
config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'
|
|
50
|
+
end
|
|
51
|
+
end
|
|
52
|
+
end
|
|
53
|
+
# ...your existing react_native_post_install(...) call...
|
|
54
|
+
end
|
|
55
|
+
</code><button type="button">Copy</button></pre>
|
|
56
|
+
|
|
57
|
+
<p>The <strong>SPM</strong> path does not need this — its XCFrameworks are already built resiliently.</p>
|
|
58
|
+
<h4 id="troubleshooting" class="tsd-anchor-link">Troubleshooting<a href="#troubleshooting" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4>
|
|
59
|
+
<p>While setting up your Notification Service Extension, you may receive an error:</p>
|
|
15
60
|
<pre><code><span class="hl-3">Cycle</span><span class="hl-1"> </span><span class="hl-3">inside</span><span class="hl-1"> </span><span class="hl-3">YourApp</span><span class="hl-1">; </span><span class="hl-3">building</span><span class="hl-1"> </span><span class="hl-3">could</span><span class="hl-1"> </span><span class="hl-3">produce</span><span class="hl-1"> </span><span class="hl-3">unreliable</span><span class="hl-1"> </span><span class="hl-3">results</span><span class="hl-1">.</span><br/><span class="hl-3">Cycle</span><span class="hl-1"> </span><span class="hl-4">details</span><span class="hl-1">:</span><br/><span class="hl-1">→ </span><span class="hl-3">Target</span><span class="hl-1"> ‘</span><span class="hl-3">YourApp</span><span class="hl-1">’</span><br/><span class="hl-1">○ </span><span class="hl-3">That</span><span class="hl-1"> </span><span class="hl-3">command</span><span class="hl-1"> </span><span class="hl-3">depends</span><span class="hl-1"> </span><span class="hl-3">on</span><span class="hl-1"> </span><span class="hl-3">command</span><span class="hl-1"> </span><span class="hl-5">in</span><span class="hl-1"> </span><span class="hl-3">Target</span><span class="hl-1"> ‘</span><span class="hl-3">YourApp</span><span class="hl-1">’: </span><span class="hl-3">script</span><span class="hl-1"> </span><span class="hl-3">phase</span><span class="hl-1"> “[</span><span class="hl-6">CP</span><span class="hl-1">-</span><span class="hl-3">User</span><span class="hl-1">] [</span><span class="hl-6">RNFB</span><span class="hl-1">] </span><span class="hl-3">Core</span><span class="hl-1"> </span><span class="hl-3">Configuration</span><span class="hl-1">”</span>
|
|
16
61
|
</code><button>Copy</button></pre>
|
|
17
62
|
|
|
18
63
|
<p>If you receive the above error, you should move the <code>Build Phases</code> phase named <code>Embed Foundation Extensions</code> to higher up in the order.</p>
|
|
19
|
-
<h3 id="android" class="tsd-anchor-link">Android<a href="#android" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3
|
|
20
|
-
<
|
|
64
|
+
<h3 id="android" class="tsd-anchor-link">Android<a href="#android" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
65
|
+
<p>Before getting started, please reference the <a href="https://sdk.zello.com/installation-guides/android-installation-guide">Android Installation Guide</a>.</p>
|
|
66
|
+
<h4 id="dependencies" class="tsd-anchor-link">Dependencies<a href="#dependencies" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4>
|
|
67
|
+
<p>You may or may not need to add the repositories to your app's <code>build.gradle</code>:</p>
|
|
21
68
|
<pre><code><span class="hl-3">repositories</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">google</span><span class="hl-1">()</span><br/><span class="hl-1"> </span><span class="hl-0">mavenCentral</span><span class="hl-1">()</span><br/><span class="hl-1"> </span><span class="hl-3">maven</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-3">url</span><span class="hl-1"> = </span><span class="hl-0">uri</span><span class="hl-1">(</span><span class="hl-2">"https://zello-sdk.s3.amazonaws.com/android/latest"</span><span class="hl-1">)</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
|
|
22
69
|
</code><button>Copy</button></pre>
|
|
23
70
|
|
|
24
|
-
<h4 id="linking" class="tsd-anchor-link">Linking<a href="#linking" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4
|
|
25
|
-
<p>
|
|
26
|
-
<
|
|
71
|
+
<h4 id="linking" class="tsd-anchor-link">Linking<a href="#linking" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4>
|
|
72
|
+
<p>Since the Zello Android SDK requires Hilt, and we must inject the <code>Zello</code> instance into the package, the project does not work with autolinking.</p>
|
|
73
|
+
<p>Because the module is now a Turbo Native Module (New Architecture), the package must be a <code>BaseReactPackage</code> that exposes the module through a <code>ReactModuleInfoProvider</code> with <code>isTurboModule = true</code>:</p>
|
|
74
|
+
<pre><code class="kotlin">/// ZelloAndroidSdkPackage.kt
|
|
27
75
|
|
|
28
|
-
import com.facebook.react.
|
|
76
|
+
import com.facebook.react.BaseReactPackage
|
|
29
77
|
import com.facebook.react.bridge.NativeModule
|
|
30
78
|
import com.facebook.react.bridge.ReactApplicationContext
|
|
31
|
-
import com.facebook.react.
|
|
79
|
+
import com.facebook.react.module.model.ReactModuleInfo
|
|
80
|
+
import com.facebook.react.module.model.ReactModuleInfoProvider
|
|
32
81
|
import com.zello.sdk.Zello
|
|
33
82
|
import com.zellosdk.ZelloAndroidSdkModule
|
|
34
83
|
import javax.inject.Inject
|
|
35
84
|
|
|
36
|
-
class ZelloAndroidSdkPackage @Inject constructor(private val zello: Zello) :
|
|
37
|
-
|
|
38
|
-
override fun
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
85
|
+
class ZelloAndroidSdkPackage @Inject constructor(private val zello: Zello) : BaseReactPackage() {
|
|
86
|
+
|
|
87
|
+
override fun getModule(name: String, reactContext: ReactApplicationContext): NativeModule? =
|
|
88
|
+
if (name == "NativeZelloSdk") ZelloAndroidSdkModule(reactContext, zello) else null
|
|
89
|
+
|
|
90
|
+
override fun getReactModuleInfoProvider() = ReactModuleInfoProvider {
|
|
91
|
+
mapOf(
|
|
92
|
+
"NativeZelloSdk" to ReactModuleInfo(
|
|
93
|
+
"NativeZelloSdk", // name
|
|
94
|
+
"NativeZelloSdk", // className
|
|
95
|
+
false, // canOverrideExistingModule
|
|
96
|
+
false, // needsEagerInit
|
|
97
|
+
false, // isCxxModule
|
|
98
|
+
true // isTurboModule
|
|
99
|
+
)
|
|
100
|
+
)
|
|
44
101
|
}
|
|
45
102
|
}
|
|
46
103
|
</code><button type="button">Copy</button></pre>
|
|
47
104
|
|
|
48
105
|
<p>Then, add it to the packages list:</p>
|
|
49
|
-
<pre><code class="
|
|
106
|
+
<pre><code class="kotlin">/// MainApplication.kt
|
|
50
107
|
|
|
51
108
|
@HiltAndroidApp
|
|
52
109
|
class MainApplication : Application(), ReactApplication {
|
|
@@ -55,13 +112,13 @@ class MainApplication : Application(), ReactApplication {
|
|
|
55
112
|
|
|
56
113
|
override val reactNativeHost: ReactNativeHost =
|
|
57
114
|
object : DefaultReactNativeHost(this) {
|
|
58
|
-
override fun getPackages(): List
|
|
115
|
+
override fun getPackages(): List<ReactPackage> =
|
|
59
116
|
PackageList(this).packages.apply {
|
|
60
117
|
// Packages that cannot be autolinked yet can be added manually here, for example:
|
|
61
118
|
add(ZelloAndroidSdkPackage(zello))
|
|
62
119
|
}
|
|
63
120
|
|
|
64
|
-
override fun getJSMainModuleName(): String =
|
|
121
|
+
override fun getJSMainModuleName(): String = "index"
|
|
65
122
|
|
|
66
123
|
override fun getUseDeveloperSupport(): Boolean = BuildConfig.DEBUG
|
|
67
124
|
|
|
@@ -71,14 +128,55 @@ class MainApplication : Application(), ReactApplication {
|
|
|
71
128
|
|
|
72
129
|
override fun onCreate() {
|
|
73
130
|
super.onCreate()
|
|
74
|
-
// Don
|
|
131
|
+
// Don't forget to start the SDK!
|
|
75
132
|
zello.start()
|
|
76
133
|
}
|
|
77
134
|
}
|
|
78
135
|
</code><button type="button">Copy</button></pre>
|
|
79
136
|
|
|
80
|
-
<h2 id="contributing" class="tsd-anchor-link">Contributing<a href="#contributing" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2
|
|
81
|
-
<
|
|
137
|
+
<h2 id="contributing" class="tsd-anchor-link">Contributing<a href="#contributing" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
|
|
138
|
+
<p>See the <a href="media/CONTRIBUTING.md">contributing guide</a> to learn how to contribute to the repository and the development workflow.</p>
|
|
139
|
+
<h2 id="license" class="tsd-anchor-link">License<a href="#license" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
|
|
140
|
+
<p>MIT</p>
|
|
82
141
|
<hr>
|
|
83
142
|
<p>Made with <a href="https://github.com/callstack/react-native-builder-bob">create-react-native-library</a></p>
|
|
84
|
-
</div></div
|
|
143
|
+
</div></div>
|
|
144
|
+
<div class="col-sidebar">
|
|
145
|
+
<div class="page-menu">
|
|
146
|
+
<div class="tsd-navigation settings">
|
|
147
|
+
<details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>
|
|
148
|
+
<h3>Settings</h3></summary>
|
|
149
|
+
<div class="tsd-accordion-details">
|
|
150
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
151
|
+
<ul id="tsd-filter-options">
|
|
152
|
+
<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>
|
|
153
|
+
<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>
|
|
154
|
+
<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></div>
|
|
155
|
+
<div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
156
|
+
<details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>
|
|
157
|
+
<h3>On This Page</h3></summary>
|
|
158
|
+
<div class="tsd-accordion-details"><a href="#react-native-zello-sdk"><span>react-<wbr/>native-<wbr/>zello-<wbr/>sdk</span></a>
|
|
159
|
+
<ul>
|
|
160
|
+
<li><a href="#prerequisites"><span>Prerequisites</span></a></li>
|
|
161
|
+
<li><a href="#installation"><span>Installation</span></a></li>
|
|
162
|
+
<li>
|
|
163
|
+
<ul>
|
|
164
|
+
<li><a href="#ios"><span>i<wbr/>OS</span></a></li>
|
|
165
|
+
<li>
|
|
166
|
+
<ul>
|
|
167
|
+
<li><a href="#native-zellosdk-cocoapods-default-or-swift-package-manager"><span>Native <wbr/>Zello<wbr/>SDK: <wbr/>Cocoa<wbr/>Pods (default) or <wbr/>Swift <wbr/>Package <wbr/>Manager</span></a></li>
|
|
168
|
+
<li><a href="#cocoapods-required-build-setting-xcode-1626"><span>Cocoa<wbr/>Pods: required build setting (<wbr/>Xcode 16/26+)</span></a></li>
|
|
169
|
+
<li><a href="#troubleshooting"><span>Troubleshooting</span></a></li></ul></li>
|
|
170
|
+
<li><a href="#android"><span>Android</span></a></li>
|
|
171
|
+
<li>
|
|
172
|
+
<ul>
|
|
173
|
+
<li><a href="#dependencies"><span>Dependencies</span></a></li>
|
|
174
|
+
<li><a href="#linking"><span>Linking</span></a></li></ul></li></ul></li>
|
|
175
|
+
<li><a href="#contributing"><span>Contributing</span></a></li>
|
|
176
|
+
<li><a href="#license"><span>License</span></a></li></ul></div></details></div>
|
|
177
|
+
<div class="site-menu">
|
|
178
|
+
<nav class="tsd-navigation"><a href="modules.html">@zelloptt/react-native-zello-sdk</a>
|
|
179
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
180
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
181
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
182
|
+
<div class="overlay"></div></body></html>
|