Appz

📱 Launch external apps, and deeplink, with ease using Swift!

Showing:

Popularity

Downloads/wk

0

GitHub Stars

1.1K

Maintenance

Last Commit

11d ago

Contributors

19

Package

Dependencies

0

License

MIT

Categories

Readme

Appz :iphone:

Deeplinking to external applications made easy

Version Version Swift Platforms Carthage Supported Apps

Highlights

  • Web Fallback Support:
    In case the app can't open the external application, it will fall-back to a web URL that is guaranteed to succeed by opening the browser.

  • Isolated App Specs:
    It was crucial to make sure the library can scale as the number of supported apps increase. Therefor, each supported app is implemented in isolation in a separate file.

  • Full Autocomplete Support: The API has been carefully designed to make the most out of auto complete features, so you don't even have to peak into any docs or code!

  • Full Testing:
    To make the specs as transparent as possible, the library has tests to make sure every external application action has tests with the expected results.

Features

You can try them in the playground shipped with the framework!

Concise syntax to trigger deep linking:


let app = UIApplication.shared
app.canOpen(Applications.Instagram())
app.open(Applications.AppStore(), action: .account(id: "395107918"))
app.open(Applications.AppSettings(), action: .open)

Transparent web fallback:

// In case the user doesn't have twitter installed, it will fallback to
// https://twitter.com/testUser/statuses/2
app.open(Applications.Twitter(), action: .status(id: "2",  screenName: "testUser"))

Add your applications:

// Applications are recommended to be part of the
// "Applications" namespace
extension Applications {
    // Define your application as a type that
    // conforms to "ExternalApplication"
    struct MyApp: ExternalApplication {

        typealias ActionType = Applications.MyApp.Action

        let scheme = "myapp:"
        let fallbackURL = ""
        let appStoreId = ""
    }
}
// Then, you define the actions your app supports
extension Applications.MyApp {

    enum Action: ExternalApplicationAction {

        case open

        // Each action should provide an app path and web path to be
        // added to the associated URL
        var paths: ActionPaths {

            switch self {
            case .open:
                return ActionPaths()
            }
        }
    }
}

app.open(Applications.MyApp(), action: .open)

Supported Apps (for now!):

