{"id":13764494,"url":"https://github.com/webex/spark-android-sdk","last_synced_at":"2026-01-11T16:55:55.901Z","repository":{"id":57718225,"uuid":"104698453","full_name":"webex/spark-android-sdk","owner":"webex","description":"This repo is DEPRECATED. Check our newer Android SDK","archived":false,"fork":false,"pushed_at":"2019-04-03T22:46:12.000Z","size":20785,"stargazers_count":10,"open_issues_count":1,"forks_count":2,"subscribers_count":30,"default_branch":"master","last_synced_at":"2025-04-13T12:08:58.204Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://github.com/webex/webex-android-sdk","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/webex.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-09-25T03:17:56.000Z","updated_at":"2023-01-31T15:45:09.000Z","dependencies_parsed_at":"2022-09-26T22:00:50.002Z","dependency_job_id":null,"html_url":"https://github.com/webex/spark-android-sdk","commit_stats":null,"previous_names":["ciscospark/spark-android-sdk"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webex%2Fspark-android-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webex%2Fspark-android-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webex%2Fspark-android-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webex%2Fspark-android-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/webex","download_url":"https://codeload.github.com/webex/spark-android-sdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248710433,"owners_count":21149190,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-03T16:00:21.551Z","updated_at":"2026-01-11T16:55:55.894Z","avatar_url":"https://github.com/webex.png","language":"Java","funding_links":[],"categories":["Client SDKs"],"sub_categories":["Advanced APIs"],"readme":"This repo is DEPRECATED. Check our newer Android SDK: https://github.com/webex/webex-android-sdk\n\n# Cisco Spark Android SDK\n\n[![Travis CI](https://travis-ci.org/webex/spark-android-sdk.svg)](https://travis-ci.org/webex/spark-android-sdk)\n[![license](https://img.shields.io/github/license/webex/spark-android-sdk.svg)](https://github.com/webex/spark-android-sdk/blob/master/LICENSE)\n\n\u003e The Cisco Spark™ Android SDK\n\nThe Cisco Spark Android SDK makes it easy to integrate secure and convenient Cisco Spark messaging and calling features in your Android apps.\n\nThis SDK is built with **Android SDK Tools 27** and requires **Android API Level 21** or later.\n\n## Table of Contents\n\n- [Install](#install)\n- [Usage](#usage)\n- [Contribute](#contribute)\n- [License](#license)\n\n## Install\n\nAssuming you already have an Android project, e.g. _MySparkApp_, for your Android app, here are the steps to integrate the Cisco Spark Android SDK into your project using [Gradle](https://gradle.org):\n\n1. Add the following repository to your top-level `build.gradle` file:\n\n    ```groovy\n    allprojects {\n        repositories {\n            jcenter()\n            maven {\n                url 'https://devhub.cisco.com/artifactory/sparksdk/'\n            }\n        }\n    }\n    ```\n\n2. Add the `spark-android-sdk` library as a dependency for your app in the `build.gradle` file:\n\n    ```groovy\n    dependencies { \n        compile('com.ciscospark:androidsdk:1.4.0@aar', {\n            transitive = true\n        })\n    }\n    ```\n\n3. Enable [multidex](https://developer.android.com/studio/build/multidex.html) support for your app:\n\n    ```groovy\n    android {\n        defaultConfig {\n            multiDexEnabled true\n        }\n    }\n    ```\n    \n4. Exclude rxjava.properties in your packagingOptions :\n\n    ```groovy\n    packagingOptions {\n        exclude 'META-INF/rxjava.properties'\n    }\n    ```\n\n## Usage\n\nTo use the SDK, you will need Cisco Spark integration credentials. If you do not already have a Cisco Spark account, visit the [Cisco Spark for Developers portal](https://developer.ciscospark.com/) to create your account and [register an integration](https://developer.ciscospark.com/authentication.html#registering-your-integration). Your app will need to authenticate users via an [OAuth](https://oauth.net/) grant flow for existing Cisco Spark users or a [JSON Web Token](https://jwt.io/) for guest users without a Cisco Spark account.\n\nSee the [Android SDK area](https://developer.ciscospark.com/sdk-for-android.html) of the Cisco Spark for Developers site for more information about this SDK.\n\n### Examples\n\nHere are some examples of how to use the Android SDK in your app.\n\n1. Create a new `Spark` instance using Spark ID authentication ([OAuth](https://oauth.net/)-based):\n\n    ```java\n    String clientId = \"YOUR_CLIENT_ID\";\n    String clientSecret = \"YOUR_CLIENT_SECRET\";\n    String scope = \"spark:all\";\n    String redirectUri = \"Sparkdemoapp://response\";\n\n    OAuthWebViewAuthenticator authenticator = new OAuthWebViewAuthenticator(clientId, clientSecret, scope, redirectUri);\n    Spark spark = new Spark(activity.getApplication(), authenticator)\n    if (!authenticator.isAuthorized()) {\n        authenticator.authorize(webView, new CompletionHandler\u003cVoid\u003e() {\n            @Override\n            public void onComplete(Result\u003cVoid\u003e result) {\n                if (!result.isSuccessful()) {\n                    System.out.println(\"User not authorized\");\n                }\n            }\n        });\n    }\n    ```\n\n2. Create a new `Spark` instance using Guest ID authentication ([JWT](https://jwt.io/)-based):\n\n    ```java\n    JWTAuthenticator authenticator = new JWTAuthenticator();\n    Spark spark = new Spark(activity.getApplication(), authenticator);\n    if (!authenticator.isAuthorized()) {\n        authenticator.authorize(myJwt);\n    }\n    ```\n\n3. Register the device to send and receive calls:\n\n    ```java\n    spark.phone().register(new CompletionHandler\u003cVoid\u003e() {\n        @Override\n        public void onComplete(Result\u003cVoid\u003e result) {\n            if (result.isSuccessful()) {\n                // Device registered\n            }\n            else {\n                // Device not registered, and calls will not be sent or received\n            }\n        }\n    });\n    ```\n\n4. Create a new Cisco Spark space, add users to the space, and send a message:\n\n    ```java\n    // Create a Cisco Spark space:\n\n    spark.rooms().create(\"Hello World\", null, new CompletionHandler\u003cRoom\u003e() {\n        @Override\n        public void onComplete(Result\u003cRoom\u003e result) {\n            if (result.isSuccessful()) {\n                Room room = result.getData();\n            }\n            else {\n                SparkError error = result.getError();\n            }\n        }\n    });\n    \n    // Add a user to a space:\n\n    spark.memberships().create(roomId, null, \"person@example.com\", true, new CompletionHandler\u003cMembership\u003e() {\n        @Override\n        public void onComplete(Result\u003cMembership\u003e result) {\n            if (result.isSuccessful()) {\n                Membership membership = result.getData();\n            }\n            else {\n                SparkError error = result.getError();\n            }\n        }\n    });\n\n    // Send a message to a space:\n\n    spark.messages().post(roomId, null, null, \"Hello there\", null, null, new CompletionHandler\u003cMessage\u003e() {\n        @Override\n        public void onComplete(Result\u003cMessage\u003e result) {\n            if (result.isSuccessful()) {\n                Message message = result.getData();\n            }\n            else {\n                SparkError error = result.getError();\n            }\n        }\n    });\n    ```\n\n5. Make an outgoing call:\n\n    ```java\n    spark.phone().dial(\"person@example.com\", MediaOption.audioVideo(local, remote), new CompletionHandler\u003cCall\u003e() {\n        @Override\n        public void onComplete(Result\u003cCall\u003e result) {\n            Call call = result.getData();\n            if (call != null) {\n                call.setObserver(new CallObserver() {\n                    @Override\n                    public void onRinging(Call call) {\n\n                    }\n\n                    @Override\n                    public void onConnected(Call call) {\n\n                    }\n\n                    @Override\n                    public void onDisconnected(CallDisconnectedEvent callDisconnectedEvent) {\n\n                    }\n\n                    @Override\n                    public void onMediaChanged(MediaChangedEvent mediaChangedEvent) {\n\n                    }\n                });\n            }\n            else {\n                SparkError error = result.getError();\n            }\n        }\n    });\n    ```\n\n6. Receive a call:\n\n    ```java\n    spark.phone().setIncomingCallListener(new Phone.IncomingCallListener() {\n        @Override\n        public void onIncomingCall(Call call) {\n            call.answer(MediaOption.audioVideo(local, remote), new CompletionHandler\u003cVoid\u003e() {\n                @Override\n                public void onComplete(Result\u003cVoid\u003e result) {\n                    if (result.isSuccessful()) {\n                        // success\n                    }\n                    else {\n                        SparkError error = result.getError();\n                    }\n                }\n            });\n        }\n    });\n    ```\n7. Make an room call:\n\n    ```java\n    spark.phone().dial(roomId, MediaOption.audioVideoSharing(new Pair\u003c\u003e(localView,remoteView),shareView), new CompletionHandler\u003cCall\u003e() {\n        @Override\n        public void onComplete(Result\u003cCall\u003e result) {\n            Call call = result.getData();\n            if (call != null) {\n                call.setObserver(new CallObserver() {\n                    @Override\n                    public void onConnected(Call call) {\n\n                    }\n\n                 \t//...\n\n                    @Override\n                    public void onCallMembershipChanged(CallMembershipChangedEvent callMembershipChangeEvent) {\n                        CallMembership membership = callMembershipChangeEvent.getCallMembership();\n                        if (callMembershipChangeEvent instanceof MembershipJoinedEvent) {\n\n                        } else if (callMembershipChangeEvent instanceof MembershipLeftEvent) {\n\n                        } else if (callMembershipChangeEvent instanceof MembershipDeclinedEvent) {\n\n                        } else if (callMembershipChangeEvent instanceof MembershipSendingVideoEvent) {\n\n                        } else if (callMembershipChangeEvent instanceof MembershipSendingAudioEvent) {\n\n                        } else if (callMembershipChangeEvent instanceof MembershipSendingSharingEvent) {\n\n                        }\n                    }\n                });\n            }\n            else {\n                SparkError error = result.getError();\n            }\n        }\n    });\n    ```\n    \n8. Receive screen share:\n\n    ```java\n    spark.phone().dial(roomId, MediaOption.audioVideoSharing(new Pair\u003c\u003e(localView,remoteView),shareView), new CompletionHandler\u003cCall\u003e() {\n        @Override\n        public void onComplete(Result\u003cCall\u003e result) {\n            Call call = result.getData();\n            if (call != null) {\n                call.setObserver(new CallObserver() {\n                    @Override\n                    public void onConnected(Call call) {\n\n                    }\n\n                 \t//...\n\n                    @Override\n                    public void onMediaChanged(MediaChangedEvent mediaChangedEvent) {\n                        if (mediaChangedEvent instanceof RemoteSendingSharingEvent) {\n                            if (((RemoteSendingSharingEvent) mediaChangedEvent).isSending()) {\n                                mediaChangedEvent.getCall().setSharingRenderView(shareView);\n                            } else if (!((RemoteSendingSharingEvent) mediaChangedEvent).isSending()) {\n                                mediaChangedEvent.getCall().setSharingRenderView(null);\n                            }\n                        }\n                    }\n                });\n            }\n            else {\n                SparkError error = result.getError();\n            }\n        }\n    });\n    \n    ```\n\n9. Start/stop sharing screen:\n\n    ```java\n    activeCall.startSharing(r -\u003e Ln.d(\"startSharing result: \" + r));\n    boolean isSharing = activeCall.isSendingSharing();\n    activeCall.stopSharing(r -\u003e Ln.d(\"stopSharing result: \" + r));\n    ```\n\n10. Post a message\n\n    ```java\n    spark.message().post(\n        idOrEmail,  // person id, email or room id\n        message,    // text message to be sent\n        mentions,   // list of Mention object\n        files,      // list of files to be sent\n        new CompletionHandler\u003cMessage\u003e() {\n            @Override\n            public void onComplete(Result\u003cMessage\u003e result) {\n                if (result.isSuccessful()) {\n                    // message sent success\n                } else {\n                    // message sent failed\n                }\n            }\n        }));\n    ```\n\n11. Receive a message\n\n    ```java\n    spark.message().setMessageObserver(\n        new MessageObserver() {\n            void onEvent(MessageEvent event) {\n                if (event instanceof MessageArrived) {\n                    Message message = event.getMessage();\n                    // new message arrived\n                } else if (event instanceof MessageDeleted) {\n                    // message deleted\n                }\n            }\n        }\n    );\n    ```\n\n## Contribute\n\nPull requests welcome. To suggest changes to the SDK, please fork this repository and submit a pull request with your changes. Your request will be reviewed by one of the project maintainers.\n\n## License\n\n\u0026copy; 2016-2018 Cisco Systems, Inc. and/or its affiliates. All Rights Reserved.\n\nSee [LICENSE](https://github.com/ciscospark/spark-android-sdk/blob/master/LICENSE) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebex%2Fspark-android-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebex%2Fspark-android-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebex%2Fspark-android-sdk/lists"}