Giter Club home page Giter Club logo

swiftymessenger's Introduction

SwiftyMessenger CI CocoaPods Compatible Carthage Compatible Platform License

    _________ ___          ___  _   _____  _________ ___    ___
   /        / \  \        /  / |_| ( ___ \ \__   __/ \  \  /  /
  /   _____/   \  \  /\  /  /  | | | (  \/    ) (     \  \/  /
  \_____  \     \  \/  \/  /   | | | (_       | |      \    /
  /        \     \  ____  /    | | |  _)      | |       )  (
 /_______ /       \/    \/     |_| | (        | |       |  |
        \/                         | )        )_(       |__|
                                   |/
      _____        ______    ________  ________  ______   __      __     _____      ______  _________
     /     \      (  ____\  /       / /       / (  ____\ |  \    |  |   /     \    (  ____\ \______  \
    /       \     | (      /   ____/ /   ____/  | (      |  |\   |  |  /   ____\   | (       |        \
   /  /\ /\  \    | (__    \_____ \  \_____ \   | (__    |  | \  |  | /   /__/  |  | (__     |    |____\
  /  /  Y  \  \   |  __)   /       \ /       \  |  __)   |  |  \ |  | \______   /  |  __)    |     \\
 /  /       \  \  | (     /_______/ /_______/   | (      |  |   \|  |  _____/  /   | (       |    | \\
 |_/         |__| | (___/\      \/        \/    | (___/\ |__|    |__| |_______/    | (___/\  |____| |_|
                  (______/                      (______/                           (______/

SwiftyMessenger

Swift toolkit for passing messages between iOS apps and extensions. It creates a bridge between container app and iOS extensions. SwiftyMessenger archives messages in files which are written to the application's shared App Group. SwiftyMessenger resembles interprocess communication between the app and the extension without a interprocess communication.

It also supports CFNotificationCenter Darwin Notifications in an effort to support realtime change notifications. When a message passed, interested parties can listen and can be notified (almost instant) of these changes on both side.

Sample App

Requirements

SwiftyMessenger Version Minimum iOS Target Minimum watchOS Target Swift Version
0.4.0 iOS 10 watchOS 3.0 Swift 5.x
0.2 iOS 9 watchOS 2.0 Swift 4.2
0.1 iOS 9 watchOS 2.0 Swift 4.1

NOTE

SwiftyMessenger can only work with App Group identifiers and Entitlements.

CocoaPods

CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:

$ gem install cocoapods

To integrate SwiftyMessenger into your Xcode project using CocoaPods, specify it in your Podfile:

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '10.0'
use_frameworks!

target '<Your Target Name>' do
	pod 'SwiftyMessenger', '~>0.4.0'
end

Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.

You can install Carthage with Homebrew using the following command:

brew update
brew install carthage

To integrate SwiftyMessenger into your Xcode project using Carthage, specify it in your Cartfile:

github "abdullahselek/SwiftyMessenger" ~> 0.4.0

Swift Package Manager

Modify your Package.swift file to include the following dependency:

.package(url: "https://github.com/abdullahselek/SwiftyMessenger.git", from: "0.4.0")

XCFramework

XCFrameworks require Xcode 11 or later and integration is very similar to integration of .framework format. Please use script scripts/build-framework.sh to generate binary SwiftyMessenger.xcframework archive that you can use as a dependency in Xcode.

SwiftyMessenger.xcframework is a Release (Optimized) binary that offer best available Swift code performance.

Usage

Initialization

messenger = Messenger(withApplicationGroupIdentifier: "group.com.abdullahselek.swiftymessenger", directory: "messenger")

Passing message

messenger.passMessage(message: ["selectedCell": title], identifier: "selection")

Reading message

if let message = messenger.messageForIdentifier(identifier: "button") as? [String: Any] {
	let buttonTitle = message["buttonTitle"] as? String
}

Listen message changes with identifier

messenger.listenForMessage(withIdentifier: "button") { message in
    guard let message = message as? [String: Any] else {
        return
    }
    let buttonTitle = message["buttonTitle"] as? String
}

Support for WatchConnectivity

SwiftyMessenger suports WatchConnectivity provided by Apple on watchOS extensions.

Here are two little notes you need to know if you want to use WatchConnectivity support in your app:

  • MessengerSession is a singleton subclass that supports listening for WatchConnectivity messages. It can be used to listen Messenger messages you expect to receive from the WatchConnectivity framework. Be sure to activate the session once your listeners are set so that you can begin receiving message notifications.

  • You can use MessengerSessionContextTransiting when creating your messenger, but it can easily overload the pipeline by sending too many messages at once.

Transiting Types

You can find 5 available types under TransitingType.

  • file (Message transiting by archiving and unarchiving messages that are written and read to files)
  • coordinatedFile (Uses FileCoordinator)
  • sessionContext (Support for the WatchConnectivity framework's Application Context)
  • sessionMessage (Support for the WatchConnectivity framework's real time message passing ability)
  • sessionFile (Support for the WatchConnectivity framework's file transfer ability)

License

SwiftyMessenger is released under the MIT license. See LICENSE for details.

Credits

Inspired by MutualMobile. Improved and all coded in new programming language Swift.

swiftymessenger's People

Contributors

abdullahselek avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

swiftymessenger's Issues

Support for share extensions?

Great work with the project you've created! I was wondering whether SwiftyMessenger could be used to send messages from a share extension to the main app. In my usecase, I want to save an entry using CoreData from a shared extension and have an already opened app receive a notification to refresh the persistence container's data. What's tricky is that the app extension and main app are two separate processes that have access to the same persistence container data.

Could SwiftyMessenger be used for this? Or was SwiftyMessenger used more for handling WatchOS extensions? Thanks!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.