AppActions
AirLaunchOpen
AliExpressOpen
AllCastOpen
AppleMapsOpen
AppSettingsOpen
AppStoreDeveloper, App, Rate App
AppleWatchOpen
AudibleOpen
AyahOpen
BehanceOpen, UserProfile
BNROpen
BoxOpen
BuzzfeedOpen
Calendars5Open
Camera360Open
CareemOpen
ChromecastOpen
CirclePayOpen, Request, Send
ClipsOpen
CnetOpen
CNNOpen
CurrencyOpen
DailyMotionOpen
DamaKingOpen
DayCostOpen
DayOneOpen
DiigoOpen
DocumentsOpen
DropboxOpen
DuolingoOpen
eBayOpen
EchofonOpen
EpsonOpen
EverypostOpen
EyeEmOpen
FacebookOpen, Profile, Notification, Feed, Page, Action
FaceTimeVideo Call
FaceTime audioAudio Call
FeedlyOpen
FileAppOpen
FindFriendsOpen
FindiPhoneOpen
FitbitOpen
FlickrOpen
FlipboardOpen
FlippsTVOpen
ForestOpen
FoursquareOpen
FriendlySocialOpen
GalleryOpen
GlympseOpen
GoogleCalendarOpen, CreateEvent
GoogleChromeOpen
GoogleDocsOpen
GoogleDriveOpen
GoogleEarthOpen
GoogleMailOpen
GoogleMapsOpen, Display Directions, Display Location, Search
GooglePhotosOpen
GooglePlusOpen
GoogleSheetsOpen
GoogleSlidesOpen
GoogleTranslateOpen
GroupeMeOpen
HeapoOpen
HootSuiteOpen
iBooksOpen
IMDbOpen, Search, Title, Boxoffice, Showtimes, Feature Coming Soon, Feature Best Picture, Feature Born Today, Top rated movies, Most popular movies.
iMovieOpen
INRIXTrafficOpen
InstagramOpen, Camera, Library, Media, Username, Location, Tag
InstapaperOpen
iShowsOpen
iTranslateOpen, Translate
iTunesUOpen
KakaoTalkOpen
KayakOpen
KeeperOpen
KikOpen
LastPassOpen
LineOpen
LinkedinOpen
MailCompose
MarktplaatsOpen
MarvisOpen
MeerkatOpen
MessagesSMS
MobileMouseOpen
MopicoOpen
MovesOpen
MusicOpen
MyFitnessPalOpen
NameSharkOpen
NetflixOpen
NotesOpen
NPORadioOpen
NU.nlOpen
NYTimesOpen
OneMorethingOpen
OneDriveOpen
OnePasswordOpen
OutlookOpen, Compose
PaypalOpen
PeriscopeOpen
PhoneOpen
PhotosOpen
PicCollageOpen
PinterestOpen, UserProfile, Search
PocketOpen
PodcastsOpen
QuoraOpen
RadiumOpen
RemindersAppOpen
RemoteOpen
RijnmondOpen
RoboFormOpen
RunKeeperOpen
ScannerProOpen
SimplenoteOpen
SkitchOpen
SkypeOpen
SlackOpen, Channel, Direct Message, Open File, Search
SnapchatOpen, Add
SnapseedOpen
Songpop2Open
SonosOpen
SoundflakeOpen
SparkCompose
StitcherRadioOpen
StravaOpen
SubwayKoreaOpen
SunriseCalendarOpen
SwarmOpen
Super-Stickman-Golf-2Open
TalabatOpen
TangoOpen
TedOpen
TelegramOpen, SMS, openFromID
TestFlightOpen
TinderOpen
TrelloOpen
TubexOpen
TumblrOpen, Dashboard, Explore, Activity, Blog, Tag
TweetbotTimeline, Post, Mentions, Lists, Retweets, Favorites, Messages, Status, Search, Profile, Follow, Unfollow, Favorite, Unfavorite, Retweet, List
TwitterStatus, UserHandle, UserId, List, Post, Search, Timeline, Mentions, Messages
TwitterrificOpen, MentionsView, MessagesView, FavoritesView, Search, TweetID, MessageID, Post, UserProfile
UberOpen
UnreadOpen
UstreamOpen
ViberOpen Calls Tab, Open Chats Tab
VideosOpen
ViewsOpen
VimeoOpen
VineOpen, Popular Timelines
VIPAccessOpen
VoxOpen
VoxerOpen
VSCOOpen
WalletOpen
WazeOpen, NavigateToDirection
WeChatOpen
WeiboOpen
WhatsAppOpen
WhydOpen
WikipanionOpen
WordPressOpen
WorkflowOpen
YammerOpen
YelpOpen, Search, Search Location, Search Category, Search Category Location, Business
YoutubeOpen, Open Video
FRILOpen

Getting Started

Configure Info.plist

You must add the schemes you want to use to your app's info.plist file under LSApplicationQueriesSchemes. See here for more.

Carthage

Carthage is fully supported. Simply add the following line to your Cartfile:

github "SwiftKitz/Appz"

Cocoapods

Cocoapods is fully supported. Simply add the following line to your Podfile:

pod 'Appz'

Submodule

For manual installation, you can grab the source directly or through git submodules, then simply:

  • Drop the Appz.xcodeproj file as a subproject (make sure Copy resources is not enabled)
  • Navigate to your root project settings. Under "Embedded Binaries", click the "+" button and select the Appz.framework

Motivation

I've gone through way too much pain than I am willing to admit integrating deeplinking in my app. It is very easy to forget calling canOpenURL or missing a colon somewhere. Another pain point was savaging the web for all the different specs for different applications.

With this library, you can keep the external application deep linking spec separately and rest assured as it is open source and maintained by the wonderful github community!

Author

Mazyod (@Mazyod)

Contributors

This library could not have made it so far without the generous contributions of various developers!

License

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

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100