Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/saasquatch/squatch-android
Official Android SDK for SaaSquatch. REST API wrapper and widgets in Android WebViews
https://github.com/saasquatch/squatch-android
android android-webview java jitpack reactive-streams rxjava saasquatch-java-sdk sdk webview
Last synced: 3 months ago
JSON representation
Official Android SDK for SaaSquatch. REST API wrapper and widgets in Android WebViews
- Host: GitHub
- URL: https://github.com/saasquatch/squatch-android
- Owner: saasquatch
- License: apache-2.0
- Created: 2021-02-09T22:20:46.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-15T22:57:05.000Z (3 months ago)
- Last Synced: 2024-11-15T23:26:36.967Z (3 months ago)
- Topics: android, android-webview, java, jitpack, reactive-streams, rxjava, saasquatch-java-sdk, sdk, webview
- Language: Java
- Homepage:
- Size: 330 KB
- Stars: 5
- Watchers: 8
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# SquatchAndroid
[](https://opensource.org/licenses/Apache-2.0)
[](https://jitpack.io/#saasquatch/squatch-android)
Helper library for loading SaaSquatch widgets in Android WebView
## Adding SquatchAndroid to your project
SquatchAndroid is hosted on JitPack.
Add JitPack repository:
```gradle
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
```
Add the dependency:
```gradle
dependencies {
implementation 'com.github.saasquatch:squatch-android:0.0.9'
}
```
For more information and other built tools, [please refer to the JitPack page](https://jitpack.io/#saasquatch/squatch-android).
This library relies on [SaaSquatch Java SDK](https://github.com/saasquatch/saasquatch-java-sdk), which has transitive dependencies including [RxJava 3](https://github.com/ReactiveX/RxJava), [Gson](https://github.com/google/gson), and [Apache HttpClient 5](https://hc.apache.org/httpcomponents-client-5.0.x/index.html). This library also has [RxAndroid](https://github.com/ReactiveX/RxAndroid) as a transitive dependency. **It is recommended that you explicitly import the transitive dependencies if you intend to use them**, since we may upgrade or switch to other libraries in the future. You do NOT, however, need to explicitly include [SaaSquatch Java SDK](https://github.com/saasquatch/saasquatch-java-sdk), as it is exposed in public interfaces in this library.
## Using the SDK
This library is a wrapper of [SaaSquatch Java SDK](https://github.com/saasquatch/saasquatch-java-sdk) with Android specific features, specifically loading widgets into a WebView. In fact, The `SquatchAndroid` interface has a method called `getSaaSquatchClient()`, which you can use to retrieve the underlying `SaaSquatchClient`. Depending on your use case, [SaaSquatch Java SDK](https://github.com/saasquatch/saasquatch-java-sdk) may be what you need.
The entry point of the SDK is `SquatchAndroid`. To create a `SquatchAndroid` for your tenant with default options, use:
```java
SquatchAndroid.createForTenant("yourTenantAlias");
```
It is recommended that you keep a singleton `SquatchAndroid` for all your requests instead of creating a new `SquatchAndroid` for every request. `SquatchAndroid` implements `Closeable`, and it's a good idea to call `close()` to release resources when you are done with it.
`SquatchAndroid` returns [Reactive Streams](https://www.reactive-streams.org/) interfaces. Assuming you are using RxJava, then a typical API call made with this SDK would look something like this:
```java
Flowable.fromPublisher(squatchAndroid.widgetUpsert(
WidgetUpsertInput.newBuilder()
.setUserInputWithUserJwt(userJwt)
.setWidgetType(WidgetType.ofProgramWidget("referral-program", "referrerWidget"))
.setEngagementMedium("MOBILE")
.build(),
null, AndroidRenderWidgetOptions.ofWebView(webView)))
.onErrorComplete() // or provide your own error handling
.subscribe();
```
In the code above, a widget upsert is performed asynchronously with the given `userJwt`, and the resulting widget is loaded into the given `webView` with the Android main thread.
## More Code Samples
Widget upsert while setting a user's `customFields`
```java
final Map userInput = new HashMap<>();
userInput.put("id", "a");
userInput.put("accountId", "a");
final Map customFields = new HashMap<>();
customFields.put("birthday", "--12-25");
userInput.put("customFields", customFields);
Flowable.fromPublisher(squatchAndroid.widgetUpsert(
WidgetUpsertInput.newBuilder()
.setUserInput(userInput)
.setEngagementMedium("MOBILE")
.build(),
RequestOptions.newBuilder()
.setAuthMethod(AuthMethod.ofJwt(userJwt))
.build(),
AndroidRenderWidgetOptions.ofWebView(webView)))
.onErrorComplete() // or provide your own error handling
.subscribe();
```
Rendering a widget for a user
```java
Flowable.fromPublisher(squatchAndroid.renderWidget(
RenderWidgetInput.newBuilder()
.setUserWithUserJwt(userJwt) // Can be omitted to render a widget without user information
.setWidgetType(WidgetType.ofProgramWidget("referral-program", "referrerWidget"))
.setEngagementMedium("MOBILE")
.build(),
null, AndroidRenderWidgetOptions.ofWebView(webView)))
.onErrorComplete() // or provide your own error handling
.subscribe();
```
Logging an event for a user (using the underlying `SaaSquatchClient`)
```java
final Map fields = new HashMap<>();
fields.put("currency", "CAD");
Flowable.fromPublisher(squatchAndroid.getSaaSquatchClient().logUserEvent(
UserEventInput.newBuilder()
.setAccountId("a")
.setUserId("a")
.addEvents(UserEventDataInput.newBuilder()
.setKey("purchase")
.setFields(fields)
.build())
.build(),
RequestOptions.newBuilder()
.setAuthMethod(AuthMethod.ofJwt(userJwt))
.build()))
// This is necessary so the main thread does not start the IO operation
.subscribeOn(Schedulers.io())
.onErrorComplete() // or provide your own error handling
.subscribe();
```
## License
Unless explicitly stated otherwise all files in this repository are licensed under the Apache
License 2.0.
License boilerplate:
```
Copyright 2023 ReferralSaaSquatch.com, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```