{"id":19188802,"url":"https://github.com/miquido/revolt-sdk-android","last_synced_at":"2026-06-11T23:31:05.914Z","repository":{"id":94293812,"uuid":"362473927","full_name":"miquido/revolt-sdk-android","owner":"miquido","description":"The project was made by Miquido. https://www.miquido.com/","archived":false,"fork":false,"pushed_at":"2021-04-28T13:26:52.000Z","size":268,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"develop","last_synced_at":"2025-02-23T03:42:24.650Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/miquido.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-04-28T13:17:28.000Z","updated_at":"2021-09-30T09:50:37.000Z","dependencies_parsed_at":"2023-04-09T14:31:53.835Z","dependency_job_id":null,"html_url":"https://github.com/miquido/revolt-sdk-android","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/miquido/revolt-sdk-android","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/miquido%2Frevolt-sdk-android","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/miquido%2Frevolt-sdk-android/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/miquido%2Frevolt-sdk-android/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/miquido%2Frevolt-sdk-android/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/miquido","download_url":"https://codeload.github.com/miquido/revolt-sdk-android/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/miquido%2Frevolt-sdk-android/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34222709,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-11T02:00:06.485Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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-11-09T11:26:04.801Z","updated_at":"2026-06-11T23:31:05.899Z","avatar_url":"https://github.com/miquido.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"#Revolt Android SDK\nUsage of the Revolt SDK library, to provide event tracking.\n\n#Getting started\n##Dependency\nIn build.gradle of your Android application module (usually $projectRoot/app/build.gradle) add the following in the dependencies section:\n```\ndependencies   {\n    implementation 'rocks.revolt:revolt-sdk-android:1.0.4'\n}\n```\n\n##Initialization\nRevolt SDK can be created using builder from Revolt class. It is necessary to provide context, trackingID and secretKey and then build to have instance of Revolt SDK. This initialization must be placed in the onCreate method inside Application class instance:\n\n```\nRevolt.builder()\n       .with(context)\n       .trackingId(\"trackingId\")\n       .secretKey(\"secretKey\")\n       .build()\n```\n        \n##Permissions\nRevolt Android SDK needs the following permissions to communicate with the server and to detect network connectivity (they are added in library manifest):\n\n```\n \u003cuses-permission android:name=\"android.permission.ACCESS_NETWORK_STATE\"/\u003e\n \u003cuses-permission android:name=\"android.permission.INTERNET\" /\u003e\n```\n\nNote that you don't have to add these permissions to manifest of your application.\n\n#Send events\n\n##Sending events\n\nEvents can be send with sendEvent method which is asynchronous. Method is expecting Event interface which contains getJson method returning JsonObject and getType method returning type of the event.\nRevoltEvent class is described below and provides most common usage samples. \nExample:\n\n```\nrevoltSDK.sendEvent(RevoltEvent(\"Type\", \"a\", \"b\"))\n```\n\n##Creating events\nRevoltEvent class provides 4 constructors that allows you to create events.\n\n###Using JsonObject\nExample:\n```\nval jsonObject = JsonObject();\njsonObject.addProperty(“key”, “value”);\nval revoltEvent = RevoltEvent(“type”, jsonObject)\n```\n###Using key - value\nExample:\n```\nval revoltEvent = RevoltEvent(\"type\", \"a\", \"b\")\n```\n###Using map\nExample:\n```\nval properties: MutableMap\u003cString, Any\u003e = HashMap()\nproperties.put(“aaa”, “bbb”);\nval revoltEvent = RevoltEvent(\"type\", properties)\n```\n###Using pairs array\nExample:\n```\nval revoltEvent = RevoltEvent(\"type\", \"aaa\" to “bbb”, “ccc” to “ddd”)\n```\n\n#Lifecycle events\n\nRevolt allows to handle lifecycle events connected with activity changes such as: create, resume, pause, stop and onSaveInstanceState. To enable it, use RevoltLifecycleEventsManager, which is expecting Revolt class implementation and context.\n\nExample:\n```\nRevolt.builder()\n       .with(context)\n       .trackingId(\"trackingId\")\n       .secretKey(\"secretKey\")\n       .build()\n       \nregisterActivityLifecycleCallbacks(RevoltActivityLifecycleCallbacks(rev))       \n```\n\n#Logging\n\nYou can specify which level of logs from SDK do you prefer to print in Logcat. You can do it during initialization. The default log level is WARN. You can turn off logs by setting SILENT log level.\n\n#Login and Logout events\n\nThere are two methods which allow creating events connected with user login and logout events. Those events can be created using buildUserSignedInEvent and buildUserSignedOutEvent methods.\n\n\nExample:\n```\nval signedInEvent = buildUserSignedInEvent(\"12345\")\n\nval signedOutEvent = buildUserSignedOutEvent(\"12345\")\n\n\n\nrevoltSDK.sendEvent(signedInEvent)\n\nrevoltSDK.sendEvent(signedOutEvent)\n```\n\n#Custom Parameters\n\nThere are few parameters which can be set up during initialization:\n\n* maxBatchSize - the max size of events batch in one request\n* eventDelayMillis - delay in sending event\n* offlineMaxSize - the max size of events stored in the database during offline mode\n* endpoint - address of API endpoint\n* revoltLogLevel - log level\n* firstRetryTimeSeconds - first time interval in seconds to retry sending the event when any error occurs\n* maxRetryTimeSeconds- last time interval in seconds to retry sending the event when any error occurs\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmiquido%2Frevolt-sdk-android","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmiquido%2Frevolt-sdk-android","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmiquido%2Frevolt-sdk-android/lists"}