{"id":13340141,"url":"https://github.com/AgoraIO/AgoraRtm_Apple","last_synced_at":"2025-03-11T16:32:27.904Z","repository":{"id":204647249,"uuid":"712326788","full_name":"AgoraIO/AgoraRtm_Apple","owner":"AgoraIO","description":"[Beta] Agora's Signaling 2.0 SDK Swift Package for iOS, macOS and visionOS 📦","archived":false,"fork":false,"pushed_at":"2025-02-28T04:06:51.000Z","size":15747,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":26,"default_branch":"main","last_synced_at":"2025-03-08T10:43:52.134Z","etag":null,"topics":["agora","agora-rtm","chat","ios","macos","messaging","networking","realtime-messaging","synchronization","vision-pro","visionos"],"latest_commit_sha":null,"homepage":"https://agoraio.github.io/AgoraRtm_Apple/","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AgoraIO.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2023-10-31T08:49:12.000Z","updated_at":"2024-07-23T02:22:25.000Z","dependencies_parsed_at":null,"dependency_job_id":"771cae93-1973-40e8-a4ef-f570e8c26a6a","html_url":"https://github.com/AgoraIO/AgoraRtm_Apple","commit_stats":null,"previous_names":["agoraio/agorartm_apple"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO%2FAgoraRtm_Apple","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO%2FAgoraRtm_Apple/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO%2FAgoraRtm_Apple/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO%2FAgoraRtm_Apple/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AgoraIO","download_url":"https://codeload.github.com/AgoraIO/AgoraRtm_Apple/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243070484,"owners_count":20231464,"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":["agora","agora-rtm","chat","ios","macos","messaging","networking","realtime-messaging","synchronization","vision-pro","visionos"],"created_at":"2024-07-29T19:22:08.108Z","updated_at":"2025-03-11T16:32:22.875Z","avatar_url":"https://github.com/AgoraIO.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003e [!WARNING]\n\u003e This is a beta product\n\n\n# AgoraRtm\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FAgoraIO%2FAgoraRtm_Apple%2Fbadge%3Ftype%3Dswift-versions\" /\u003e\n    \u003cimg src=\"https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FAgoraIO%2FAgoraRtm_Apple%2Fbadge%3Ftype%3Dplatforms\" /\u003e\n\u003c/p\u003e\n\nAgoraRtm is a Swift package that provides an easy-to-use interface for integrating Agora Real-Time Messaging (RTM) into your iOS applications. It offers a set of classes and methods that enable you to establish real-time messaging and communication channels.\n\n## Features\n\n- **User Authentication:** Authenticate users using tokens for secure communication.\n- **Message Communication:** Send and receive real-time messages between users.\n- **Presence Management:** Query and update the presence status of users.\n- **Lock Management:** Manage locks for synchronization between users.\n- **Storage Management:** Store and retrieve user-specific data in real time.\n- **Topic Management:** Create and manage channels for different topics.\n\n## Requirements\n\n- iOS 13.0+ or macOS 10.15\n- Xcode 14.0+\n- Swift 5.8+\n\n## Installation\n\nTo integrate AgoraRtm into your Xcode project, you can use Swift Package Manager. Here's how:\n\n1. In Xcode, open your project.\n2. Select File \u003e Swift Packages \u003e Add Package Dependency.\n3. Enter the package repository URL: `https://github.com/AgoraIO/AgoraRtm_Apple.git`.\n4. Choose a version rule or enter a specific branch, tag, or commit hash.\n5. Click Next, then Add `AgoraRtmKit-Swift` library.\n\n## Getting Started\n\n### Initialization\n\nTo get started with AgoraRtm, you need to initialize an `RtmClientConfig` instance and create an `RtmClientKit` instance with it. Here's an example:\n\n```swift\nimport AgoraRtm\n\n// Create an `RtmClientConfig` instance\nlet rtmConfig = RtmClientConfig(\n    appId: \"example-appId\",\n    userId: \"example-username\"\n)\n\nlet rtmClient = RtmClientKit(config: rtmConfig, delegate: self)\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAgoraIO%2FAgoraRtm_Apple","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FAgoraIO%2FAgoraRtm_Apple","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAgoraIO%2FAgoraRtm_Apple/lists"}